perfect-gui 3.4.5 → 3.5.0

package/README.md

@@ -61,7 +61,7 @@ const gui = new GUI({
     // Defines if the panel can be manually moved across the screen.
     // Default is false.
 
-    autoRepositioning: true
+    autoRepositioning: true,
     // If set to true, the panel position will be reset when the screen is resized.
     // If a panel has been dragged, it won't be be affected.
     // Default is true.
@@ -77,15 +77,13 @@ const gui = new GUI({
 <tr><td>button</td><td>
 
 ```javascript
-gui.button('Click me!', () => {
-    ...
-});
+gui.button('Click me!', callback);
 ```
 </td></tr>
 <tr><td>image</td><td>
 
 ```javascript
-gui.image('Click this', 'path/to/image', () => {
+gui.image('Click this', 'path/to/image', (path) => {
     ...
 });
 ```
@@ -145,6 +143,14 @@ gui.vector2('Position', {
 });
 ```
 </td></tr>
+<tr><td>color</td><td>
+
+```javascript
+gui.color('Color', '#ff0000', color => {
+    console.log('Selected color:', color);
+});
+```
+</td></tr>
 <tr><td>folder</td><td>
 
 ```javascript
@@ -166,6 +172,6 @@ gui.toggleClose();
 
 
 ## To do
-- Color palette component
 - Vector2 drag & drop
-
+- Style list component
+- Image button selection outline

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perfect-gui",
-  "version": "3.4.5",
+  "version": "3.5.0",
   "description": "Nice and simple GUI for JavaScript.",
   "main": "src/index.js",
   "directories": {

package/src/index.js

@@ -18,7 +18,7 @@ export default class GUI {
         }
 
         this.name = (options != undefined && typeof options.name == "string") ? options.name : ''; 
-        this.color = options.color || null; 
+        this.backgroundColor = options.color || null; 
 
         if ( this instanceof GUI ) {
             if ( typeof GUI[GUI.instanceCounter] != 'number' ) {
@@ -73,7 +73,7 @@ export default class GUI {
             max-height: ${this.maxHeight}px;
             transform: translate3d(${this.xOffset}px,${this.yOffset}px,0);
             ${ this.screenCorner.y == 'top' ? '' : 'top: auto; bottom: 0;' }
-            ${ this.color ? 'background: ' + this.color + ';' : '' }
+            ${ this.backgroundColor ? 'background: ' + this.backgroundColor + ';' : '' }
         }`);
 
         if (options.autoRepositioning != false) window.addEventListener('resize', this._handleResize.bind(this));
@@ -142,6 +142,8 @@ export default class GUI {
         if (element.onchange) domElement.onchange = element.onchange;
         if (element.textContent) domElement.textContent = element.textContent;
         if (element.innerHTML) domElement.innerHTML = element.innerHTML;
+        if (element.type) domElement.type = element.type;
+        if (element.value) domElement.value = element.value;
         if (element.customAttributes) {
             for (var i in element.customAttributes) {
                 domElement.setAttribute(i, element.customAttributes[i]);
@@ -167,7 +169,7 @@ export default class GUI {
             parent: this.wrapper,
             class: 'p-gui__header',
             textContent: this.name,
-            inline: `${ this.color ? 'border-color: ' + this.color + ';' : ''}`
+            inline: `${ this.backgroundColor ? 'border-color: ' + this.backgroundColor + ';' : ''}`
         });
     
         this._createElement({
@@ -246,13 +248,14 @@ export default class GUI {
                 value: 'number'
             }, params);
         } else {
+            object = params.obj || params.object;
+            prop = params.prop || params.property;
+            
             this._checkMandatoryParams({
                 object: 'object',
                 prop: 'string'
-            }, params);
+            }, {object, prop});
 
-            object = params.object;
-            prop = params.prop;
             propReferenceIndex = this.propReferences.push(object[prop]) - 1;
             isObject = true;
         }
@@ -399,12 +402,12 @@ export default class GUI {
         const minY = data.y.min ?? 0;
         const maxY = data.y.max ?? 1;
 
-        const objectX = data.x.object;
-        const propX = data.x.prop;
+        const objectX = data.x.obj || data.x.object;
+        const propX = data.x.prop || data.x.property;
         const propXReferenceIndex = this.propReferences.push(objectX[propX]) - 1;
         
-        const objectY = data.y.object;
-        const propY = data.y.prop;
+        const objectY = data.y.obj || data.y.object;
+        const propY = data.y.prop || data.y.property;
         const propYReferenceIndex = this.propReferences.push(objectY[propY]) - 1;
 
         this.imageContainer = null;
@@ -471,6 +474,28 @@ export default class GUI {
         });
     }
 
+    color(text, value, callback) {
+        const container = this._createElement({
+            el: 'div',
+            class: 'p-gui__color',
+            textContent: text,
+        });
+
+        const colorpicker = this._createElement({
+            parent: container,
+            el: 'input',
+            class: 'p-gui__color-picker',
+            type: 'color',
+            value
+        });
+
+        if (callback) {
+            colorpicker.addEventListener('input', () => {
+                callback(colorpicker.value);
+            });
+        }
+    }
+
     folder(options = {}) {
         let closed = typeof options.closed == 'boolean' ? options.closed : false;
         let name = options.name || '';

package/src/styles.js

@@ -92,7 +92,8 @@ return /* css */`
 .p-gui__button, 
 .p-gui__switch,
 .p-gui__list,
-.p-gui__vector2 {
+.p-gui__vector2,
+.p-gui__color {
     width: 100%;
     padding: 7px;
     font-size: 11px;
@@ -177,10 +178,6 @@ return /* css */`
     pointer-events: none;
 }
 
-.p-gui__list {
-    cursor: default;
-}
-
 .p-gui__switch-checkbox {
     width: 5px;
     height: 5px;
@@ -199,7 +196,13 @@ return /* css */`
     box-shadow: 0 0 5px #00ff89;
 }
 
-.p-gui__list-dropdown {
+.p-gui__list,
+.p-gui__color {
+    cursor: default;
+}
+
+.p-gui__list-dropdown,
+.p-gui__color-picker {
     position: absolute;
     right: 5px;
     top: 0;
@@ -209,6 +212,21 @@ return /* css */`
     cursor: pointer;
 }
 
+.p-gui__color-picker {
+    -webkit-appearance: none;
+    padding: 0;
+    background-color: transparent;
+    height: 15px;
+    border: 1px solid #222222;
+}
+
+.p-gui__color-picker::-webkit-color-swatch-wrapper {
+	padding: 0;
+}
+.p-gui__color-picker::-webkit-color-swatch {
+	border: none;
+}
+
 .p-gui__slider {
     width: 100%;
     margin-bottom: 8px;

package/test/src/index.html

@@ -25,22 +25,17 @@
     <span style="color: #a6e22e">x</span><span style="color: #f92672">:</span> <span style="color: #ae81ff">0</span>
 <span style="color: #f8f8f2">};</span>
 
-<span style="color: #66d9ef">const</span> <span style="color: #a6e22e">gui</span> <span style="color: #f92672">=</span> <span style="color: #66d9ef">new</span> <span style="color: #a6e22e">GUI</span><span style="color: #f8f8f2">({</span>
-    <span style="color: #a6e22e">name</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;Basics&#39;</span>
-<span style="color: #f8f8f2">});</span>
+<span style="color: #66d9ef">const</span> <span style="color: #a6e22e">gui</span> <span style="color: #f92672">=</span> <span style="color: #66d9ef">new</span> <span style="color: #a6e22e">GUI</span><span style="color: #f8f8f2">({</span> <span style="color: #a6e22e">name</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;Basics&#39;</span> <span style="color: #f8f8f2">});</span>
 
 <span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">button</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Button&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #a6e22e">changeColor</span><span style="color: #f8f8f2">);</span>
 
-<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">slider</span><span style="color: #f8f8f2">({</span> 
-    <span style="color: #a6e22e">name</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;Slider (simple callback)&#39;</span><span style="color: #f8f8f2">,</span>
-    <span style="color: #a6e22e">value</span><span style="color: #f92672">:</span> <span style="color: #ae81ff">1</span><span style="color: #f8f8f2">,</span>
-<span style="color: #f8f8f2">},</span> <span style="color: #a6e22e">value</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span> 
-    <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">opacity</span> <span style="color: #f92672">=</span> <span style="color: #a6e22e">value</span>
-<span style="color: #f8f8f2">});</span>
+<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">slider</span><span style="color: #f8f8f2">({</span> <span style="color: #a6e22e">name</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;Slider (simple callback)&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #a6e22e">value</span><span style="color: #f92672">:</span> <span style="color: #ae81ff">1</span> <span style="color: #f8f8f2">},</span> 
+    <span style="color: #a6e22e">value</span> <span style="color: #f92672">=&gt;</span> <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">opacity</span> <span style="color: #f92672">=</span> <span style="color: #a6e22e">value</span> 
+<span style="color: #f8f8f2">);</span>
 
 <span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">slider</span><span style="color: #f8f8f2">({</span> 
     <span style="color: #a6e22e">name</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;Slider 2 (object binding)&#39;</span><span style="color: #f8f8f2">,</span> 
-    <span style="color: #a6e22e">object</span><span style="color: #f92672">:</span> <span style="color: #a6e22e">position</span><span style="color: #f8f8f2">,</span> 
+    <span style="color: #a6e22e">obj</span><span style="color: #f92672">:</span> <span style="color: #a6e22e">position</span><span style="color: #f8f8f2">,</span> 
     <span style="color: #a6e22e">prop</span><span style="color: #f92672">:</span> <span style="color: #e6db74">&#39;x&#39;</span><span style="color: #f8f8f2">,</span> 
     <span style="color: #a6e22e">min</span><span style="color: #f92672">:</span> <span style="color: #f92672">-</span><span style="color: #ae81ff">30</span><span style="color: #f8f8f2">,</span> 
     <span style="color: #a6e22e">max</span><span style="color: #f92672">:</span> <span style="color: #ae81ff">30</span><span style="color: #f8f8f2">,</span> 
@@ -54,22 +49,19 @@
 
 <span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">list</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;List&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #f8f8f2">[</span><span style="color: #e6db74">&#39;red&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;pink&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;yellow&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;blue&#39;</span><span style="color: #f8f8f2">],</span> <span style="color: #a6e22e">item</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
     <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundColor</span> <span style="color: #f92672">=</span> <span style="color: #a6e22e">item</span><span style="color: #f8f8f2">;</span>
-    <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundImage</span> <span style="color: #f92672">=</span> <span style="color: #e6db74">&#39;none&#39;</span><span style="color: #f8f8f2">;</span>
 <span style="color: #f8f8f2">});</span>
 
-<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">image</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Image 1&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;path/to/image-1.jpg&#39;</span><span style="color: #f8f8f2">,</span>
-    <span style="color: #a6e22e">evt</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
-        <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundImage</span> <span style="color: #f92672">=</span> <span style="color: #960050; background-color: #1e0010">`</span><span style="color: #a6e22e">url</span><span style="color: #f8f8f2">(</span><span style="color: #a6e22e">$</span><span style="color: #f8f8f2">{</span><span style="color: #a6e22e">evt</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">path</span><span style="color: #f8f8f2">})</span><span style="color: #960050; background-color: #1e0010">`</span><span style="color: #f8f8f2">;</span>
-        <span style="color: #f8f8f2">document.</span><span style="color: #a6e22e">querySelector</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;#container-1 .note&#39;</span><span style="color: #f8f8f2">).</span><span style="color: #a6e22e">textContent</span> <span style="color: #f92672">=</span> <span style="color: #e6db74">&quot;Photo by Joel Filipe on Unsplash&quot;</span><span style="color: #f8f8f2">;</span>
-    <span style="color: #f8f8f2">}</span>
-<span style="color: #f8f8f2">);</span>
+<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">image</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Image 1&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;path/to/image-1.jpg&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #a6e22e">evt</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
+    <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundImage</span> <span style="color: #f92672">=</span> <span style="color: #960050; background-color: #1e0010">`</span><span style="color: #a6e22e">url</span><span style="color: #f8f8f2">(</span><span style="color: #a6e22e">$</span><span style="color: #f8f8f2">{</span><span style="color: #a6e22e">evt</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">path</span><span style="color: #f8f8f2">})</span><span style="color: #960050; background-color: #1e0010">`</span><span style="color: #f8f8f2">;</span>
+<span style="color: #f8f8f2">});</span>
 
-<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">image</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Image 2&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;path/to/image-2.jpg&#39;</span><span style="color: #f8f8f2">,</span>
-    <span style="color: #a6e22e">evt</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
-        <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundImage</span> <span style="color: #f92672">=</span> <span style="color: #960050; background-color: #1e0010">`</span><span style="color: #a6e22e">url</span><span style="color: #f8f8f2">(</span><span style="color: #a6e22e">$</span><span style="color: #f8f8f2">{</span><span style="color: #a6e22e">evt</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">path</span><span style="color: #f8f8f2">})</span><span style="color: #960050; background-color: #1e0010">`</span><span style="color: #f8f8f2">;</span>
-        <span style="color: #f8f8f2">document.</span><span style="color: #a6e22e">querySelector</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;#container-1 .note&#39;</span><span style="color: #f8f8f2">).</span><span style="color: #a6e22e">textContent</span> <span style="color: #f92672">=</span> <span style="color: #e6db74">&quot;Photo by Milad Fakurian on Unsplash&quot;</span><span style="color: #f8f8f2">;</span>
-    <span style="color: #f8f8f2">}</span>
-<span style="color: #f8f8f2">);</span>
+<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">image</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Image 2&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;path/to/image-2.jpg&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #a6e22e">evt</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
+    <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundImage</span> <span style="color: #f92672">=</span> <span style="color: #960050; background-color: #1e0010">`</span><span style="color: #a6e22e">url</span><span style="color: #f8f8f2">(</span><span style="color: #a6e22e">$</span><span style="color: #f8f8f2">{</span><span style="color: #a6e22e">evt</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">path</span><span style="color: #f8f8f2">})</span><span style="color: #960050; background-color: #1e0010">`</span><span style="color: #f8f8f2">;</span>
+<span style="color: #f8f8f2">});</span>
+
+<span style="color: #a6e22e">gui</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">color</span><span style="color: #f8f8f2">(</span><span style="color: #e6db74">&#39;Color&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #e6db74">&#39;#ff0000&#39;</span><span style="color: #f8f8f2">,</span> <span style="color: #a6e22e">color</span> <span style="color: #f92672">=&gt;</span> <span style="color: #f8f8f2">{</span>
+    <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">backgroundColor</span> <span style="color: #f92672">=</span> <span style="color: #a6e22e">color</span><span style="color: #f8f8f2">;</span>
+<span style="color: #f8f8f2">});</span>
 
 <span style="color: #66d9ef">function</span> <span style="color: #a6e22e">loop</span><span style="color: #f8f8f2">()</span> <span style="color: #f8f8f2">{</span>
     <span style="color: #a6e22e">element</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">style</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">transform</span> <span style="color: #f92672">=</span> <span style="color: #960050; background-color: #1e0010">`</span><span style="color: #a6e22e">translateX</span><span style="color: #f8f8f2">(</span><span style="color: #a6e22e">$</span><span style="color: #f8f8f2">{</span><span style="color: #a6e22e">position</span><span style="color: #f8f8f2">.</span><span style="color: #a6e22e">x</span><span style="color: #f8f8f2">}</span><span style="color: #a6e22e">px</span><span style="color: #f8f8f2">)</span><span style="color: #960050; background-color: #1e0010">`</span><span style="color: #f8f8f2">;</span>
@@ -77,7 +69,8 @@
 <span style="color: #f8f8f2">}</span>
 
 <span style="color: #a6e22e">loop</span><span style="color: #f8f8f2">();</span>
-</pre></div>
+</pre></div>    
+    
         </div>
         
         <h2>Vectors</h2>

package/test/src/index.js

@@ -1,5 +1,5 @@
 import './styles/main.scss';
-import full_featured from './js/full_featured';
+//import demo from './js/demo';
 import basics from './js/basics';
 import vectors from './js/vectors';
 import multiple from './js/multiple';
@@ -7,7 +7,7 @@ import folders from './js/folders';
 import other from './js/other';
 import kill_create from './js/kill_create';
 
-//full_featured();
+//demo();
 
 basics();
 

package/test/src/js/basics.js

@@ -25,8 +25,7 @@ export default function basics() {
         }
     );
 
-    gui.slider({ name: 'Slider 2 (object binding)', object: position, prop: 'x', min: -30, max: 30, step: .1 }
-    );
+    gui.slider({ name: 'Slider 2 (object binding)', obj: position, prop: 'x', min: -30, max: 30, step: .1 });
 
     gui.toggle('Switch', true, state => {
         if ( state ) element.classList.remove('round');
@@ -34,8 +33,8 @@ export default function basics() {
     });
 
     gui.list('List', ['red', 'pink', 'yellow', 'blue'], item => {
-        element.style.backgroundColor = item;
         element.style.backgroundImage = 'none';
+        element.style.backgroundColor = item;
     });
 
     gui.image('Image 1',
@@ -54,6 +53,11 @@ export default function basics() {
         }
     );
 
+    gui.color('Color', '#ff0000', color => {
+        element.style.backgroundImage = 'none';
+        element.style.backgroundColor = color;
+    });
+
     function loop() {
         element.style.transform = `translateX(${position.x}px)`;
         requestAnimationFrame(loop);

package/test/src/js/{full_featured.js → demo.js}

@@ -28,17 +28,17 @@ export default function()
 
     folder1.image(
         'The officer',
-        require('../img/DALL·E 2022-11-13 20.11.16 - portrait of a squirrel in an officier suit, style of a Rembrandt painting.png'),
+        require('../img/DALL·E-2022-11-13-20.11.16---portrait-of-a-squirrel-in-an-officier-suit,-style-of-a-Rembrandt-painting.jpg'),
         () => {}
     );
     folder1.image(
         'Weird dream',
-        require('../img/DALL·E 2022-11-13 20.11.52 - a blonde girl riding a whale in the style of hopper.png'),
+        require('../img/DALL·E-2022-11-13-20.11.52---a-blonde-girl-riding-a-whale-in-the-style-of-hopper.jpg'),
         () => {}
     );
     folder1.image(
         'Friends',
-        require('../img/DALL·E 2022-11-13 20.13.55 - 1 blonde haired girl with her orange cat, watching the whales in Tadoussac, Canada. In the style of an oil painting..png'),
+        require('../img/DALL·E-2022-11-13-20.13.55---1-blonde-haired-girl-with-her-orange-cat,-watching-the-whales-in-Tadoussac,-Canada.-In-the-style-of-an-oil-painting..jpg'),
         () => {}
     );
 

package/test/src/styles/main.scss

@@ -94,7 +94,7 @@ pre {
     background-position: center;
     background-repeat: no-repeat;
     border: 1px solid black;
-    transition: .1s transform ease, .3s border-radius ease, .3s background-color linear;
+    transition: .1s transform ease, .3s border-radius ease;
 }
 
 .element.round {