@oicl/openbridge-webcomponents-svelte 2.0.0-next.145 → 2.0.0-next.146

package/dist/building-blocks/readout-block/ObcReadoutBlock.svelte

@@ -17,10 +17,10 @@ import type {AlertFrameConfig} from '@oicl/openbridge-webcomponents/dist/compone
      style?: string;
      /** Semantic variant (value / setpoint / advice). */
      variant?: ReadoutBlockVariant;
-      /** [object Object],[object Object],[object Object] */
-value?: string | number | null;
-      /** [object Object],[object Object],[object Object] */
-valueType?: ReadoutValueType;
+     /** The value; `null`/`undefined` renders a dash. A number by default, or text when `valueType` is `text`. */
+     value?: string | number | null;
+     /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
+     valueType?: ReadoutValueType;
      /** Density tier — icon size, gap, degree tier. */
      size?: ReadoutBlockSize;
      /** Resolved number-typography size. When unset it is derived from `size` (small→s, medium→m, large→l), so a parent that de-emphasises a block (e.g. a secondary setpoint) can pass a smaller size without changing the tier. */
@@ -59,8 +59,12 @@ valueType?: ReadoutValueType;
      offText?: string;
      /** Text alignment of the number within its reserved width. */
      alignment?: ObcTextboxAlignment;
-      /** [object Object],[object Object],[object Object] */
-category?: ReadoutAdviceCategory;
+     /**
+      * Semantic category of an advice block — picks the default marker icon and the `active` styling. Only meaningful for `variant="advice"`.
+      *
+      * Available when `variant==advice`.
+      */
+     category?: ReadoutAdviceCategory;
      /**
       * The advice is triggered: the marker swaps to its filled/status icon and the number takes the category's triggered styling (SemiBold for regular/optimal/eco, active text colour for the alert categories). Only meaningful for `variant="advice"`.
       *

package/dist/building-blocks/readout-block/ObcReadoutBlock.svelte.d.ts

@@ -9,9 +9,9 @@ export interface Props {
     style?: string;
     /** Semantic variant (value / setpoint / advice). */
     variant?: ReadoutBlockVariant;
-    /** [object Object],[object Object],[object Object] */
+    /** The value; `null`/`undefined` renders a dash. A number by default, or text when `valueType` is `text`. */
     value?: string | number | null;
-    /** [object Object],[object Object],[object Object] */
+    /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
     valueType?: ReadoutValueType;
     /** Density tier — icon size, gap, degree tier. */
     size?: ReadoutBlockSize;
@@ -51,7 +51,11 @@ export interface Props {
     offText?: string;
     /** Text alignment of the number within its reserved width. */
     alignment?: ObcTextboxAlignment;
-    /** [object Object],[object Object],[object Object] */
+    /**
+     * Semantic category of an advice block — picks the default marker icon and the `active` styling. Only meaningful for `variant="advice"`.
+     *
+     * Available when `variant==advice`.
+     */
     category?: ReadoutAdviceCategory;
     /**
      * The advice is triggered: the marker swaps to its filled/status icon and the number takes the category's triggered styling (SemiBold for regular/optimal/eco, active text colour for the alert categories). Only meaningful for `variant="advice"`.

package/dist/components/checkbox-item/ObcCheckboxItem.svelte

@@ -17,7 +17,7 @@ import type {ObcCheckboxItemExpandToggleEvent, ObcCheckboxItemState, ObcCheckbox
      state?: ObcCheckboxItemState;
      /** Disables the row and the inner checkbox. */
      disabled?: boolean;
-     /** Text label; also the checkbox's accessible name. */
+     /** Text label; also the accessible name of the checkbox and the chevron button, so it must not be empty. */
      label?: string;
      /** Secondary line under the label; hidden when empty. */
      description?: string;

package/dist/components/checkbox-item/ObcCheckboxItem.svelte.d.ts

@@ -11,7 +11,7 @@ export interface Props {
     state?: ObcCheckboxItemState;
     /** Disables the row and the inner checkbox. */
     disabled?: boolean;
-    /** Text label; also the checkbox's accessible name. */
+    /** Text label; also the accessible name of the checkbox and the chevron button, so it must not be empty. */
     label?: string;
     /** Secondary line under the label; hidden when empty. */
     description?: string;

package/dist/navigation-instruments/readout/ObcReadout.svelte

@@ -24,10 +24,10 @@ import type {ReadoutValueOptions, ReadoutSetpointOptions, ReadoutAdviceOptions,
      src?: string | undefined;
      /** Layout switch: `false` renders a deliberately value-less (label-only) readout that hugs its remaining parts. For a temporarily missing value keep `hasValue` and set `value` to `null` instead — the dash keeps the value block at full size, so the layout does not shift when data arrives. */
      hasValue?: boolean;
-      /** [object Object],[object Object],[object Object] */
-value?: string | number | null;
-      /** [object Object],[object Object],[object Object] */
-valueType?: ReadoutValueType;
+     /** The value; `null` renders a dash. A number by default, or text when `valueType` is `text`. */
+     value?: string | number | null;
+     /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
+     valueType?: ReadoutValueType;
      /** Render the value as `offText` (e.g. equipment powered down). Affects the value only. */
      off?: boolean;
      /**

package/dist/navigation-instruments/readout/ObcReadout.svelte.d.ts

@@ -14,9 +14,9 @@ export interface Props {
     src?: string | undefined;
     /** Layout switch: `false` renders a deliberately value-less (label-only) readout that hugs its remaining parts. For a temporarily missing value keep `hasValue` and set `value` to `null` instead — the dash keeps the value block at full size, so the layout does not shift when data arrives. */
     hasValue?: boolean;
-    /** [object Object],[object Object],[object Object] */
+    /** The value; `null` renders a dash. A number by default, or text when `valueType` is `text`. */
     value?: string | number | null;
-    /** [object Object],[object Object],[object Object] */
+    /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
     valueType?: ReadoutValueType;
     /** Render the value as `offText` (e.g. equipment powered down). Affects the value only. */
     off?: boolean;

package/dist/navigation-instruments/readout-list-item/ObcReadoutListItem.svelte

@@ -20,10 +20,10 @@ import type {AlertFrameConfig} from '@oicl/openbridge-webcomponents/dist/compone
      src?: string | undefined;
      /** Layout switch: `false` renders a deliberately value-less (label-only) row that hugs its remaining parts. For a temporarily missing value keep `hasValue` and set `value` to `null` instead — the dash keeps the value block at full size, so the row does not shift when data arrives. */
      hasValue?: boolean;
-      /** [object Object],[object Object],[object Object] */
-value?: string | number | null;
-      /** [object Object],[object Object],[object Object] */
-valueType?: ReadoutValueType;
+     /** The value; `null` renders a dash. A number by default, or text when `valueType` is `text`. */
+     value?: string | number | null;
+     /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
+     valueType?: ReadoutValueType;
      /** Render the value as `offText` (e.g. equipment powered down). Affects the value only. */
      off?: boolean;
      /**

package/dist/navigation-instruments/readout-list-item/ObcReadoutListItem.svelte.d.ts

@@ -12,9 +12,9 @@ export interface Props {
     src?: string | undefined;
     /** Layout switch: `false` renders a deliberately value-less (label-only) row that hugs its remaining parts. For a temporarily missing value keep `hasValue` and set `value` to `null` instead — the dash keeps the value block at full size, so the row does not shift when data arrives. */
     hasValue?: boolean;
-    /** [object Object],[object Object],[object Object] */
+    /** The value; `null` renders a dash. A number by default, or text when `valueType` is `text`. */
     value?: string | number | null;
-    /** [object Object],[object Object],[object Object] */
+    /** How `value` is interpreted. `number` (default) formats it via `fractionDigits`; `text` renders it verbatim and ignores the numeric format options. Passing text while this is `number` throws. */
     valueType?: ReadoutValueType;
     /** Render the value as `offText` (e.g. equipment powered down). Affects the value only. */
     off?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oicl/openbridge-webcomponents-svelte",
-  "version": "2.0.0-next.145",
+  "version": "2.0.0-next.146",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run prepack",
@@ -31,7 +31,7 @@
     }
   },
   "dependencies": {
-    "@oicl/openbridge-webcomponents": "^2.0.0-next.145"
+    "@oicl/openbridge-webcomponents": "^2.0.0-next.146"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"