mirror of
https://github.com/dataarts/dat.gui.git
synced 2024-10-10 06:54:18 +00:00
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
# dat.GUI
|
|
A lightweight graphical user interface for changing variables in JavaScript.
|
|
|
|
Get started with dat.GUI by reading the [API documentation](API.md).
|
|
|
|
|
|
|
|
## 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:
|
|
```html
|
|
<script type="text/javascript" src="dat.gui.min.js"></script>
|
|
```
|
|
|
|
## Installing from npm
|
|
|
|
```bash
|
|
$ npm install --save dat.gui
|
|
```
|
|
|
|
```js
|
|
// CommonJS:
|
|
const dat = require('dat.gui');
|
|
|
|
// ES6:
|
|
import * as dat from 'dat.gui';
|
|
|
|
const gui = new dat.GUI();
|
|
```
|
|
|
|
## Directory Contents
|
|
|
|
```
|
|
├── build - Compiled source code.
|
|
├── src - Source files.
|
|
└── tests - Tests.
|
|
```
|
|
|
|
## Building your own dat.GUI
|
|
|
|
In the terminal, enter the following:
|
|
|
|
```
|
|
$ npm install
|
|
$ npm run build
|
|
```
|
|
|
|
## npm scripts
|
|
|
|
- npm run build - Build development and production version of scripts.
|
|
- npm run dev - Build development version of script and watch for changes.
|
|
|
|
|
|
## Working with Content Security Policy
|
|
If you're using a server with a Content Security Policy in place that blocks 'unsafe-inline', you will have problems when dat.gui.js tries to inject style information. To get around this, load 'build/dat.gui.css' as an external style sheet.
|
|
|
|
## Changes
|
|
View the [Change Log](https://github.com/dataarts/dat.gui)
|
|
|
|
## Thanks
|
|
The following libraries / open-source projects were used in the development of dat.GUI:
|
|
* [Rollup](https://rollupjs.org)
|
|
* [Sass](http://sass-lang.com/)
|
|
* [Node.js](http://nodejs.org/)
|
|
* [QUnit](https://github.com/jquery/qunit) / [jquery](http://jquery.com/)
|