https://github.com/circuitdiagram/components
Library of components for Circuit Diagram.
https://github.com/circuitdiagram/components
circuit circuit-diagrams electronics
Last synced: 7 months ago
JSON representation
Library of components for Circuit Diagram.
- Host: GitHub
- URL: https://github.com/circuitdiagram/components
- Owner: circuitdiagram
- License: gpl-2.0
- Created: 2015-10-10T14:45:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T20:29:33.000Z (over 1 year ago)
- Last Synced: 2024-09-07T21:36:20.788Z (over 1 year ago)
- Topics: circuit, circuit-diagrams, electronics
- Language: PowerShell
- Homepage: https://www.circuit-diagram.org/components
- Size: 208 KB
- Stars: 64
- Watchers: 10
- Forks: 117
- Open Issues: 169
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# [Circuit Diagram](http://www.circuit-diagram.org/) Components
[](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=44014445)
This repository contains components created by users of Circuit Diagram.
You can browse the full range of components and see what they look like when used in circuits on the [Circuit Diagram Website](http://www.circuit-diagram.org/components).
## Contributing New Components
Please submit pull requests to this repository with new components you have created.
You can create new components using one of the following:
1. The Circuit Diagram Visual Studio Code
[extension](https://github.com/circuitdiagram/circuitdiagram-vscode)
2. [GitPod](https://gitpod.io/#https://github.com/circuitdiagram/components) - an in-browser
environment for creating components
3. The [Circuit Diagram CLI](https://www.circuit-diagram.org/docs/command-line) with a text editor of your
choice
View the [documentation](https://www.circuit-diagram.org/docs/components/introduction) to get
started making components.
### Folders
If your component is an alternative design for an existing component, place it in
the same top-level folder as the original component. For example, the `us_resistor` component is an alternative design for the `resistor` component. They are both in the `/common` folder of this repository.
If there is no existing component similar to the one you have made, place it in the
folder that seems most appropriate.
### Style & Guidelines
- XML should be indented using two spaces
- The component must have a unique GUID
- The component file name should be the same as the component name with special characters
replaced by an underscore - e.g. `Counter (4 bit)` -> `counter_4_bit.xml`
- The XML file should be placed in a folder of the same name, without the `.xml` extension
- If you include an `author` tag in your component, it should be your GitHub username
### Icons
Optionally, you can include icons for your component. These should use the existing SVG template and consist of a single `` element.
If you include a single icon, it should be named the same as the `xml` file but with an `svg` extension.
If you include an icon for each component configuration, they must be named `{component}--{configuration}.svg`.
## Component Usage
Components in this repository are automatically included on the Circuit Diagram Website. By making a pull request, you agree to your components being available to use on the Circuit Diagram website.