@truenas/ui-components 0.1.5 → 0.1.7

package/package.json

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

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

@@ -294,6 +294,155 @@ declare class TnIconButtonComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<TnIconButtonComponent, "tn-icon-button", never, { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; "color": { "alias": "color"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; "library": { "alias": "library"; "required": false; "isSignal": true; }; }, { "onClick": "onClick"; }, never, never, true, never>;
 }
 
+/**
+ * Harness for interacting with tn-icon-button in tests.
+ * Provides filtering by icon properties and methods for querying state and simulating interactions.
+ *
+ * @example
+ * ```typescript
+ * // Find icon button by name
+ * const closeBtn = await loader.getHarness(
+ *   TnIconButtonHarness.with({ name: 'close' })
+ * );
+ *
+ * // Click an icon button
+ * const settingsBtn = await loader.getHarness(
+ *   TnIconButtonHarness.with({ name: 'settings' })
+ * );
+ * await settingsBtn.click();
+ *
+ * // Check if disabled
+ * const deleteBtn = await loader.getHarness(
+ *   TnIconButtonHarness.with({ name: 'delete' })
+ * );
+ * expect(await deleteBtn.isDisabled()).toBe(false);
+ * ```
+ */
+declare class TnIconButtonHarness extends ComponentHarness {
+    /**
+     * The selector for the host element of a `TnIconButtonComponent` instance.
+     */
+    static hostSelector: string;
+    private button;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for an icon button
+     * with specific attributes.
+     *
+     * @param options Options for filtering which icon button instances are considered a match.
+     * @returns A `HarnessPredicate` configured with the given options.
+     *
+     * @example
+     * ```typescript
+     * // Find icon button by name
+     * const button = await loader.getHarness(
+     *   TnIconButtonHarness.with({ name: 'menu' })
+     * );
+     *
+     * // Find icon button by library
+     * const customButton = await loader.getHarness(
+     *   TnIconButtonHarness.with({ library: 'mdi' })
+     * );
+     *
+     * // Find icon button with specific size
+     * const largeButton = await loader.getHarness(
+     *   TnIconButtonHarness.with({ size: 'lg' })
+     * );
+     * ```
+     */
+    static with(options?: IconButtonHarnessFilters): HarnessPredicate<TnIconButtonHarness>;
+    /**
+     * Gets the icon name.
+     *
+     * @returns Promise resolving to the icon name.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(TnIconButtonHarness);
+     * const name = await button.getName();
+     * expect(name).toBe('settings');
+     * ```
+     */
+    getName(): Promise<string | null>;
+    /**
+     * Gets the icon library.
+     *
+     * @returns Promise resolving to the icon library.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(TnIconButtonHarness);
+     * const library = await button.getLibrary();
+     * expect(library).toBe('mdi');
+     * ```
+     */
+    getLibrary(): Promise<string | null>;
+    /**
+     * Gets the icon size.
+     *
+     * @returns Promise resolving to the icon size.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(TnIconButtonHarness);
+     * const size = await button.getSize();
+     * expect(size).toBe('lg');
+     * ```
+     */
+    getSize(): Promise<string | null>;
+    /**
+     * Gets the icon color.
+     *
+     * @returns Promise resolving to the icon color.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(TnIconButtonHarness);
+     * const color = await button.getColor();
+     * expect(color).toBe('primary');
+     * ```
+     */
+    getColor(): Promise<string | null>;
+    /**
+     * Checks whether the icon button is disabled.
+     *
+     * @returns Promise resolving to true if the button is disabled.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(
+     *   TnIconButtonHarness.with({ name: 'delete' })
+     * );
+     * expect(await button.isDisabled()).toBe(false);
+     * ```
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Clicks the icon button.
+     *
+     * @returns Promise that resolves when the click action is complete.
+     *
+     * @example
+     * ```typescript
+     * const button = await loader.getHarness(
+     *   TnIconButtonHarness.with({ name: 'close' })
+     * );
+     * await button.click();
+     * ```
+     */
+    click(): Promise<void>;
+}
+/**
+ * A set of criteria that can be used to filter a list of `TnIconButtonHarness` instances.
+ */
+interface IconButtonHarnessFilters extends BaseHarnessFilters {
+    /** Filters by icon name. */
+    name?: string;
+    /** Filters by icon library (material, mdi, custom, lucide). */
+    library?: string;
+    /** Filters by icon size (xs, sm, md, lg, xl). */
+    size?: string;
+}
+
 declare enum InputType {
     Email = "email",
     Password = "password",
@@ -768,7 +917,7 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor {
 
 /**
  * Harness for interacting with tn-icon in tests.
- * Provides filtering by icon name and library for existence checks.
+ * Provides filtering by icon name and library for existence checks, as well as click interaction.
  *
  * @example
  * ```typescript
@@ -789,6 +938,12 @@ declare class TnSelectComponent<T = unknown> implements ControlValueAccessor {
  * const hasIcon = await loader.hasHarness(
  *   TnIconHarness.with({ name: 'check' })
  * );
+ *
+ * // Click an icon
+ * const closeIcon = await loader.getHarness(
+ *   TnIconHarness.with({ name: 'close' })
+ * );
+ * await closeIcon.click();
  * ```
  */
 declare class TnIconHarness extends ComponentHarness {
@@ -874,6 +1029,18 @@ declare class TnIconHarness extends ComponentHarness {
      * ```
      */
     getColor(): Promise<string | null>;
+    /**
+     * Clicks the icon.
+     *
+     * @returns Promise that resolves when the click action is complete.
+     *
+     * @example
+     * ```typescript
+     * const icon = await loader.getHarness(TnIconHarness.with({ name: 'close' }));
+     * await icon.click();
+     * ```
+     */
+    click(): Promise<void>;
 }
 /**
  * A set of criteria that can be used to filter a list of `TnIconHarness` instances.
@@ -2880,5 +3047,5 @@ declare const TN_THEME_DEFINITIONS: readonly TnThemeDefinition[];
  */
 declare const THEME_MAP: Map<TnTheme, TnThemeDefinition>;
 
-export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_THEME_DEFINITIONS, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCellDefDirective, TnCheckboxComponent, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateRangeInputComponent, TnDialog, TnDialogShellComponent, TnDividerComponent, TnDividerDirective, TnExpansionPanelComponent, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuComponent, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnSelectComponent, TnSelectionListComponent, TnSlideToggleComponent, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabPanelComponent, TnTableColumnDirective, TnTableComponent, TnTabsComponent, TnTheme, TnThemeService, TnTimeInputComponent, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, libIconMarker, registerLucideIcons, setupLucideIntegration, tnIconMarker };
-export type { BannerHarnessFilters, ButtonHarnessFilters, CalendarCell, ChipColor, CreateFolderEvent, DateRange, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, KeyCombination, LabelType, LucideIconOptions, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, ResolvedIcon, ShortcutHandler, SlideToggleColor, SpinnerMode, SpriteConfig, TabChangeEvent, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnFlatTreeNode, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnTableDataSource, TnThemeDefinition, TooltipPosition, YearCell };
+export { CommonShortcuts, DEFAULT_THEME, DiskIconComponent, DiskType, FileSizePipe, InputType, LinuxModifierKeys, LinuxShortcuts, ModifierKeys, QuickShortcuts, ShortcutBuilder, StripMntPrefixPipe, THEME_MAP, THEME_STORAGE_KEY, TN_THEME_DEFINITIONS, TnBannerActionDirective, TnBannerComponent, TnBannerHarness, TnBrandedSpinnerComponent, TnButtonComponent, TnButtonHarness, TnButtonToggleComponent, TnButtonToggleGroupComponent, TnCalendarComponent, TnCalendarHeaderComponent, TnCardComponent, TnCellDefDirective, TnCheckboxComponent, TnChipComponent, TnConfirmDialogComponent, TnDateInputComponent, TnDateRangeInputComponent, TnDialog, TnDialogShellComponent, TnDividerComponent, TnDividerDirective, TnExpansionPanelComponent, TnFilePickerComponent, TnFilePickerPopupComponent, TnFormFieldComponent, TnHeaderCellDefDirective, TnIconButtonComponent, TnIconButtonHarness, TnIconComponent, TnIconHarness, TnIconRegistryService, TnIconTesting, TnInputComponent, TnInputDirective, TnKeyboardShortcutComponent, TnKeyboardShortcutService, TnListAvatarDirective, TnListComponent, TnListIconDirective, TnListItemComponent, TnListItemLineDirective, TnListItemPrimaryDirective, TnListItemSecondaryDirective, TnListItemTitleDirective, TnListItemTrailingDirective, TnListOptionComponent, TnListSubheaderComponent, TnMenuComponent, TnMenuTriggerDirective, TnMonthViewComponent, TnMultiYearViewComponent, TnNestedTreeNodeComponent, TnParticleProgressBarComponent, TnProgressBarComponent, TnRadioComponent, TnSelectComponent, TnSelectionListComponent, TnSlideToggleComponent, TnSliderComponent, TnSliderThumbDirective, TnSliderWithLabelDirective, TnSpinnerComponent, TnSpriteLoaderService, TnStepComponent, TnStepperComponent, TnTabComponent, TnTabPanelComponent, TnTableColumnDirective, TnTableComponent, TnTabsComponent, TnTheme, TnThemeService, TnTimeInputComponent, TnTooltipComponent, TnTooltipDirective, TnTreeComponent, TnTreeFlatDataSource, TnTreeFlattener, TnTreeNodeComponent, TnTreeNodeOutletDirective, TruncatePathPipe, WindowsModifierKeys, WindowsShortcuts, createLucideLibrary, createShortcut, defaultSpriteBasePath, defaultSpriteConfigPath, libIconMarker, registerLucideIcons, setupLucideIntegration, tnIconMarker };
+export type { BannerHarnessFilters, ButtonHarnessFilters, CalendarCell, ChipColor, CreateFolderEvent, DateRange, FilePickerCallbacks, FilePickerError, FilePickerMode, FileSystemItem, IconButtonHarnessFilters, IconHarnessFilters, IconLibrary, IconLibraryType, IconResult, IconSize, IconSource, IconTestingMockOverrides, KeyCombination, LabelType, LucideIconOptions, MockIconRegistry, MockSpriteLoader, PathSegment, PlatformType, ProgressBarMode, ResolvedIcon, ShortcutHandler, SlideToggleColor, SpinnerMode, SpriteConfig, TabChangeEvent, TnBannerType, TnButtonToggleType, TnCardAction, TnCardControl, TnCardFooterLink, TnCardHeaderStatus, TnConfirmDialogData, TnDialogDefaults, TnDialogOpenTarget, TnFlatTreeNode, TnMenuItem, TnSelectOption, TnSelectOptionGroup, TnSelectionChange, TnTableDataSource, TnThemeDefinition, TooltipPosition, YearCell };