UNPKG

lazy-widgets

Version:

Typescript retained mode GUI for the HTML canvas API

github.com/rafern/lazy-widgets

rafern/lazy-widgets

62 lines (46 loc) • 2.93 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# lazy-widgets Typescript retained mode GUI for the HTML canvas API - a reboot of the [@rafern/canvas-ui](https://www.npmjs.com/package/@rafern/canvas-ui) library. This library's API is not stable and is expected to heavily change in the future. Planned features/changes: - Rewrite layout system to no longer use 2 stages, or to not unnecessarily mark widgets as dirty - Add decoration system - Rich text ## Contributing To build this project, run `pnpm run build`. To build in watch mode and with unminified output run `pnpm run dev`; the `http-server` package must be installed. To check for linter errors, run `pnpm run lint`. To add/modify theme properties, modify the `theme_properties.json` file and run `pnpm run generate_theme`. ## Documentation Documentation can be generated locally with the command `pnpm run docs`. Output will be in a new `docs` folder. The documentation is also served on [Github Pages](https://rafern.github.io/lazy-widgets). ## Example Examples can be found in the `examples` folder, which are also served on [Github Pages](https://rafern.github.io/lazy-widgets/examples). ## Special thanks Special thanks to Playko ([website](https://www.playko.com/), [github](https://github.com/playkostudios)) 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: - [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) licensed under the MIT license - [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) licensed under the BSD 2-Clause license - [chai](http://chaijs.com/) licensed under the MIT license - [concurrently](https://github.com/open-cli-tools/concurrently) licensed under the MIT license - [DefinitelyTyped](http://definitelytyped.github.io/) licensed under the MIT license - [esbuild](https://github.com/evanw/esbuild) licensed under the MIT license - [eslint](https://github.com/eslint/eslint) licensed under the MIT license - [eslint-plugin-tsdoc](https://github.com/microsoft/tsdoc) licensed under the MIT license - [http-server](https://github.com/http-party/http-server) licensed under the MIT license - [jsdom](https://github.com/jsdom/jsdom#readme) licensed under the MIT license - [mocha](https://mochajs.org/) licensed under the MIT license - [node-canvas](https://github.com/Automattic/node-canvas) licensed under the MIT license - [shx](https://github.com/shelljs/shx#readme) licensed under the MIT license - [tslib](https://github.com/Microsoft/tslib) licensed under the BSD Zero Clause license - [ts-node](https://typestrong.org/ts-node) licensed under the MIT license - [typedoc](https://github.com/TypeStrong/TypeDoc) licensed under the Apache 2.0 license - [typescript](https://github.com/Microsoft/TypeScript) licensed under the Apache 2.0 license