@truenas/ui-components 0.2.4 → 0.2.5

package/package.json

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

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

@@ -176,6 +176,21 @@ declare class TnAutocompleteComponent<T = unknown> implements ControlValueAccess
     disabled: _angular_core.InputSignal<boolean>;
     /** Require the user to select from the dropdown — reverts on blur if no match */
     requireSelection: _angular_core.InputSignal<boolean>;
+    /**
+     * Commit free text as the value: on blur or Enter, an unmatched search term
+     * becomes the control value instead of being discarded. For string-valued
+     * autocompletes (the typed text IS the value) — e.g. a device path picker
+     * where known devices are suggested but any path is acceptable. Mutually
+     * exclusive with `requireSelection`, which reverts unmatched text.
+     */
+    allowCustomValue: _angular_core.InputSignal<boolean>;
+    /**
+     * Show a loading row in the dropdown panel while options are being fetched.
+     * Pair with `searchChange`/`loadMore` for server-driven options.
+     */
+    loading: _angular_core.InputSignal<boolean>;
+    /** Text shown next to the spinner while `loading` is set. */
+    loadingText: _angular_core.InputSignal<string>;
     /** Custom filter function. Defaults to case-insensitive includes on displayWith text */
     filterFn: _angular_core.InputSignal<((option: T, searchTerm: string) => boolean) | undefined>;
     /** Text shown when no options match the search */
@@ -199,6 +214,29 @@ declare class TnAutocompleteComponent<T = unknown> implements ControlValueAccess
     testId: _angular_core.InputSignal<TnTestIdValue>;
     /** Emits when an option is selected */
     optionSelected: _angular_core.OutputEmitterRef<T>;
+    /**
+     * Emits the search term as the user types (not on programmatic writes or
+     * option selection). Drive server-side filtering from this: fetch matches
+     * and update `options`. The component still applies its client-side filter
+     * on top — for pre-filtered server results, pass `[filterFn]` that returns
+     * `true`. Emissions are not debounced; debounce in the consumer if the
+     * lookup is expensive.
+     */
+    searchChange: _angular_core.OutputEmitterRef<string>;
+    /**
+     * Emits when the open dropdown is scrolled near its bottom — append the
+     * next page to `options` (and use `loading` while it fetches). Suppressed
+     * until the `options` COUNT changes so a slow consumer is not spammed —
+     * which also means replacing the array with a same-length page (e.g. a
+     * fixed-size window) does not re-arm the emitter; pagination must append.
+     */
+    loadMore: _angular_core.OutputEmitterRef<void>;
+    /**
+     * Emits every time the panel opens (focus, click, typing, ArrowDown). For
+     * click-to-suggest pickers, prime the first page from here when `options`
+     * is still empty — `searchChange` alone never fires until the user types.
+     */
+    opened: _angular_core.OutputEmitterRef<void>;
     /** Reference to the input element */
     inputEl: _angular_core.Signal<ElementRef<HTMLInputElement> | undefined>;
     /** Template for the dropdown panel, portaled into a CDK overlay on open. */
@@ -225,8 +263,17 @@ declare class TnAutocompleteComponent<T = unknown> implements ControlValueAccess
     private onTouched;
     /** Live overlay holding the dropdown panel, or undefined when closed. */
     private overlayRef?;
+    /** Embedded view of the portaled panel — re-rendered before underfill measurement. */
+    private panelViewRef?;
     /** Subscriptions tied to the current overlay; torn down on close. */
     private overlaySubs;
+    /** Set after a loadMore emission; cleared when the options count changes. */
+    private loadMorePending;
+    /** Options count at the last effect run — length changes re-arm `loadMore`. */
+    private lastOptionsCount;
+    /** Scroll distance (px) from the panel bottom that triggers `loadMore`. */
+    private static readonly loadMoreThresholdPx;
+    constructor();
     ngOnDestroy(): void;
     writeValue(value: T | null): void;
     registerOnChange(fn: (value: T | null) => void): void;
@@ -237,6 +284,21 @@ declare class TnAutocompleteComponent<T = unknown> implements ControlValueAccess
     onBlur(): void;
     onOptionClick(option: T): void;
     onKeydown(event: KeyboardEvent): void;
+    /**
+     * `loadMore` normally fires from a scroll event, which never happens when
+     * the current page is too short to overflow the panel — pagination would
+     * dead-end with data still available. When new rows land (or the panel
+     * opens), emit once more if the panel has no scrollbar.
+     */
+    private checkUnderfill;
+    onPanelScroll(event: Event): void;
+    /**
+     * Commit the current search term as the value (allowCustomValue mode). A
+     * display match (case-insensitive, same as the requireSelection path)
+     * commits the matching option instead, so picking an existing entry by
+     * typing its full text behaves like clicking it.
+     */
+    private commitCustomValue;
     private selectOption;
     private open;
     private close;
@@ -253,7 +315,7 @@ declare class TnAutocompleteComponent<T = unknown> implements ControlValueAccess
     private detachOverlay;
     private scrollToHighlighted;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<TnAutocompleteComponent<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnAutocompleteComponent<any>, "tn-autocomplete", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "displayWith": { "alias": "displayWith"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "requireSelection": { "alias": "requireSelection"; "required": false; "isSignal": true; }; "filterFn": { "alias": "filterFn"; "required": false; "isSignal": true; }; "noResultsText": { "alias": "noResultsText"; "required": false; "isSignal": true; }; "maxResults": { "alias": "maxResults"; "required": false; "isSignal": true; }; "panelMaxHeight": { "alias": "panelMaxHeight"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; }, { "optionSelected": "optionSelected"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnAutocompleteComponent<any>, "tn-autocomplete", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "displayWith": { "alias": "displayWith"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "requireSelection": { "alias": "requireSelection"; "required": false; "isSignal": true; }; "allowCustomValue": { "alias": "allowCustomValue"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "loadingText": { "alias": "loadingText"; "required": false; "isSignal": true; }; "filterFn": { "alias": "filterFn"; "required": false; "isSignal": true; }; "noResultsText": { "alias": "noResultsText"; "required": false; "isSignal": true; }; "maxResults": { "alias": "maxResults"; "required": false; "isSignal": true; }; "panelMaxHeight": { "alias": "panelMaxHeight"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; }, { "optionSelected": "optionSelected"; "searchChange": "searchChange"; "loadMore": "loadMore"; "opened": "opened"; }, never, never, true, never>;
 }
 
 /**
@@ -426,6 +488,19 @@ declare class TnAutocompleteHarness extends ComponentHarness {
      * ```
      */
     blur(): Promise<void>;
+    /**
+     * Checks whether the dropdown panel is showing the loading row.
+     *
+     * @returns Promise resolving to true if the loading indicator is visible.
+     *
+     * @example
+     * ```typescript
+     * const ac = await loader.getHarness(TnAutocompleteHarness);
+     * await ac.focus();
+     * expect(await ac.isLoading()).toBe(true);
+     * ```
+     */
+    isLoading(): Promise<boolean>;
 }
 /**
  * A set of criteria that can be used to filter a list of `TnAutocompleteHarness` instances.