Tweakpane

Compact GUI for fine-tuning parameters and monitoring value changes

Dashboard
cocopon/tweakpanecocopon.github.io/tweakpane/tweakpane

README

Tweakpane

CI Coverage Status npm version

cover

Tweakpane is a compact pane library for fine-tuning parameters and monitoring
value changes, inspired by [dat.GUI][].
(dat.GUI user? The migration guide can be helpful)

Concept

- Clean and simple design
- Dependency-free
- Extensible

Features

See the [official page][documents] for details.

Input bindings

Number, String, Boolean, Color, Point 2D/3D/4D

Input bindings

Monitor bindings

Number, String, Boolean

Monitor bindings

UI components

Folder, Tab, Button, Separator

UI components

Theming

Theming

Plugins

Plugins

Misc

- Mobile support
- TypeScript type definitions
- JSON import / export

Development

  1. ```
  2. $ npm install
  3. $ npm run setup
  4. $ cd packages/tweakpane
  5. $ npm start
  6. ```

The above commands start a web server for the document, build source files, and
watch for changes. Open http://localhost:8080/ to browse the document.

License

MIT License. See LICENSE.txt for more information.

[dat.GUI]: https://github.com/dataarts/dat.gui
[documents]: https://cocopon.github.io/tweakpane/