@truenas/ui-components 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/ui-components",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "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`.
      *
@@ -1258,11 +1288,26 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
      * (e.g. `1.5 GiB`). Ignored unless `inputType` is `Size`.
      */
     sizeRound: _angular_core.InputSignal<number>;
+    /**
+     * Whether a `Password` field renders the built-in visibility toggle — the eye
+     * button that switches the field between masked and plain-text display.
+     * Defaults to true; set false for secrets that must never be revealed.
+     * Setting `suffixIcon` suppresses the toggle automatically (a custom suffix
+     * control replaces it). Ignored unless `inputType` is `Password`.
+     */
+    showPasswordToggle: _angular_core.InputSignal<boolean>;
     prefixIcon: _angular_core.InputSignal<string | undefined>;
     prefixIconLibrary: _angular_core.InputSignal<IconLibraryType | undefined>;
     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>;
@@ -1271,12 +1316,44 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
     isSize: _angular_core.Signal<boolean>;
     /** True when the field only accepts whole numbers (i.e. `allowDecimals` is false). */
     integerOnly: _angular_core.Signal<boolean>;
-    /** The `type` attribute actually rendered. Number and size modes use a text input: number avoids the native type="number" footguns, size must accept unit letters. */
+    /** True when the field is a password field. */
+    isPassword: _angular_core.Signal<boolean>;
+    /**
+     * Whether the password is currently revealed. Not exposed as an input so a
+     * reveal is always an explicit user gesture, and linked to the toggle's own
+     * availability so a revealed value never outlives the control that revealed
+     * it: whenever the toggle goes away (the field leaves password mode,
+     * `showPasswordToggle` flips off, a `suffixIcon` replaces it) or the field
+     * is disabled, the field snaps back to masked.
+     */
+    protected passwordVisible: _angular_core.WritableSignal<boolean>;
+    /** The `type` attribute actually rendered. Number and size modes use a text input: number avoids the native type="number" footguns, size must accept unit letters. A revealed password renders as text — flipping the type attribute is the standard reveal mechanism and preserves value and caret. */
     resolvedType: _angular_core.Signal<InputType>;
     /** `inputmode` hint: numeric keypad for integers, decimal keypad otherwise. Null (omitted) outside number mode — size fields accept unit letters, so they keep the full keyboard. */
     numericInputMode: _angular_core.Signal<"numeric" | "decimal" | null>;
     /** Number and size modes are always single-line; they win over `multiline` if both are set. */
     showTextarea: _angular_core.Signal<boolean>;
+    /**
+     * The visibility toggle renders only on single-line password fields (a
+     * password+multiline combo renders a textarea, which has no `type` to flip),
+     * and yields to a consumer-provided `suffixIcon` — a custom suffix control
+     * replaces the built-in toggle rather than stacking a second button.
+     */
+    protected hasPasswordToggle: _angular_core.Signal<boolean>;
+    /**
+     * Icon for the visibility toggle, mirroring the field's current state: a
+     * slashed eye while masked, an open eye while revealed. The literal
+     * `tnIconMarker` calls double as build-time markers that pull both icons
+     * into the sprite.
+     */
+    protected passwordToggleIcon: _angular_core.Signal<string>;
+    /**
+     * Role-first test-id segments for the visibility toggle:
+     * `button-toggle-password[-<testId>]`. The toggle is fixed field chrome, so
+     * the role leads (matching the dialog-shell close/fullscreen convention) and
+     * automation can target every password toggle with one prefix selector.
+     */
+    protected passwordToggleTestId: _angular_core.Signal<(string | number | null | undefined)[]>;
     id: string;
     protected value: string;
     private formDisabled;
@@ -1293,12 +1370,13 @@ declare class TnInputComponent implements AfterViewInit, OnDestroy, ControlValue
     setDisabledState(isDisabled: boolean): void;
     protected onValueChange(event: Event): void;
     protected onBlur(): void;
+    protected togglePasswordVisibility(): void;
     /** Strips any character that can't appear in the current numeric mode (single leading '-', single '.' for decimals). */
     private sanitizeNumeric;
     /** 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; }; "showPasswordToggle": { "alias": "showPasswordToggle"; "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>;
 }
 
 /**
@@ -1528,6 +1606,7 @@ declare class TnInputHarness extends ComponentHarness {
     private prefixIconEl;
     private suffixButton;
     private suffixIconEl;
+    private visibilityToggle;
     /**
      * Gets a `HarnessPredicate` that can be used to search for an input
      * with specific attributes.
@@ -1590,6 +1669,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.
      *
@@ -1638,6 +1741,27 @@ declare class TnInputHarness extends ComponentHarness {
      * @returns Promise that resolves when the click action is complete.
      */
     clickSuffixAction(): Promise<void>;
+    /**
+     * Checks whether the password visibility toggle is present.
+     *
+     * @returns Promise resolving to true if the toggle button exists.
+     */
+    hasPasswordToggle(): Promise<boolean>;
+    /**
+     * Whether the password is currently revealed (the field renders as plain text).
+     *
+     * Only meaningful on password-type inputs; resolves false while masked.
+     *
+     * @returns Promise resolving to true when the value is shown in plain text.
+     */
+    isPasswordRevealed(): Promise<boolean>;
+    /**
+     * Clicks the password visibility toggle, switching between masked and
+     * plain-text display.
+     *
+     * @returns Promise that resolves when the click action is complete.
+     */
+    togglePasswordVisibility(): Promise<void>;
     /**
      * Focuses the input element.
      *
@@ -1657,6 +1781,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 +3380,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 +3419,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;