@truenas/ui-components 0.1.77 → 0.2.1

package/package.json

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

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

@@ -1229,6 +1229,36 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
      * the a11y tree.
      */
     ariaLabel: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Native `autocomplete` hint rendered on the input/textarea. Pass the standard
+     * autofill tokens (`'username'`, `'current-password'`, `'new-password'`,
+     * `'one-time-code'`, ...) so browsers and password managers can identify and
+     * fill the field.
+     */
+    autocomplete: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Native `name` attribute rendered on the input/textarea. Browsers and password
+     * managers use it to identify the field; typically mirrors the form control name.
+     */
+    name: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Renders the native `readonly` attribute: the value is visible, focusable and
+     * selectable but not editable. Unlike `disabled`, a readonly field stays in the
+     * tab order and its form control stays enabled.
+     */
+    readonly: _angular_core.InputSignal<boolean>;
+    /**
+     * Renders the native `required` attribute so browsers and assistive technology
+     * expose the field as required. Validation itself stays with the consumer's form
+     * validators (e.g. `Validators.required`); forms that fully own validation UX
+     * should also set `novalidate` to suppress native submit blocking.
+     *
+     * Note: this drives only the native/a11y semantics. When wrapped in a
+     * `tn-form-field`, the visual `*` indicator is inferred automatically from the
+     * control's `Validators.required`; only validator-less setups need the form
+     * field's own `required` input alongside this one.
+     */
+    required: _angular_core.InputSignal<boolean>;
     /**
      * Integer/decimal switch — only meaningful when `inputType` is `InputType.Number`.
      *
@@ -1263,6 +1293,13 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
     suffixIcon: _angular_core.InputSignal<string | undefined>;
     suffixIconLibrary: _angular_core.InputSignal<IconLibraryType | undefined>;
     suffixIconAriaLabel: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Semantic test-id base for the suffix-action button. The library prepends the
+     * element type (`button`) and renders the result under whichever attribute name
+     * is configured via `TN_TEST_ATTR` (default `data-testid`) — e.g.
+     * `suffixActionTestId="toggle-password"` → `button-toggle-password`.
+     */
+    suffixActionTestId: _angular_core.InputSignal<TnTestIdValue>;
     onSuffixAction: _angular_core.OutputEmitterRef<MouseEvent>;
     hasPrefixIcon: _angular_core.Signal<boolean>;
     hasSuffixIcon: _angular_core.Signal<boolean>;
@@ -1298,7 +1335,7 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
     /** Parses a sanitized string to a number, mapping empty/partial input to null (never 0). */
     private parseNumeric;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<TnInputComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnInputComponent, "tn-input", never, { "inputType": { "alias": "inputType"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "multiline": { "alias": "multiline"; "required": false; "isSignal": true; }; "rows": { "alias": "rows"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "allowDecimals": { "alias": "allowDecimals"; "required": false; "isSignal": true; }; "sizeStandard": { "alias": "sizeStandard"; "required": false; "isSignal": true; }; "sizeDefaultUnit": { "alias": "sizeDefaultUnit"; "required": false; "isSignal": true; }; "sizeRound": { "alias": "sizeRound"; "required": false; "isSignal": true; }; "prefixIcon": { "alias": "prefixIcon"; "required": false; "isSignal": true; }; "prefixIconLibrary": { "alias": "prefixIconLibrary"; "required": false; "isSignal": true; }; "suffixIcon": { "alias": "suffixIcon"; "required": false; "isSignal": true; }; "suffixIconLibrary": { "alias": "suffixIconLibrary"; "required": false; "isSignal": true; }; "suffixIconAriaLabel": { "alias": "suffixIconAriaLabel"; "required": false; "isSignal": true; }; }, { "onSuffixAction": "onSuffixAction"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnInputComponent, "tn-input", never, { "inputType": { "alias": "inputType"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "multiline": { "alias": "multiline"; "required": false; "isSignal": true; }; "rows": { "alias": "rows"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "autocomplete": { "alias": "autocomplete"; "required": false; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "allowDecimals": { "alias": "allowDecimals"; "required": false; "isSignal": true; }; "sizeStandard": { "alias": "sizeStandard"; "required": false; "isSignal": true; }; "sizeDefaultUnit": { "alias": "sizeDefaultUnit"; "required": false; "isSignal": true; }; "sizeRound": { "alias": "sizeRound"; "required": false; "isSignal": true; }; "prefixIcon": { "alias": "prefixIcon"; "required": false; "isSignal": true; }; "prefixIconLibrary": { "alias": "prefixIconLibrary"; "required": false; "isSignal": true; }; "suffixIcon": { "alias": "suffixIcon"; "required": false; "isSignal": true; }; "suffixIconLibrary": { "alias": "suffixIconLibrary"; "required": false; "isSignal": true; }; "suffixIconAriaLabel": { "alias": "suffixIconAriaLabel"; "required": false; "isSignal": true; }; "suffixActionTestId": { "alias": "suffixActionTestId"; "required": false; "isSignal": true; }; }, { "onSuffixAction": "onSuffixAction"; }, never, never, true, never>;
 }
 
 /**
@@ -1590,6 +1627,30 @@ declare class TnInputHarness extends ComponentHarness {
      * @returns Promise resolving to the aria-label string, or null if unset.
      */
     getAriaLabel(): Promise<string | null>;
+    /**
+     * Gets the native `name` attribute (set via the `name` input).
+     *
+     * @returns Promise resolving to the name string, or null if unset.
+     */
+    getName(): Promise<string | null>;
+    /**
+     * Gets the native `autocomplete` attribute (set via the `autocomplete` input).
+     *
+     * @returns Promise resolving to the autocomplete token, or null if unset.
+     */
+    getAutocomplete(): Promise<string | null>;
+    /**
+     * Checks whether the input is readonly (set via the `readonly` input).
+     *
+     * @returns Promise resolving to true if the input is readonly.
+     */
+    isReadonly(): Promise<boolean>;
+    /**
+     * Checks whether the input is marked required (set via the `required` input).
+     *
+     * @returns Promise resolving to true if the input is required.
+     */
+    isRequired(): Promise<boolean>;
     /**
      * Gets the placeholder text.
      *
@@ -1657,6 +1718,8 @@ declare class TnInputHarness extends ComponentHarness {
 interface InputHarnessFilters extends BaseHarnessFilters {
     /** Filters by placeholder text. */
     placeholder?: string;
+    /** Filters by the native `name` attribute (typically the form control name). */
+    name?: string;
 }
 
 declare class TnInputDirective {
@@ -3254,6 +3317,17 @@ type SubscriptSizing = 'fixed' | 'dynamic';
 declare class TnFormFieldComponent implements AfterContentInit {
     label: _angular_core.InputSignal<string>;
     hint: _angular_core.InputSignal<string>;
+    /**
+     * Forces the visual `*` required indicator next to the label. Usually
+     * unnecessary: the indicator is inferred automatically when the projected
+     * control carries `Validators.required`. Set this only when inference can't
+     * see the requirement — e.g. a validator wrapped in `Validators.compose(...)`
+     * or a custom validator that emits a `required`-style error.
+     *
+     * The indicator is purely visual — for native/a11y semantics pair it with the
+     * projected control's own `required` input (e.g. `tn-input`'s, which renders
+     * the native attribute).
+     */
     required: _angular_core.InputSignal<boolean>;
     testId: _angular_core.InputSignal<TnTestIdValue>;
     subscriptSizing: _angular_core.InputSignal<SubscriptSizing>;
@@ -3282,6 +3356,13 @@ declare class TnFormFieldComponent implements AfterContentInit {
      * read this so the derived state stays reactive.
      */
     private controlState;
+    /**
+     * Whether the required indicator renders: forced via the `required` input, or
+     * inferred from the projected control's validators (mirrors Angular Material's
+     * `hasValidator(Validators.required)` approach — reference equality, so composed
+     * or custom required-like validators need the explicit input).
+     */
+    protected showRequired: _angular_core.Signal<boolean>;
     protected hasError: _angular_core.Signal<boolean>;
     protected errorMessage: _angular_core.Signal<string>;
     ngAfterContentInit(): void;
@@ -3571,6 +3652,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 +3692,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 +3716,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 +3837,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 +3971,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 +6021,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>;
 }