stimeo-ui 0.16.0 → 0.18.0

package/dist/controllers/meter_controller.d.ts

@@ -1,19 +1,6 @@
 import { Controller } from '@hotwired/stimulus';
+import { N as NumericValueEvent } from '../coerce-JtZVNG5h.js';
 
-/**
- * Event shape `setValue` accepts: an action param `amount` or a `detail.value`.
- * Both are typed `number | string` because, while Stimulus coerces numeric action
- * params to numbers, a `meter:set` CustomEvent (or a non-numeric-looking param)
- * may carry a string; {@link MeterController.setValue} normalizes either form.
- */
-type SetValueEvent = Event & {
-    params?: {
-        amount?: number | string;
-    };
-    detail?: {
-        value?: number | string;
-    };
-};
 /**
  * Headless meter behavior backed by the WAI-ARIA `meter` role.
  *
@@ -26,7 +13,7 @@ type SetValueEvent = Event & {
  *   </div>
  *
  * A `meter` is a *point-in-time* scalar within a known range (disk usage,
- * battery, score) — distinct from {@link ProgressController}'s task progress.
+ * battery, score) — distinct from `stimeo--progress`'s task progress.
  * The controller syncs the ARIA value attributes and, when `low`/`high`
  * thresholds are present, classifies the value into a `low`/`medium`/`high`
  * segment on `data-state` so the consumer can color the bar.
@@ -36,9 +23,12 @@ type SetValueEvent = Event & {
  * @remarks
  * Behavior only. Because state must not be conveyed by color alone (WCAG 1.4.1),
  * a consumer-provided `valueText` template feeds `aria-valuetext` so the segment
- * is also available as text; a consumer that authors `aria-valuetext` itself keeps
- * it instead: only text this controller marked as its own is ever taken back. Threshold presence is read from the
- * *attributes* (an absent attribute means "no threshold"), not from a sentinel value.
+ * is also available as text; with no template, a consumer that authors `aria-valuetext`
+ * itself keeps it across renders. While a `valueText` template is set its text replaces an
+ * authored `aria-valuetext`; clearing the template or disconnecting puts the authored value
+ * back unless the page wrote its own meanwhile, which then stays. A changed template takes
+ * the attribute over again. Threshold presence is read from the *attributes* (an absent
+ * attribute means "no threshold"), not from a sentinel value.
  */
 declare class MeterController extends Controller<HTMLElement> {
     #private;
@@ -77,6 +67,26 @@ declare class MeterController extends Controller<HTMLElement> {
             default: string;
         };
     };
+    static valueConstraints: {
+        value: {
+            readonly finite: true;
+        };
+        min: {
+            readonly finite: true;
+        };
+        max: {
+            readonly finite: true;
+        };
+        low: {
+            readonly finite: true;
+        };
+        high: {
+            readonly finite: true;
+        };
+        optimum: {
+            readonly finite: true;
+        };
+    };
     static actions: readonly ["setValue"];
     static events: readonly ["change"];
     readonly barTarget: HTMLElement;
@@ -90,14 +100,17 @@ declare class MeterController extends Controller<HTMLElement> {
     valueTextValue: string;
     announceTextValue: string;
     connect(): void;
-    /** Closes the window in which a queued repaint may still run. */
+    /**
+     * Closes the window in which a queued repaint may still run, and returns
+     * `aria-valuetext` to the authored value unless the page wrote its own meanwhile.
+     */
     disconnect(): void;
     /**
      * Updates the measured value from an action param (`amount`) or a
      * `detail.value` CustomEvent, syncs ARIA and `data-state`, and dispatches
      * `change` with the value, ratio, and computed segment.
      */
-    setValue(event: SetValueEvent): void;
+    setValue(event: NumericValueEvent): void;
     /** Repaints when application code (or a Turbo morph) changes `value` at runtime. */
     valueValueChanged(): void;
     /** Repaints when application code (or a Turbo morph) changes `min` at runtime. */