Skip to content

cocopon/tweakpane

Repository files navigation

Image for: Repository files navigation

Tweakpane

Tweakpane is a compact pane library for fine-tuning parameters and monitoring value changes, inspired by dat.GUI.

  • Clean and simple design
  • Dependency-free
  • Extensible

(dat.GUI user? The migration guide can be helpful)

Installation

Image for: Installation

Refer to the Getting Started section for concrete steps. Remember to install @tweakpane/core if you are developing with TypeScript.

Features

Image for: Features

See the official page for details.

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

Number, String, Boolean

Folder, Tab, Button, Separator

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

Development

Image for: Development

CommonJS and ES modules

From version 4, Tweakpane has been migrated to ES modules. If you are looking for a CommonJS version of the package, use version 3.x.

Build your own Tweakpane

$ npm install
$ npm run setup
$ cd packages/tweakpane
$ npm start

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.

Other resources

Image for: Other resources

Includes the basics, styles and components for Tweakpane, providing a practical resource for creating your own plugin.

License

Image for: License

MIT License. See LICENSE.txt for more information.

About

Image for: About

🎛️ Compact GUI for fine-tuning parameters and monitoring value changes

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Image for: Sponsor this project
 

Packages

Image for: Packages 0
No packages published

Contributors 5

Image for: Contributors 5