@truenas/ui-components 0.2.4 → 0.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/ui-components",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "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.
@@ -5507,6 +5582,56 @@ declare class FileSizePipe implements PipeTransform {
     static ɵpipe: _angular_core.ɵɵPipeDeclaration<FileSizePipe, "tnFileSize", true>;
 }
 
+/**
+ * Renders lightweight label markup (**bold**, *italic*, `code`) to HTML
+ * for [innerHTML] binding. Text is HTML-escaped and only strong/em/code
+ * tags are emitted, so the output is safe by construction.
+ */
+declare class LabelMarkupPipe implements PipeTransform {
+    transform(label: string | null | undefined): string;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<LabelMarkupPipe, never>;
+    static ɵpipe: _angular_core.ɵɵPipeDeclaration<LabelMarkupPipe, "tnLabelMarkup", true>;
+}
+
+/**
+ * Strips lightweight label markup (**bold**, *italic*, `code`), returning
+ * plain text for attribute contexts such as aria-label and title.
+ */
+declare class LabelTextPipe implements PipeTransform {
+    transform(label: string | null | undefined): string;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<LabelTextPipe, never>;
+    static ɵpipe: _angular_core.ɵɵPipeDeclaration<LabelTextPipe, "tnLabelText", true>;
+}
+
+type LabelMarkupSegmentType = 'text' | 'strong' | 'em' | 'code';
+interface LabelMarkupSegment {
+    type: LabelMarkupSegmentType;
+    text: string;
+}
+/**
+ * Parses a label string with lightweight markup into flat segments.
+ *
+ * Supported syntax:
+ * - `**bold**` → strong segment
+ * - `*italic*` → em segment
+ * - `` `code` `` → code segment (content taken verbatim)
+ * - `\*`, `` \` ``, `\\` → literal character
+ *
+ * Markup does not nest. Unmatched or whitespace-adjacent markers render
+ * as literal text, so a malformed translation can never break rendering.
+ */
+declare function parseLabelMarkup(value: string): LabelMarkupSegment[];
+/**
+ * Renders label markup to an HTML string safe for [innerHTML] binding:
+ * all text is HTML-escaped and only <strong>, <em> and <code> are emitted.
+ */
+declare function labelMarkupToHtml(value: string): string;
+/**
+ * Strips label markup, returning plain text for contexts where HTML is not
+ * rendered (aria-label, title attributes, tooltips).
+ */
+declare function labelMarkupToText(value: string): string;
+
 declare class StripMntPrefixPipe implements PipeTransform {
     transform(path: string | null | undefined): string;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<StripMntPrefixPipe, never>;
@@ -7668,5 +7793,5 @@ declare const TN_THEME_DEFINITIONS: readonly TnThemeDefinition[];
  */
 declare const THEME_MAP: Map<TnTheme, TnThemeDefinition>;
 
-export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LIGHT_THEME, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_FORM_FIELD_ERRORS, TN_TABLE_PAGER_DEFAULT_LABELS, TN_TABLE_PAGER_LABELS, TN_TEST_ATTR, TN_THEME_DEFINITIONS, TnAutocompleteComponent, TnAutocompleteHarness, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnButtonToggleGroupHarness, TnButtonToggleHarness, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCardHeaderDirective, TnCellDefDirective, TnCheckboxComponent, TnCheckboxHarness, TnCheckboxLabelDirective, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateInputHarness, TnDateRangeInputComponent, TnDateRangeInputHarness, TnDetailRowDefDirective, TnDialog, TnDialogHarness, TnDialogShellComponent, TnDialogTesting, TnDividerComponent, TnDividerDirective, TnDrawerComponent, TnDrawerContainerComponent, TnDrawerContainerHarness, TnDrawerContentComponent, TnDrawerHarness, TnEmptyComponent, TnEmptyHarness, TnExpansionPanelComponent, TnExpansionPanelHarness, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnFormFieldHarness, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconButtonHarness, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnInputHarness, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuActivateHoverDirective, TnMenuComponent, TnMenuHarness, TnMenuItemComponent, TnMenuTesting, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnRadioHarness, TnSelectComponent, TnSelectHarness, TnSelectionListComponent, TnSidePanelActionDirective, TnSidePanelComponent, TnSidePanelHarness, TnSidePanelHeaderActionDirective, TnSlideToggleComponent, TnSlideToggleHarness, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabHarness, TnTabPanelComponent, TnTabPanelHarness, TnTableColumnDirective, TnTableComponent, TnTableHarness, TnTablePagerComponent, TnTablePagerHarness, TnTabsComponent, TnTabsHarness, TnTestIdDirective, TnTheme, TnThemeService, TnTimeInputComponent, TnToastComponent, TnToastMock, TnToastPosition, TnToastRef, TnToastService, TnToastTesting, TnToastType, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, composeTestId, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, formatSize, kebabTestSegment, libIconMarker, parseSize, registerLucideIcons, scopeTestId, setupLucideIntegration, tnIconMarker, writeTestId };
-export type { AutocompleteHarnessFilters, BannerHarnessFilters, ButtonHarnessFilters, ButtonToggleHarnessFilters, CalendarCell, CheckboxHarnessFilters, ChipColor, CreateFolderEvent, DateInputHarnessFilters, DateRange, DateRangeInputHarnessFilters, DialogHarnessFilters, EmptyHarnessFilters, ExpansionPanelHarnessFilters, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, FormFieldHarnessFilters, IconButtonHarnessFilters, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, InputHarnessFilters, KeyCombination, LabelType, LucideIconOptions, MenuHarnessFilters, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, RadioHarnessFilters, ResolvedIcon, SelectHarnessFilters, ShortcutHandler, SidePanelHarnessFilters, SizeStandard, SlideToggleColor, SlideToggleHarnessFilters, SpinnerMode, SpriteConfig, SubscriptSizing, TabChangeEvent, TabHarnessFilters, TabPanelHarnessFilters, TabsHarnessFilters, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnDrawerMode, TnDrawerPosition, TnEmptySize, TnFlatTreeNode, TnFormFieldErrorMessage, TnFormFieldErrorMessages, TnFormFieldErrorResolver, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnSortEvent, TnTableDataProvider, TnTableDataSource, TnTableHarnessFilters, TnTablePagerHarnessFilters, TnTablePagerLabels, TnTablePagination, TnTestAttrName, TnTestIdValue, TnThemeDefinition, TnToastCall, TnToastConfig, TooltipPosition, YearCell };
+export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LIGHT_THEME, LabelMarkupPipe, LabelTextPipe, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_FORM_FIELD_ERRORS, TN_TABLE_PAGER_DEFAULT_LABELS, TN_TABLE_PAGER_LABELS, TN_TEST_ATTR, TN_THEME_DEFINITIONS, TnAutocompleteComponent, TnAutocompleteHarness, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnButtonToggleGroupHarness, TnButtonToggleHarness, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCardHeaderDirective, TnCellDefDirective, TnCheckboxComponent, TnCheckboxHarness, TnCheckboxLabelDirective, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateInputHarness, TnDateRangeInputComponent, TnDateRangeInputHarness, TnDetailRowDefDirective, TnDialog, TnDialogHarness, TnDialogShellComponent, TnDialogTesting, TnDividerComponent, TnDividerDirective, TnDrawerComponent, TnDrawerContainerComponent, TnDrawerContainerHarness, TnDrawerContentComponent, TnDrawerHarness, TnEmptyComponent, TnEmptyHarness, TnExpansionPanelComponent, TnExpansionPanelHarness, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnFormFieldHarness, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconButtonHarness, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnInputHarness, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuActivateHoverDirective, TnMenuComponent, TnMenuHarness, TnMenuItemComponent, TnMenuTesting, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnRadioHarness, TnSelectComponent, TnSelectHarness, TnSelectionListComponent, TnSidePanelActionDirective, TnSidePanelComponent, TnSidePanelHarness, TnSidePanelHeaderActionDirective, TnSlideToggleComponent, TnSlideToggleHarness, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabHarness, TnTabPanelComponent, TnTabPanelHarness, TnTableColumnDirective, TnTableComponent, TnTableHarness, TnTablePagerComponent, TnTablePagerHarness, TnTabsComponent, TnTabsHarness, TnTestIdDirective, TnTheme, TnThemeService, TnTimeInputComponent, TnToastComponent, TnToastMock, TnToastPosition, TnToastRef, TnToastService, TnToastTesting, TnToastType, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, composeTestId, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, formatSize, kebabTestSegment, labelMarkupToHtml, labelMarkupToText, libIconMarker, parseLabelMarkup, parseSize, registerLucideIcons, scopeTestId, setupLucideIntegration, tnIconMarker, writeTestId };
+export type { AutocompleteHarnessFilters, BannerHarnessFilters, ButtonHarnessFilters, ButtonToggleHarnessFilters, CalendarCell, CheckboxHarnessFilters, ChipColor, CreateFolderEvent, DateInputHarnessFilters, DateRange, DateRangeInputHarnessFilters, DialogHarnessFilters, EmptyHarnessFilters, ExpansionPanelHarnessFilters, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, FormFieldHarnessFilters, IconButtonHarnessFilters, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, InputHarnessFilters, KeyCombination, LabelMarkupSegment, LabelMarkupSegmentType, LabelType, LucideIconOptions, MenuHarnessFilters, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, RadioHarnessFilters, ResolvedIcon, SelectHarnessFilters, ShortcutHandler, SidePanelHarnessFilters, SizeStandard, SlideToggleColor, SlideToggleHarnessFilters, SpinnerMode, SpriteConfig, SubscriptSizing, TabChangeEvent, TabHarnessFilters, TabPanelHarnessFilters, TabsHarnessFilters, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnDrawerMode, TnDrawerPosition, TnEmptySize, TnFlatTreeNode, TnFormFieldErrorMessage, TnFormFieldErrorMessages, TnFormFieldErrorResolver, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnSortEvent, TnTableDataProvider, TnTableDataSource, TnTableHarnessFilters, TnTablePagerHarnessFilters, TnTablePagerLabels, TnTablePagination, TnTestAttrName, TnTestIdValue, TnThemeDefinition, TnToastCall, TnToastConfig, TooltipPosition, YearCell };