Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.47 KB

README.md

File metadata and controls

76 lines (56 loc) · 2.47 KB
Raw

dat.GUI

A lightweight graphical user interface for changing variables in JavaScript.

Get started with dat.GUI by reading the tutorial or the API documentation.

This fork of dat.gui was specifically created to be used with the new ISF website. It can be used exactly the same way; however, it just needs to be built with the JS and CSS separately. This can be turned on and off by changing one line in rollup.config.js:

plugins: [
    ...
    sass({
        ...
        insert: false
        ...
    })
    ...
]

This is because, when insert is set to true, the built dat.gui file appends the CSS file to the HTML, which means you can't control the order that it is included. Because the ISF website (or any website) needs to override the default styles, the default styles need to be included before the overrides. This is all set up on the ISF website to insert the files from node_modules, you just need to make sure you're pointing to the right dat.gui that is built in the right way.

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>

Installing from npm

$ npm install --save dat.gui

const dat = require('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

Thanks

The following libraries / open-source projects were used in the development of dat.GUI: