Skip to content
Circuit Diagram extension for Visual Studio Code.
TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
assets
readme-assets
src
.gitignore
.travis.yml
.vscodeignore
CHANGELOG.md
LICENSE.txt
README.md
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

Circuit Diagram VS Code Extension

Build Status

A Visual Studio Code extension for creating components for Circuit Diagram.

View instructions for how to create new components using this extension here.

Features

Provides a render preview button when editing Circuit Diagram component XML files.

Render Preview Button

Compilation errors will be displayed in the Problems window and highlighted in the component file.

Problems

The Component Outline view shows the properties and configurations for the component. Click on a configuration to render that configuration.

Component Outline

Click on a property to change the value that is used when rendering a preview.

Set Property

If your component compiles successfully, a render.png file will be produced in the same directory as your component file and opened in a pane to the right.

render.png

Installation

This project is in development and is not yet available in the VS marketplace. Visit circuit-diagram.org or the releases page to download the latest version. You can manually install the VSIX file in VS Code.

This extension requires the Circuit Diagram command-line application to render components. You must download the appropriate version for your system and configure the path to the downloaded executable in your VS Code settings.

If the command-line download is an archive file (e.g. zip), you will need to extract it first. See command line setup for more information.

For example:

{
    "circuitDiagram.executablePath": "C:/Path/To/circuit-diagram-cli.exe"
}

Extension Settings

This extension contributes the following settings:

  • circuitDiagram.executablePath: path to the Circuit Diagram Command-line executable (required)

  • circuitDiagram.debugLayout: render component layout information (shown in blue, default false)

  • circuitDiagram.executableCommandPrefix: override render command (advanced use only)

You can’t perform that action at this time.