dat-gui

Browserified dat-gui library

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
dat-gui
0.5.011 years ago11 years agoMinified + gzip package size for dat-gui in KB

Readme

=dat.GUI= A lightweight graphical user interface for changing variables in JavaScript.
Get started with dat.GUI by reading the tutorial at http://workshop.chromeexperiments.com/examples/gui.
==Packaged Builds== The easiest way to use dat.GUI in your code is by using the built source at {{{build/dat.gui.min.js}}}. These built JavaScript files bundle all the necessary dependencies to run dat.GUI.
In your {{{head}}} tag, include the following code: {{{ }}}
==Using dat.GUI with require.js== Internally, dat.GUI uses http://requirejs.org/ require.js to handle dependency management. If you're making changes to the source and want to see the effects of your changes without building, use require js.
In your {{{head}}} tag, include the following code: {{{ }}}
Then, in {{{path/to/main.js}}}: {{{ require( 'path/to/gui/module/GUI' , function(GUI) {
// No namespace necessary var gui = new GUI();
}); }}}
==Directory Contents== build: Concatenated source code. src: Modular code in http://requirejs.org/ require.js format. Also includes css, http://sass-lang.com/ scss, and html, some of which is included during build. tests: https://github.com/jquery/qunit QUnit test suite. utils: http://nodejs.org/ node.js utility scripts for compiling source.
==Building your own dat.GUI==
In the terminal, enter the following:
{{{ $ cd utils $ node buildgui.js }}}
This will create a namespaced, unminified build of dat.GUI at {{{build/dat.gui.js}}}
To export minified source using Closure Compiler, open {{{utils/buildgui.js}}} and set the {{{minify}}} parameter to {{{true}}}.
==Change log==
===0.5=== Moved to requirejs for dependency management. Changed global namespace from DAT to dat (lowercase). Added support for color controllers. See http://workshop.chromeexperiments.com/examples/gui/#4--Color-Controllers Color Controllers. Added support for folders. See http://workshop.chromeexperiments.com/examples/gui/#3--Folders Folders. Added support for saving named presets. See http://workshop.chromeexperiments.com/examples/gui/examples/gui/#6--Presets Presets. Removed height parameter from GUI constructor. Scrollbar automatically induced when window is too short. dat.GUI.autoPlace parameter removed. Use new dat.GUI( { autoPlace: false } ). See http://workshop.chromeexperiments.com/examples/gui/#9--Custom-Placement Custom Placement. gui.autoListen and gui.listenAll() removed. See http://workshop.chromeexperiments.com/examples/gui/#11--Updating-the-Display-Manually Updating The Display Manually. dat.GUI.load removed. See http://workshop.chromeexperiments.com/examples/gui/#5--Saving-Values Saving Values. Made Controller code completely agnostic of GUI. Controllers can easily be created independent of a GUI panel.
===0.4===
Migrated from GitHub to Google Code.
==Thanks== The following libraries / open-source projects were used in the development of dat.GUI: http://requirejs.org/ require.js http://sass-lang.com/ Sass http://nodejs.org/ node.js https://github.com/jquery/qunit QUnit / http://jquery.com/ jquery