/kicanvas

The KiCAD web viewer

Primary LanguageTypeScriptOtherNOASSERTION

KiCanvas

KiCanvas is an interactive, browser-based viewer for KiCAD schematics and boards. You can try it out for yourself at https://kicanvas.org.

kicanvas.demo.-.medium.mp4

NOTE: KiCanvas is currently in early alpha. There will be bugs and missing features. Please take a look at known issues and file an issue if you run into trouble.

You can also use KiCanvas on your own websites using the embedding API. It's written in modern vanilla TypeScript and uses the Canvas element and WebGL for rendering. You can learn more on the development page.

KiCanvas is developed by Thea Flowers with financial support from her sponsors.

Status and roadmap

KiCanvas is very early in its development and there's a ton of stuff that hasn't been done, there's a roadmap that you can use to get an idea of the overall status of the project.

Known issues

In general, please check the GitHub issues page before filing new issues. Some high-level things that we known won't work:

  • Any KiCAD 5 files, KiCanvas can only parse files from KiCAD 6 and later.
  • Some KiCAD 7 features might not be fully implemented, such as custom fonts in schematics.
  • Browsers other than desktop Chrome, Firefox, and Safari may run into issues, as we aren't currently running automated tests against other browsers. We welcome issues related to browser compatibility, just make sure it hasn't already been reported.

FAQ

Take a look at our FAQ page for commonly asked questions and answers.

License and contributing

KiCanvas is open source! Please take a chance to read the LICENSE file.

Contributions are welcome! However, since KiCanvas is in a super early stage please file an issue before you start working on something so we can coordinate. It's also recommended to take a moment and read over the development documentation.

Special thanks

KiCanvas would not be possible without the incredible financial support of our sponsors. KiCanvas received significant support from the following individual and organizations:

& donations and support from the following individuals: