@truenas/ui-components 0.1.77 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/ui-components",
-  "version": "0.1.77",
+  "version": "0.2.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"

package/types/truenas-ui-components.d.ts

@@ -3571,6 +3571,17 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor, On
      * with i18n requirements can pass a translated string.
      */
     noOptionsLabel: _angular_core.InputSignal<string>;
+    /**
+     * When `true` (single-select mode only), prepends a synthetic "empty"
+     * option to the dropdown so users can unset a chosen value: picking it
+     * resets the selection to `null`, shows the placeholder again, and emits
+     * `null` via `selectionChange` (and to any bound form control). Mirrors
+     * webui ix-select's `--` option. Ignored when `multiple` is set — there,
+     * values are cleared by toggling them off individually.
+     */
+    allowEmpty: _angular_core.InputSignal<boolean>;
+    /** Label of the empty option rendered when `allowEmpty` is set. */
+    emptyLabel: _angular_core.InputSignal<string>;
     disabled: _angular_core.InputSignal<boolean>;
     testId: _angular_core.InputSignal<TnTestIdValue>;
     multiple: _angular_core.InputSignal<boolean>;
@@ -3600,7 +3611,11 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor, On
      * ```
      */
     compareWith: _angular_core.InputSignal<((a: T | null, b: T | null) => boolean) | undefined>;
-    selectionChange: _angular_core.OutputEmitterRef<T>;
+    /**
+     * Emits the picked value on each selection in single mode. Emits `null`
+     * when the user picks the `allowEmpty` empty option to clear the field.
+     */
+    selectionChange: _angular_core.OutputEmitterRef<T | null>;
     /** Emits the full array of selected values after each toggle in multiple mode. */
     multiSelectionChange: _angular_core.OutputEmitterRef<T[]>;
     protected isOpen: _angular_core.WritableSignal<boolean>;
@@ -3620,6 +3635,17 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor, On
      */
     protected idNamespace: _angular_core.Signal<string>;
     isDisabled: _angular_core.Signal<boolean>;
+    /**
+     * The synthetic clear-selection option (`allowEmpty`, single mode only).
+     * Its value is `null` cast to `T` so it flows through the same selection
+     * path as real options — `selectedValue`/`writeValue` already model "no
+     * selection" as `null`, so picking it clears the field for free.
+     */
+    protected emptyOption: _angular_core.Signal<TnSelectOption<T> | null>;
+    /** Ungrouped options as rendered: the empty option (when enabled) first. */
+    protected displayOptions: _angular_core.Signal<TnSelectOption<T>[]>;
+    /** Whether `option` is the synthetic `allowEmpty` clear option. */
+    protected isEmptyOption(option: TnSelectOption<T>): boolean;
     /**
      * Selectable, non-disabled options in display order (regular options first,
      * then groups). Used by keyboard navigation so we can skip disabled
@@ -3730,7 +3756,7 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor, On
     private activateFocusedOption;
     private scrollFocusedIntoView;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<TnSelectComponent<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnSelectComponent<any>, "tn-select", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "optionGroups": { "alias": "optionGroups"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "noOptionsLabel": { "alias": "noOptionsLabel"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "optionTestIdKey": { "alias": "optionTestIdKey"; "required": false; "isSignal": true; }; "compareWith": { "alias": "compareWith"; "required": false; "isSignal": true; }; }, { "selectionChange": "selectionChange"; "multiSelectionChange": "multiSelectionChange"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnSelectComponent<any>, "tn-select", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "optionGroups": { "alias": "optionGroups"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "noOptionsLabel": { "alias": "noOptionsLabel"; "required": false; "isSignal": true; }; "allowEmpty": { "alias": "allowEmpty"; "required": false; "isSignal": true; }; "emptyLabel": { "alias": "emptyLabel"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "optionTestIdKey": { "alias": "optionTestIdKey"; "required": false; "isSignal": true; }; "compareWith": { "alias": "compareWith"; "required": false; "isSignal": true; }; }, { "selectionChange": "selectionChange"; "multiSelectionChange": "multiSelectionChange"; }, never, never, true, never>;
 }
 
 /**
@@ -3864,6 +3890,22 @@ declare class TnSelectHarness extends ComponentHarness {
      * ```
      */
     selectOption(filter: string | RegExp): Promise<void>;
+    /**
+     * Clears the selection by picking the empty option. Only available when
+     * the select has `allowEmpty` set (single mode); throws otherwise.
+     * Opens the dropdown if needed.
+     *
+     * @returns Promise that resolves when the selection has been cleared.
+     *
+     * @example
+     * ```typescript
+     * const select = await loader.getHarness(TnSelectHarness);
+     * await select.selectOption('Banana');
+     * await select.clear();
+     * expect(await select.getDisplayText()).toBe('Select a fruit'); // placeholder
+     * ```
+     */
+    clear(): Promise<void>;
     /**
      * Gets the labels of all available options. Opens the dropdown if needed.
      *
@@ -5898,7 +5940,7 @@ declare class TnTimeInputComponent implements ControlValueAccessor {
     registerOnChange(fn: (value: string) => void): void;
     registerOnTouched(fn: () => void): void;
     setDisabledState(isDisabled: boolean): void;
-    onSelectionChange(value: string): void;
+    onSelectionChange(value: string | null): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<TnTimeInputComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnTimeInputComponent, "tn-time-input", never, { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "format": { "alias": "format"; "required": false; "isSignal": true; }; "granularity": { "alias": "granularity"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }