@oicl/openbridge-webcomponents 2.0.0-next.110 → 2.0.0-next.111

package/custom-elements.json

@@ -24041,6 +24041,568 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/automation/indicator-battery/indicator-battery.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Compact 48×48 battery charge indicator.\n\n## Features / Variants\n- `variant`: `bar` (bottom-up percentage fill) or `trend` (history graph\n  with a current-value micro-bar)\n- `direction`: `vertical` or `horizontal` battery shell\n- `value`: color scheme — `regular`, `enhanced` or `categorical`\n- `level`: current charge 0–100 (%), drives the fill and micro-bar\n- `data`: history samples 0–100 (%) drawn as the trend graph\n- `hasIcon`: centered icon overlay (bar variant only)\n\n## Usage Guidelines\nUse as an at-a-glance charge indicator in dashboards and lists. For a\nfull-featured tank/battery cell with readouts, badges and setpoints, use\n`obc-automation-tank` (type `battery`) instead.\n\n## Best Practices / Constraints\n- `level` and `data` values are clamped to 0–100; values outside that\n  range are pinned to the nearest bound.\n- The `trend` variant needs at least two `data` samples to draw a line;\n  with fewer it shows only the current-value micro-bar.\n- The `icon` slot renders only in the `bar` variant; it is ignored in\n  `trend`.\n- Display-only: the root SVG is `aria-hidden`; convey battery state to\n  assistive tech through adjacent text if it is not otherwise available.\n\n## Slots\n| Slot   | Condition                     | Purpose                        |\n| ------ | ----------------------------- | ------------------------------ |\n| `icon` | `hasIcon` and `variant='bar'` | Icon overlay (`obi-*` element) |",
+          "name": "ObcIndicatorBattery",
+          "slots": [
+            {
+              "description": "Centered icon overlay, defaults to `obi-energy-battery`",
+              "name": "icon"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "attribute": "direction",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "IndicatorBatteryVariant"
+              },
+              "attribute": "variant",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "IndicatorBatteryValue"
+              },
+              "attribute": "value",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Current charge, 0-100 (%)",
+              "attribute": "level"
+            },
+            {
+              "kind": "field",
+              "name": "data",
+              "type": {
+                "text": "number[]"
+              },
+              "default": "[]",
+              "description": "History samples, 0-100 (%) each, oldest first",
+              "attribute": "data"
+            },
+            {
+              "kind": "field",
+              "name": "hasIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "attribute": "hasIcon"
+            },
+            {
+              "kind": "field",
+              "name": "scheme",
+              "type": {
+                "text": "LinearIndicatorScheme"
+              },
+              "privacy": "private",
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "fieldName": "direction"
+            },
+            {
+              "name": "variant",
+              "type": {
+                "text": "IndicatorBatteryVariant"
+              },
+              "fieldName": "variant"
+            },
+            {
+              "name": "value",
+              "type": {
+                "text": "IndicatorBatteryValue"
+              },
+              "fieldName": "value"
+            },
+            {
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Current charge, 0-100 (%)",
+              "fieldName": "level"
+            },
+            {
+              "name": "data",
+              "type": {
+                "text": "number[]"
+              },
+              "default": "[]",
+              "description": "History samples, 0-100 (%) each, oldest first",
+              "fieldName": "data"
+            },
+            {
+              "name": "hasIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "hasIcon"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "obc-indicator-battery",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ObcIndicatorBattery",
+          "declaration": {
+            "name": "ObcIndicatorBattery",
+            "module": "src/automation/indicator-battery/indicator-battery.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "obc-indicator-battery",
+          "declaration": {
+            "name": "ObcIndicatorBattery",
+            "module": "src/automation/indicator-battery/indicator-battery.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/automation/indicator-engine/indicator-engine.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Compact 48×48 engine indicator glyph.\n\n## Features / Variants\n- `direction`: `vertical` (upright block with side rails) or `horizontal`\n  (lying block on a base rail)\n- `value`: cylinder color — `static`, `regular` or `enhanced`\n\n## Usage Guidelines\nUse as a static engine presence/state glyph in dashboards and lists.\nIt carries no numeric value; pair it with readouts or other indicators\nwhen quantities must be shown.",
+          "name": "ObcIndicatorEngine",
+          "members": [
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "IndicatorEngineValue"
+              },
+              "attribute": "value",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "attribute": "direction",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "renderHorizontal",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "renderVertical",
+              "privacy": "private"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "value",
+              "type": {
+                "text": "IndicatorEngineValue"
+              },
+              "fieldName": "value"
+            },
+            {
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "fieldName": "direction"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "obc-indicator-engine",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ObcIndicatorEngine",
+          "declaration": {
+            "name": "ObcIndicatorEngine",
+            "module": "src/automation/indicator-engine/indicator-engine.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "obc-indicator-engine",
+          "declaration": {
+            "name": "ObcIndicatorEngine",
+            "module": "src/automation/indicator-engine/indicator-engine.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/automation/indicator-generator/indicator-generator.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Compact generator status indicator (48×48; 56×56 as double-bar).\n\n## Features / Variants\n- `variant`: `button` (plain disc), `bar` (disc with a circular progress\n  ring) or `double-bar` (disc with two concentric progress rings)\n- `value`: visual scheme — `off`, `regular`, `filled`, `enhanced` or\n  `categorical`; `off` hides the progress rings\n- `level`: 0–100 (%), sweep of the (outer) progress ring, clockwise from\n  12 o'clock\n- `secondaryLevel`: 0–100 (%), sweep of the inner ring (double-bar only)\n\n## Usage Guidelines\nUse as an at-a-glance generator load indicator in dashboards and lists.\nFor schematic (P&ID) placement with button behavior, use the electric\ngenerator automation devices instead.\n\n## Slots\n| Slot   | Condition | Purpose                                          |\n| ------ | --------- | ------------------------------------------------ |\n| `icon` | always    | Center icon, defaults to the generator G~ glyph  |",
+          "name": "ObcIndicatorGenerator",
+          "slots": [
+            {
+              "description": "Center icon, defaults to the generator G~ glyph",
+              "name": "icon"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "IndicatorGeneratorVariant"
+              },
+              "attribute": "variant",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "IndicatorGeneratorValue"
+              },
+              "attribute": "value",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Outer progress ring sweep, 0-100 (%)",
+              "attribute": "level"
+            },
+            {
+              "kind": "field",
+              "name": "secondaryLevel",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Inner progress ring sweep, 0-100 (%), double-bar only",
+              "attribute": "secondaryLevel"
+            },
+            {
+              "kind": "field",
+              "name": "center",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "discRadius",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "showOutline",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "renderRing",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "radius",
+                  "type": {
+                    "text": "number"
+                  }
+                },
+                {
+                  "name": "strokeWidth",
+                  "type": {
+                    "text": "number"
+                  }
+                },
+                {
+                  "name": "level",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ]
+            }
+          ],
+          "attributes": [
+            {
+              "name": "variant",
+              "type": {
+                "text": "IndicatorGeneratorVariant"
+              },
+              "fieldName": "variant"
+            },
+            {
+              "name": "value",
+              "type": {
+                "text": "IndicatorGeneratorValue"
+              },
+              "fieldName": "value"
+            },
+            {
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Outer progress ring sweep, 0-100 (%)",
+              "fieldName": "level"
+            },
+            {
+              "name": "secondaryLevel",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Inner progress ring sweep, 0-100 (%), double-bar only",
+              "fieldName": "secondaryLevel"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "obc-indicator-generator",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ObcIndicatorGenerator",
+          "declaration": {
+            "name": "ObcIndicatorGenerator",
+            "module": "src/automation/indicator-generator/indicator-generator.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "obc-indicator-generator",
+          "declaration": {
+            "name": "ObcIndicatorGenerator",
+            "module": "src/automation/indicator-generator/indicator-generator.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/automation/indicator-tank-atmospheric/indicator-tank-atmospheric.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Compact 48×48 atmospheric tank level indicator.\n\n## Features / Variants\n- `variant`: `bar` (bottom-up percentage fill) or `trend` (history graph\n  with a current-value micro-bar)\n- `direction`: `vertical` or `horizontal` tank outline\n- `value`: color scheme — `regular`, `enhanced` or `medium`\n- `level`: current tank level 0–100 (%), drives the fill and micro-bar\n- `data`: history samples 0–100 (%) drawn as the trend graph\n- `hasIcon`: centered icon overlay (bar variant only)\n\n## Usage Guidelines\nUse as an at-a-glance level indicator in dashboards and lists. For a\nfull-featured tank cell with readouts, badges and setpoints, use\n`obc-automation-tank` instead.\n\n## Best Practices / Constraints\n- `level` and `data` values are clamped to 0–100; values outside that\n  range are pinned to the nearest bound.\n- The `trend` variant needs at least two `data` samples to draw a line;\n  with fewer it shows only the current-value micro-bar.\n- The `icon` slot renders only in the `bar` variant; it is ignored in\n  `trend`.\n- Display-only: the root SVG is `aria-hidden`; convey tank level to\n  assistive tech through adjacent text if it is not otherwise available.\n\n## Slots\n| Slot   | Condition                     | Purpose                        |\n| ------ | ----------------------------- | ------------------------------ |\n| `icon` | `hasIcon` and `variant='bar'` | Icon overlay (`obi-*` element) |",
+          "name": "ObcIndicatorTankAtmospheric",
+          "slots": [
+            {
+              "description": "Centered icon overlay, defaults to `obi-tank`",
+              "name": "icon"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "attribute": "direction",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "IndicatorTankAtmosphericVariant"
+              },
+              "attribute": "variant",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "IndicatorTankAtmosphericValue"
+              },
+              "attribute": "value",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Current level, 0-100 (%)",
+              "attribute": "level"
+            },
+            {
+              "kind": "field",
+              "name": "data",
+              "type": {
+                "text": "number[]"
+              },
+              "default": "[]",
+              "description": "History samples, 0-100 (%) each, oldest first",
+              "attribute": "data"
+            },
+            {
+              "kind": "field",
+              "name": "hasIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "attribute": "hasIcon"
+            },
+            {
+              "kind": "field",
+              "name": "scheme",
+              "type": {
+                "text": "LinearIndicatorScheme"
+              },
+              "privacy": "private",
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "direction",
+              "type": {
+                "text": "IndicatorDirection"
+              },
+              "fieldName": "direction"
+            },
+            {
+              "name": "variant",
+              "type": {
+                "text": "IndicatorTankAtmosphericVariant"
+              },
+              "fieldName": "variant"
+            },
+            {
+              "name": "value",
+              "type": {
+                "text": "IndicatorTankAtmosphericValue"
+              },
+              "fieldName": "value"
+            },
+            {
+              "name": "level",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Current level, 0-100 (%)",
+              "fieldName": "level"
+            },
+            {
+              "name": "data",
+              "type": {
+                "text": "number[]"
+              },
+              "default": "[]",
+              "description": "History samples, 0-100 (%) each, oldest first",
+              "fieldName": "data"
+            },
+            {
+              "name": "hasIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "hasIcon"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "obc-indicator-tank-atmospheric",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ObcIndicatorTankAtmospheric",
+          "declaration": {
+            "name": "ObcIndicatorTankAtmospheric",
+            "module": "src/automation/indicator-tank-atmospheric/indicator-tank-atmospheric.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "obc-indicator-tank-atmospheric",
+          "declaration": {
+            "name": "ObcIndicatorTankAtmospheric",
+            "module": "src/automation/indicator-tank-atmospheric/indicator-tank-atmospheric.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/automation/line-cross/line-cross.ts",

package/dist/automation/indicator-battery/indicator-battery.css.js

@@ -0,0 +1,52 @@
+import { css } from "lit";
+const componentStyle = css`* {
+  -webkit-tap-highlight-color: transparent;
+}
+
+:host {
+  display: block;
+  position: relative;
+  width: 48px;
+  height: 48px;
+}
+
+svg {
+  display: block;
+  width: 100%;
+  height: 100%;
+}
+
+.shell {
+  fill: var(--instrument-frame-primary-color);
+  stroke: var(--instrument-frame-tertiary-color);
+}
+
+.tip {
+  fill: var(--instrument-frame-tertiary-color);
+}
+
+.icon-wrapper {
+  position: absolute;
+  inset: 12px;
+  color: var(--element-neutral-color);
+}
+
+:host([value="enhanced"]) .icon-wrapper {
+  color: var(--element-neutral-enhanced-color);
+}
+
+:host([value="categorical"]) .icon-wrapper {
+  color: var(--base-teal-500);
+}
+
+.icon-wrapper ::slotted(*),
+.icon-wrapper obi-energy-battery {
+  display: block;
+  width: 100%;
+  height: 100%;
+}
+`;
+export {
+  componentStyle as default
+};
+//# sourceMappingURL=indicator-battery.css.js.map

package/dist/automation/indicator-battery/indicator-battery.css.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indicator-battery.css.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/automation/indicator-battery/indicator-battery.d.ts

@@ -0,0 +1,65 @@
+import { LitElement } from 'lit';
+import { IndicatorDirection } from '../indicator-shared/linear-indicator.js';
+import '../../icons/icon-energy-battery.js';
+export declare enum IndicatorBatteryVariant {
+    bar = "bar",
+    trend = "trend"
+}
+export declare enum IndicatorBatteryValue {
+    regular = "regular",
+    enhanced = "enhanced",
+    categorical = "categorical"
+}
+/**
+ * Compact 48×48 battery charge indicator.
+ *
+ * ## Features / Variants
+ * - `variant`: `bar` (bottom-up percentage fill) or `trend` (history graph
+ *   with a current-value micro-bar)
+ * - `direction`: `vertical` or `horizontal` battery shell
+ * - `value`: color scheme — `regular`, `enhanced` or `categorical`
+ * - `level`: current charge 0–100 (%), drives the fill and micro-bar
+ * - `data`: history samples 0–100 (%) drawn as the trend graph
+ * - `hasIcon`: centered icon overlay (bar variant only)
+ *
+ * ## Usage Guidelines
+ * Use as an at-a-glance charge indicator in dashboards and lists. For a
+ * full-featured tank/battery cell with readouts, badges and setpoints, use
+ * `obc-automation-tank` (type `battery`) instead.
+ *
+ * ## Best Practices / Constraints
+ * - `level` and `data` values are clamped to 0–100; values outside that
+ *   range are pinned to the nearest bound.
+ * - The `trend` variant needs at least two `data` samples to draw a line;
+ *   with fewer it shows only the current-value micro-bar.
+ * - The `icon` slot renders only in the `bar` variant; it is ignored in
+ *   `trend`.
+ * - Display-only: the root SVG is `aria-hidden`; convey battery state to
+ *   assistive tech through adjacent text if it is not otherwise available.
+ *
+ * ## Slots
+ * | Slot   | Condition                     | Purpose                        |
+ * | ------ | ----------------------------- | ------------------------------ |
+ * | `icon` | `hasIcon` and `variant='bar'` | Icon overlay (`obi-*` element) |
+ *
+ * @slot icon - Centered icon overlay, defaults to `obi-energy-battery`
+ */
+export declare class ObcIndicatorBattery extends LitElement {
+    direction: IndicatorDirection;
+    variant: IndicatorBatteryVariant;
+    value: IndicatorBatteryValue;
+    /** Current charge, 0-100 (%) */
+    level: number;
+    /** History samples, 0-100 (%) each, oldest first */
+    data: number[];
+    hasIcon: boolean;
+    private get scheme();
+    render(): import('lit-html').TemplateResult<1>;
+    static styles: import('lit').CSSResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'obc-indicator-battery': ObcIndicatorBattery;
+    }
+}
+//# sourceMappingURL=indicator-battery.d.ts.map