├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
├── bower.json
├── demo.html
├── elements
└── paper-gui.html
├── gulpfile.js
├── package.json
├── src
├── AbstractPaperGUIController.js
├── ButtonPaperGUIController.js
├── InputPaperGUIController.js
├── PaperGUI.js
├── SelectPaperGUIController.js
├── SliderPaperGUIController.js
├── TextPaperGUIController.js
├── TogglePaperGUIController.js
└── loader.js
└── test
├── ButtonPaperGUIController.html
├── InputPaperGUIController.html
├── SelectPaperGUIController.html
├── SliderPaperGUIController.html
├── TogglePaperGUIController.html
├── index.html
├── loader.html
└── paper-gui.html
/.gitignore:
--------------------------------------------------------------------------------
1 | # dependencies
2 | bower_components
3 | node_modules
4 |
5 | # production
6 | build
7 | dist
8 | # misc
9 | .DS_Store
10 | .env
11 | npm-debug.log
12 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | Want to contribute? Great! First, read this page (including the small print at the end).
2 |
3 | ### Before you contribute
4 | Before we can use your code, you must sign the
5 | [Google Individual Contributor License Agreement]
6 | (https://cla.developers.google.com/about/google-individual)
7 | (CLA), which you can do online. The CLA is necessary mainly because you own the
8 | copyright to your changes, even after your contribution becomes part of our
9 | codebase, so we need your permission to use and distribute your code. We also
10 | need to be sure of various other things—for instance that you'll tell us if you
11 | know that your code infringes on other people's patents. You don't have to sign
12 | the CLA until after you've submitted your code for review and a member has
13 | approved it, but you must do it before we can put your code into our codebase.
14 | Before you start working on a larger contribution, you should get in touch with
15 | us first through the issue tracker with your idea so that we can help out and
16 | possibly guide you. Coordinating up front makes it much easier to avoid
17 | frustration later on.
18 |
19 | ### Code reviews
20 | All submissions, including submissions by project members, require review. We
21 | use Github pull requests for this purpose.
22 |
23 | ### The small print
24 | Contributions made by corporations are covered by a different agreement than
25 | the one above, the
26 | [Software Grant and Corporate Contributor License Agreement]
27 | (https://cla.developers.google.com/about/google-corporate).
28 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # PaperGUI
2 |
3 |
4 | A clone of [dat.GUI](https://github.com/dataarts/dat.gui) using nice
5 | [Polymer (1.0)](https://www.polymer-project.org/1.0/docs/) paper elements. One of the advantages is that this makes it touch and mobile friendly. The API is intentionally similar, although not all features have been ported to PaperGUI.
6 |
7 |
8 | ## Install
9 |
10 |
11 | Building requires node, gulp and bower.
12 | ```
13 | npm install gulp bower
14 | npm install
15 | npm run-script build
16 | ```
17 | The `dist` folder contains the build. The `paper-gui.html` file is the only one
18 | you need if you want to use web component-style, synchronous import.
19 | Otherwise, you'll need all 3 files in the `dist` folder as `paperGUI.js` loads
20 | the other two.
21 |
22 |
23 | To try out the demo, run a webserver in the papergui root folder, eg:
24 | ```python
25 | python -m SimpleHTTPServer 8000
26 | ```
27 | Then open http://localhost:8000/demo.html in a browser.
28 |
29 |
30 | ## Usage
31 |
32 |
33 | ### Basic usage
34 |
35 |
36 | With very little code, PaperGUI creates an interface that you can use to modify variables, exactly like [dat.GUI](https://workshop.chromeexperiments.com/examples/gui/#1--Basic-Usage) from which the below example is adapted.
37 | ```html
38 |
58 |
59 |
60 |
61 | ```
62 |
63 | - The property must be public, i.e. defined by `this.prop = value`
64 | - PaperGUI determines controller type based on a property's initial value
65 | - Press H to show/hide all GUI's.
66 |
67 | ##### Importing PaperGUI as a web component
68 |
69 | As shown above, the `paperGUI.js` script loads a polyfill and then imports the web components necessary for the PaperGUI library to work. Once it's all set, it triggers a `PaperGUIReady` event. This allows to delay the loading of PaperGUI as much as possible.
70 |
71 | Alternatively, you can skip the loader script call and use a (blocking) import directly. Add this at the top of your HTML:
72 |
73 | ```html
74 |
75 | ```
76 |
77 | Note that in this case no `PaperGUIReady` event will be triggered, and the import will only work on web component-ready browsers as this bypasses support detection and polyfill loading.
78 |
79 | ### Constrain
80 |
81 |
82 | You can specify limits on numbers. A number with a min and max value becomes a slider. This is exactly the [same API as dat.GUI](https://workshop.chromeexperiments.com/examples/gui/#2--Constraining-Input).
83 |
84 |
85 | ```javascript
86 | gui.add(text, 'noiseStrength').step(5); // Increment amount
87 | gui.add(text, 'growthSpeed', -5, 5); // Min and max
88 | gui.add(text, 'maxSize').min(0).step(0.25); // Mix and match
89 | ```
90 | You can also choose to select from a dropdown of values for both numbers and strings.
91 | ```javascript
92 | // Choose from accepted values
93 | gui.add(text, 'message', [ 'pizza', 'chrome', 'hooray' ] );
94 |
95 |
96 | // Choose from named values
97 | gui.add(text, 'speed', { Stopped: 0, Slow: 0.1, Fast: 5 } );
98 | ```
99 |
100 |
101 | ### Events
102 |
103 |
104 | You can listen for events on individual controllers using an event listener syntax.
105 |
106 |
107 | ```javascript
108 | var controller = gui.add(fizzyText, 'maxSize', 0, 10);
109 |
110 |
111 | controller.onChange(function(value) {
112 | // Fires on every change, drag, keypress, etc.
113 | });
114 | ```
115 |
116 |
117 | Note: the `onFinishChange` handler [from dat.GUI](https://workshop.chromeexperiments.com/examples/gui/#7--Events) is currently not supported.
118 |
119 |
120 | ## Styling & positioning
121 |
122 |
123 | PaperGUI exposes custom CSS properties and mixins (see [Polymer documentation](https://www.polymer-project.org/1.0/docs/devguide/styling#custom-css-properties)) through which you can change the colors and style of the UI.
124 |
125 |
126 | ### Custom properties
127 |
128 |
129 | Properties below can be used to modify the default colors of the PaperGUI interface and components:
130 |
131 |
132 | | Custom Property | Description |
133 | | ----------------------------------- |------------------------------------------------------------------------------|
134 | | `--paper-gui-accent-color` | Accent used in the floating action button, toggle buttons, sliders, etc. |
135 | | `--paper-gui-accent-contrast-color` | Applied to fonts and icons where the background uses accent color (buttons) |
136 | | `--paper-gui-background-color` | Background color of the main dialog |
137 | | `--paper-gui-text-color` | Main color for text inputs, labels, dropdown values, etc. |
138 | | `--paper-gui-ui-color` | Used in components (borders, sliders, input placeholders, etc.) |
139 | | `--paper-gui-ui-secondary-color` | Lighter shade of the above color, used in scrollbars and dividers |
140 |
141 |
142 | ##### Example
143 |
144 |
145 | In your main html file, declare the following [custom-style](https://www.polymer-project.org/1.0/docs/devguide/styling#custom-css-properties) to override default colors:
146 |
147 |
148 | ```html
149 |
158 | ```
159 |
160 |
161 | ### Mixins
162 | If you need to further customize the edit button or the dialog, ie change their positioning or size, you can use dedicated custom mixins.
163 |
164 |
165 | | Custom Mixin | Description |
166 | | ----------------------------------- |----------------------------------------------------------------------------------------------------|
167 | | `--paper-gui-edit-button` | Use this to customize the edit button |
168 | | `--paper-gui-dialog` | Use this to override the size and positioning of the dialog (eg to place it in a different corner) |
169 |
170 |
171 | ##### Example
172 | In your main html file:
173 |
174 |
175 | ```html
176 |
193 | ```
194 |
195 |
196 | ## Reference
197 |
198 |
199 | ### PaperGUI constructor parameters
200 |
201 | The PaperGUI constructor can accept an object containing various options (eg. `var gui = new PaperGUI({autoPlace: false});`)
202 |
203 | | Property name | Type | Description |
204 | |---------------|---------|-------------|
205 | | `autoPlace` | Boolean | Whether to automatically append the PaperGUI element to the DOM as soon as at least one controller has been added. Default is **true**. |
206 |
207 |
208 | ### PaperGUI methods
209 |
210 | PaperGUI has several methods.
211 |
212 | | Method name | Description |
213 | |-------------|-------------|
214 | | `add()` | Creates and returns a new UI controller (controller type varies depending on the arguments, see next section). |
215 | | `el()` | Returns the main Element for this PaperGUI (ie a `paper-gui` component). Useful for attaching it to the DOM manually when `autoPlace` is disabled. |
216 | | `open()` | Opens the dialog containing the controllers. Equivalent to clicking the edit button. |
217 | | `close()` | Closes the dialog containing the controllers. Equivalent to clicking the close button in the dialog. |
218 | | `hide()` | Hides all PaperGUI elements (edit button, dialog with controllers). Equivalent to pressing the 'H' key. |
219 | | `show()` | Shows all previously hidden PaperGUI elements. |
220 |
221 |
222 |
223 | ### Controller types
224 |
225 | Here's a summary of the controller types PaperGUI currently supports:
226 |
227 |
228 | | PaperGUI Controller type | Property type | Extra parameters |
229 | |--------------------------|---------------|------------------|
230 | | Button | Function | *N/A* |
231 | | Toggle | Boolean | *N/A* |
232 | | Text input | String | *N/A* |
233 | | Select box | String | **[String value]** An array of accepted values for the property, required to create a select box instead of a text input)|
234 | | Slider | Number | **Number minValue** (optional, default 0), **Number maxValue** (optional, default 100) |
235 | | Select box | Number | **{String label: Number value}** An object whose property names will be used as labels and corresponding values will be set on the property when selected. Required to create a select box instead of a slider.|
236 |
237 |
238 | ### Controller methods
239 |
240 |
241 | All controller methods return themselves, allowing to chain method calls. Here is a list of methods.
242 |
243 |
244 | | Method | Description | Controller types |
245 | |------------------------------|----------------------------------------------------------|-------------------|
246 | | `name(labelString)` | Defines the label or placeholder text for the controller | All |
247 | | `onChange(callbackFunction)` | Calls the function when the value changes | All except Button |
248 | | `min(minNumber)` | Sets the minimum authorized value | Slider |
249 | | `max(minNumber)` | Sets the maximum authorized value | Slider |
250 | | `step(stepNumber)` | Sets the step size | Slider |
251 |
252 |
253 | ## TODO
254 |
255 |
256 | - Add live demos
257 | - Add folders/tabs structure capability and other features from the original dat.GUI
258 |
259 |
260 | ## Known issues
261 |
262 |
263 | - Select box change callback fires on controller creation (intended?)
264 |
--------------------------------------------------------------------------------
/bower.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "paper-gui",
3 | "version": "0.0.2",
4 | "ignore": [
5 | "**/.*",
6 | "node_modules",
7 | "bower_components",
8 | "test",
9 | "tests"
10 | ],
11 | "dependencies": {
12 | "iron-elements": "PolymerElements/iron-elements#^1.0.0",
13 | "neon-animation": "PolymerElements/neon-animation#^1.0.0",
14 | "paper-elements": "PolymerElements/paper-elements#^1.0.0"
15 | },
16 | "devDependencies": {
17 | "web-component-tester": "*"
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/demo.html:
--------------------------------------------------------------------------------
1 |
15 |
16 |
17 |
18 |
19 | paperGUI demo
20 |
21 |
22 |
paperGUI demo
23 |
24 |
25 |
59 |
60 |
61 | // Build a basic demo. All config variables are placed in a JS Object.
62 | var myDemo = {};
63 | myDemo.sayHello = function() {
64 | var message = '';
65 | for (var i = 0; i < myDemo.times; i++) {
66 | message += (myDemo.toggle ? 'hello ' : 'good bye ') + myDemo.message + '<br>';
67 | }
68 | document.getElementById('demo').innerHTML = message;
69 | }
70 | myDemo.toggle = true;
71 | myDemo.message = 'world';
72 | myDemo.times = 1;
73 | myDemo.sayHello();
74 |
75 |
76 | // Now let's create a fancy paper GUI!
77 | document.addEventListener('PaperGUIReady', function(e) {
78 | // Polymer elements are loaded asynchronously, we wait for them to be ready before creating the GUI.
79 | var myGUI = new PaperGUI();
80 | myGUI.add(myDemo, 'toggle').name('Hello').onChange(myDemo.sayHello);
81 | myGUI.add(myDemo, 'message').name('Who are you?');
82 | myGUI.add(myDemo, 'sayHello').name('Update text');
83 | myGUI.add(myDemo, 'times').max(10).min(1).step(0.01).onChange(myDemo.sayHello);
84 | myGUI.add(myDemo, 'nothing', -5, 5).name('Another one that does nothing');
85 | myGUI.add(myDemo, 'message', ['earth', 'world', 'moon', 'system']).name('Yay, menus!')
86 | .onChange(function(val) {
87 | console.log(val);
88 | myDemo.sayHello();
89 | });
90 | myGUI.add(myDemo, 'times', {'Once':1, 'Twice':2, '10X':10})
91 | .name('Yay, menus with labels!').onChange(myDemo.sayHello);
92 | });
93 |
94 |
95 |
96 |
Then, at the end of the HTML file, start loading paperGUI:
97 |
<script src="dist/paperGUI.js"></script>
98 |
This asynchronously loads the webcomponent polyfill then the paperGUI library and elements.
99 |
100 |
Alternatively, you can use a (blocking) webcomponent import instead of this loader.
101 |
<link rel="import" href="dist/paper-gui.html">
102 |
Note that the PaperGUIReady event won't be triggered and the import will only work on webcomponent-ready browsers as this bypasses support detection and polyfill loading.