canvas-ui

A Typescript UI library which uses HTML canvases.

Documentation is available on Github pages.

Unity integration can be found in the canvas-ui-unity repository (private).

three.js integration can be found in the canvas-ui-three repository.

Wonderland Engine integration can be found in the canvas-ui-wl repository.

Contributing

To check for linter errors, run npm run lint

To build this project, run npm run build

To build this project in watch mode and with unminified output run npm run dev

To re-generate the documentation, run npm run docs

To add/modify theme properties, modify the theme_properties.json file and run npm run generate_theme

Example

Examples can be found in the examples folder

Special thanks

Special thanks to Playko (website, github) where this project started and is currently being developed at.

License

This project is licensed under the MIT license (see the LICENSE file)

This project uses the following open-source projects:

• @knodes/typedoc-plugin-pages licensed under the MIT license
• @typescript-eslint/eslint-plugin licensed under the MIT license
• @typescript-eslint/parser licensed under the BSD 2-Clause license
• esbuild licensed under the MIT license
• eslint licensed under the MIT license
• eslint-plugin-tree-shaking licensed under the MIT license
• eslint-plugin-tsdoc licensed under the MIT license
• local-web-server licensed under the MIT license
• rimraf licensed under the ISC license
• typedoc licensed under the Apache 2.0 license
• typescript licensed under the Apache 2.0 license