library-mirrors/dat.gui
1
0
Fork 0
mirror of https://github.com/dataarts/dat.gui.git synced 2024-12-12 04:08:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Lightweight controller library for JavaScript.
390 Commits 13 Branches 25 Tags 17 MiB
JavaScript 86.7%
HTML 9.6%
SCSS 2.5%
CSS 1.2%
97adbace4d
Go to file
anvaka 97adbace4d Migrateed to commonjs format 
This build makes dat.gui commonjs friendly and allows it to be consumed
as a regular commonjs package.

All tests are passing, API is backward compatible.
2015-04-16 23:15:24 -07:00
build Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
src Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
tests Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
.gitignore Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
bower.json Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
example.html Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
LICENSE Add Apache 2.0 License 2014-12-01 11:01:01 -08:00
package.json Migrateed to commonjs format 2015-04-16 23:15:24 -07:00
README.md Migrateed to commonjs format 2015-04-16 23:15:24 -07:00

README.md

UI Controller (dat.gui ported to commonjs)

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:

<script type="text/javascript" src="dat.gui.min.js"></script>

As commonjs module

Install the module:

npm install dat.gui

Use it:

var dat = require('dat.gui');
var obj = { x: 5 };
var gui = new dat.GUI();

gui.add(obj, 'x').onChange(function() {
  // obj.x will now have updated value
});

Directory Contents

  • build: Concatenated source code for browsers.
  • src: source code in commonjs format.
  • tests: QUnit test suite.

Building your own dat.GUI

In the terminal, enter the following:

npm start

This will create a browserified build of dat.GUI at build/dat.gui.js and its minified version at build/dat.gui.min.js.

Change log

Pending version number

  • Moved to commonjs, made it browserify friendly.
  • Back to GitHub.

0.5

  • Moved to requirejs for dependency management.
  • Changed global namespace from DAT to dat (lowercase).
  • Added support for color controllers. See Color Controllers.
  • Added support for folders. See Folders.
  • Added support for saving named presets. See 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 Custom Placement.
  • gui.autoListen and gui.listenAll() removed. See Updating The Display Manually.
  • dat.GUI.load removed. See 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: