ui-gauge docs updated

FlowFuse · Sep 3, 2024 · ed382a5 · ed382a5
1 parent 9fefd92
commit ed382a5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 10 deletions.
diff --git a/docs/nodes/widgets/ui-gauge.md b/docs/nodes/widgets/ui-gauge.md
@@ -6,8 +6,11 @@ props:
     Type:
         description: Defines the shape of the gauge, "Tile", "Battery", "Water Tank", "Half Gauge" or "3/4 Gauge"
         dynamic: true
+    Type:
+        description: Defines the type of gauge rendered, "Tile", "3/4 Gauge", "Hald Gauge", "Battery Level" or "Tank Level"
+        dynamic: true
     Style:
-        description: Defines the style of arc rendered, "Needle" or "Rounded"
+        description: Defines the tyle of arc rendered, "Needle" or "Rounded". (only applicable to for 3/4 and Half gauges)
         dynamic: true
     Range (min):
         description: The smallest value that can be shown on the gauge
@@ -22,16 +25,16 @@ props:
         description: Text shown above the gauge, labelling what the gauge is showing.
         dynamic: true
     Prefix:
-        description: Text to be added _before_ the value in the middle of the gauge.
+        description: Text to be added _before_ the value in the middle of the gauge. (only applicable to for 3/4 and Half gauges)
         dynamic: true
     Suffix:
-        description: Text to be shown _after_ the value in the middle of the gauge.
+        description: Text to be shown _after_ the value in the middle of the gauge. (only applicable to for 3/4 and Half gauges)
         dynamic: true
     Units:
-        description: Small text to be shown below the value in the middle of the gauge.
+        description: Small text to be shown below the value in the middle of the gauge. (only applicable to for 3/4 and Half gauges)
         dynamic: true
     Icon:
-        description: Icon to be shown below the value in the middle of the gauge. Uses <a href="https://pictogrammers.com/library/mdi/">Material Designs Icon</a>, no need to include the <code>mdi-</code> prefix.
+        description: Icon to be shown below the value in the middle of the gauge. Uses <a href="https://pictogrammers.com/library/mdi/">Material Designs Icon</a>, no need to include the <code>mdi-</code> prefix. (only applicable to for 3/4 and Half gauges)
         dynamic: true
     Sizes (Gauge): (px) How thick the arc and backdrop of the gauge are rendered.
     Sizes (Gap): (px) How big the gap/padding is between the Gauge and the "Segments"

diff --git a/nodes/widgets/locales/en-US/ui_gauge.html b/nodes/widgets/locales/en-US/ui_gauge.html
@@ -40,7 +40,7 @@ <h3>Dynamic Properties (Inputs)</h3>
                 <li><code>Array&lt;{color: String, from: Number}&gt;</code></li>
             </ul>
         </dd>
-        <dt class="optional">gstyle <span class="property-type">see detail</span></dt>
+        <dt class="optional">gtype <span class="property-type">see detail</span></dt>
         <dd>Modify the type of Gauge rendered, with the following options:
             <ul>
                 <li><code>gauge-battery</code></li>
@@ -50,18 +50,25 @@ <h3>Dynamic Properties (Inputs)</h3>
                 <li><code>gauge-tank</code></li>
             </ul>
         </dd>
+        <dt class="optional">gstyle <span class="property-type">see detail</span></dt>
+        <dd>Modify the style of 3/4 and half Gauge rendered, with the following options: (only applicable to for 3/4 and Half gauges)
+            <ul>
+                <li><code>neelde</code></li>
+                <li><code>rounded</code></li>
+            </ul>
+        </dd>
         <dt class="optional">min <span class="property-type">number</span></dt>
         <dd>Change the minimum value the gauge supports</dd>
         <dt class="optional">max <span class="property-type">number</span></dt>
         <dd>Change the maximum value the gauge supports</dd>
         <dt class="optional">prefix <span class="property-type">string</span></dt>
-        <dd>Change the text rendered after the Gauge's value</dd>
+        <dd>Change the text rendered before the Gauge's value (only applicable to for 3/4 and Half gauges)</dd>
         <dt class="optional">suffix <span class="property-type">string</span></dt>
-        <dd>Change the text rendered after the Gauge's value</dd>
+        <dd>Change the text rendered after the Gauge's value (only applicable to for 3/4 and Half gauges)</dd>
         <dt class="optional">units <span class="property-type">array</span></dt>
-        <dd>Controls the "unit" display underneath the gauge's value for 3/4 and Half gauges.</dd>
+        <dd>Controls the "unit" display underneath the gauge's value for 3/4 and Half gauges (only applicable to for 3/4 and Half gauges)</dd>
         <dt class="optional">icon <span class="property-type">string</span></dt>
-        <dd>Modify which icon is rendered within the gauge (must be a Material Design icon)</dd>
+        <dd>Modify which icon is rendered within the gauge (must be a Material Design icon and only applicable to for 3/4 and Half gauges)</dd>
         <dt class="optional">class <span class="property-type">string</span></dt>
         <dd>Add a CSS class, or more, to the Button at runtime.</dd>
     </dl>