@skyux/lists 12.27.0 → 13.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lists",
-  "version": "12.27.0",
+  "version": "13.0.0-alpha.1",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -16,20 +16,20 @@
   },
   "homepage": "https://github.com/blackbaud/skyux#readme",
   "peerDependencies": {
-    "@angular/cdk": "^19.2.19",
-    "@angular/common": "^19.2.14",
-    "@angular/core": "^19.2.14",
-    "@angular/platform-browser": "^19.2.14",
-    "@skyux-sdk/testing": "12.27.0",
-    "@skyux/animations": "12.27.0",
-    "@skyux/core": "12.27.0",
-    "@skyux/forms": "12.27.0",
-    "@skyux/i18n": "12.27.0",
-    "@skyux/icon": "12.27.0",
-    "@skyux/indicators": "12.27.0",
-    "@skyux/inline-form": "12.27.0",
-    "@skyux/popovers": "12.27.0",
-    "@skyux/theme": "12.27.0"
+    "@angular/cdk": "^20.0.4",
+    "@angular/common": "^20.0.5",
+    "@angular/core": "^20.0.5",
+    "@angular/platform-browser": "^20.0.5",
+    "@skyux-sdk/testing": "13.0.0-alpha.1",
+    "@skyux/animations": "13.0.0-alpha.1",
+    "@skyux/core": "13.0.0-alpha.1",
+    "@skyux/forms": "13.0.0-alpha.1",
+    "@skyux/i18n": "13.0.0-alpha.1",
+    "@skyux/icon": "13.0.0-alpha.1",
+    "@skyux/indicators": "13.0.0-alpha.1",
+    "@skyux/inline-form": "13.0.0-alpha.1",
+    "@skyux/popovers": "13.0.0-alpha.1",
+    "@skyux/theme": "13.0.0-alpha.1"
   },
   "dependencies": {
     "@types/dragula": "2.1.36",

package/testing/index.d.ts

@@ -1,5 +1,642 @@
+import { ComponentFixture } from '@angular/core/testing';
+import * as i0 from '@angular/core';
+import * as i1 from '@skyux/lists';
+import { HarnessPredicate, BaseHarnessFilters } from '@angular/cdk/testing';
+import { SkyHarnessFilters, SkyComponentHarness, SkyQueryableComponentHarness } from '@skyux/core/testing';
+import * as i1$1 from '@angular/platform-browser/animations';
+import { SkyDropdownItemHarness } from '@skyux/popovers/testing';
+
+type SkyListsFilterFixtureButton = {
+    ariaControls: string | undefined;
+    ariaExpanded: boolean;
+    disabled: boolean;
+    id: string | undefined;
+};
+
 /**
- * Generated bundle index. Do not edit.
+ * Provides information for and interaction with a SKY UX filter button component.
+ * By using the fixture API, a test insulates itself against updates to the internals
+ * of a component, such as changing its DOM structure.
+ * @internal
  */
-/// <amd-module name="@skyux/lists/testing" />
-export * from './public-api';
+declare class SkyFilterFixtureButton {
+    #private;
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
+    /**
+     * Click the button to apply the filter.
+     */
+    clickFilterButton(): Promise<void>;
+    get button(): SkyListsFilterFixtureButton;
+    /**
+     * Get the button text.
+     */
+    get buttonText(): string;
+}
+
+/**
+ * Provides information for and interaction with a SKY UX filter summary component.
+ * By using the fixture API, a test insulates itself against updates to the internals
+ * of a component, such as changing its DOM structure.
+ * @internal
+ */
+declare class SkyFilterFixtureSummary {
+    #private;
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
+    filterCloseClick(index: number): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+declare class SkyFilterTestingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyFilterTestingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyFilterTestingModule, never, never, [typeof i1.SkyFilterModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SkyFilterTestingModule>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyFilterButtonHarness` instances.
+ */
+interface SkyFilterButtonHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness for interacting with a filter button component in tests.
+ */
+declare class SkyFilterButtonHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterButtonHarness` that meets certain criteria.
+     */
+    static with(filters: SkyFilterButtonHarnessFilters): HarnessPredicate<SkyFilterButtonHarness>;
+    /**
+     * Clicks the filter button.
+     */
+    clickFilterButton(): Promise<void>;
+    /**
+     * Gets the filter button's aria-controls attribute.
+     */
+    getAriaControls(): Promise<string | null>;
+    /**
+     * Gets the filter button's aria-expanded attribute.
+     */
+    getAriaExpanded(): Promise<boolean>;
+    /**
+     * Gets the filter button's aria-label.
+     */
+    getAriaLabel(): Promise<string | null>;
+    /**
+     * Gets the filter button's id.
+     */
+    getButtonId(): Promise<string | null>;
+    /**
+     * Gets the text that appears on the filter button.
+     */
+    getButtonText(): Promise<string>;
+    /**
+     * Whether the filter button is active.
+     */
+    isActive(): Promise<boolean>;
+    /**
+     * Whether the filter button is disabled.
+     */
+    isDisabled(): Promise<boolean>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyFilterInlineHarness` instances.
+ */
+interface SkyFilterInlineHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyFilterInlineItemHarness` instances.
+ */
+interface SkyFilterInlineItemHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness to interact with a filter inline item component in tests.
+ */
+declare class SkyFilterInlineItemHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterInlineItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyFilterInlineItemHarnessFilters): HarnessPredicate<SkyFilterInlineItemHarness>;
+}
+
+/**
+ * Harness to interact with a filter inline component in tests.
+ */
+declare class SkyFilterInlineHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterInlineHarness` that meets certain criteria.
+     */
+    static with(filters: SkyFilterInlineHarnessFilters): HarnessPredicate<SkyFilterInlineHarness>;
+    /**
+     * Gets a harness for a specific toolbar item that meets certain criteria.
+     */
+    getItem(filter: SkyFilterInlineItemHarnessFilters): Promise<SkyFilterInlineItemHarness>;
+    /**
+     * Gets an array of all toolbar items.
+     */
+    getItems(filters?: SkyFilterInlineItemHarnessFilters): Promise<SkyFilterInlineItemHarness[]>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyFilterSummaryHarness` instances.
+ */
+interface SkyFilterSummaryHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyFilterSummaryItemHarness` instances.
+ */
+interface SkyFilterSummaryItemHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness to interact with a filter summary item component in tests.
+ */
+declare class SkyFilterSummaryItemHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterSummaryItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyFilterSummaryItemHarnessFilters): HarnessPredicate<SkyFilterSummaryItemHarness>;
+    /**
+     * Clicks the filter summary item.
+     */
+    clickItem(): Promise<void>;
+    /**
+     * Dismisses the filter summary item.
+     */
+    dismiss(): Promise<void>;
+    /**
+     * Whether the filter summary item is dismissible.
+     */
+    isDismissible(): Promise<boolean>;
+}
+
+/**
+ * Harness to interact with a filter summary component in tests.
+ */
+declare class SkyFilterSummaryHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyFilterSummaryHarness` that meets certain criteria.
+     */
+    static with(filters: SkyFilterSummaryHarnessFilters): HarnessPredicate<SkyFilterSummaryHarness>;
+    /**
+     * Gets a harness for a specific toolbar item that meets certain criteria.
+     */
+    getItem(filter: SkyFilterSummaryItemHarnessFilters): Promise<SkyFilterSummaryItemHarness>;
+    /**
+     * Gets an array of all toolbar items.
+     */
+    getItems(filters?: SkyFilterSummaryItemHarnessFilters): Promise<SkyFilterSummaryItemHarness[]>;
+}
+
+/**
+ * @internal
+ */
+interface SkyPagingFixtureButton {
+    id: string;
+    isActive: boolean;
+    isEnabled: boolean;
+}
+
+/**
+ * Provides information for and interaction with a SKY UX paging component.
+ * By using the fixture API, a test insulates itself against updates to the internals
+ * of a component, such as changing its DOM structure.
+ * @internal
+ */
+declare class SkyPagingFixture {
+    #private;
+    /**
+     * The id of the active page, if available.
+     */
+    get activePageId(): string;
+    /**
+     * Properties of the page links displayed in the paging component.
+     */
+    get pageLinks(): SkyPagingFixtureButton[];
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
+    /**
+     * Selects the specified page by id, if it is enabled.
+     */
+    selectPage(id: string | number): Promise<void>;
+    /**
+     * Clicks the next page button, if it is enabled.
+     */
+    selectNextPage(): Promise<void>;
+    /**
+     * Clicks the previous page button, if it is enabled.
+     */
+    selectPreviousPage(): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+declare class SkyPagingTestingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyPagingTestingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyPagingTestingModule, never, never, [typeof i1.SkyPagingModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SkyPagingTestingModule>;
+}
+
+/**
+ * Harness to interact with a paging content component in tests.
+ */
+declare class SkyPagingContentHarness extends SkyQueryableComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyPagingHarness` instances.
+ */
+interface SkyPagingHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness for interacting with a paging component in tests.
+ */
+declare class SkyPagingHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyPagingHarness` that meets certain criteria.
+     */
+    static with(filters: SkyPagingHarnessFilters): HarnessPredicate<SkyPagingHarness>;
+    /**
+     * Clicks the next button.
+     */
+    clickNextButton(): Promise<void>;
+    /**
+     * Clicks the page button with the requested number. Throws an error if that button is not present.
+     */
+    clickPageButton(pageNumber: number): Promise<void>;
+    /**
+     * Clicks the previous button.
+     */
+    clickPreviousButton(): Promise<void>;
+    /**
+     * Gets the current page number.
+     */
+    getCurrentPage(): Promise<number>;
+    /**
+     * Gets the paging content.
+     */
+    getPagingContent(): Promise<SkyPagingContentHarness>;
+    getPagingLabel(): Promise<string>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyRepeaterHarness` instances.
+ */
+interface SkyRepeaterHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyRepeaterItemHarness` instances.
+ */
+interface SkyRepeaterItemHarnessFilters extends SkyHarnessFilters {
+    /**
+     * Only find instances whose content matches the given value.
+     */
+    contentText?: string | RegExp;
+    /**
+     * Only find instances whose title matches the given value.
+     */
+    titleText?: string | RegExp;
+}
+
+/**
+ * Harness for interacting with a repeater item component in tests.
+ */
+declare class SkyRepeaterItemHarness extends SkyQueryableComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyRepeaterItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkyRepeaterItemHarnessFilters): HarnessPredicate<SkyRepeaterItemHarness>;
+    /**
+     * Clicks on the repeater item.
+     */
+    click(): Promise<void>;
+    /**
+     * Whether the repeater item is selectable.
+     */
+    isSelectable(): Promise<boolean>;
+    /**
+     * Whether the repeater item is selected.
+     */
+    isSelected(): Promise<boolean>;
+    /**
+     * Selects the repeater item.
+     */
+    select(): Promise<void>;
+    /**
+     * Deselects the repeater item.
+     */
+    deselect(): Promise<void>;
+    /**
+     * Gets the text of the repeater item content.
+     */
+    getContentText(): Promise<string>;
+    /**
+     * Gets the text of the repeater item title.
+     */
+    getTitleText(): Promise<string>;
+    /**
+     * Whether the repeater item is collapsible.
+     */
+    isCollapsible(): Promise<boolean>;
+    /**
+     * Whether the repeater item is expanded, or throws an error informing of the lack of collapsibility.
+     */
+    isExpanded(): Promise<boolean>;
+    /**
+     * Expands the repeater item, or does nothing if already expanded.
+     */
+    expand(): Promise<void>;
+    /**
+     * Collapses the repeater item, or does nothing if already collapsed.
+     */
+    collapse(): Promise<void>;
+    /**
+     * Whether the repeater item is reorderable.
+     */
+    isReorderable(): Promise<boolean>;
+    /**
+     * Moves the repeater item to the top of the list
+     */
+    sendToTop(): Promise<void>;
+}
+
+/**
+ * Harness for interacting with a repeater component in tests.
+ */
+declare class SkyRepeaterHarness extends SkyComponentHarness {
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyRepeaterHarness` that meets certain criteria.
+     */
+    static with(filters: SkyRepeaterHarnessFilters): HarnessPredicate<SkyRepeaterHarness>;
+    /**
+     * Gets a list of child repeater items.
+     */
+    getRepeaterItems(filters?: SkyRepeaterItemHarnessFilters): Promise<SkyRepeaterItemHarness[]>;
+}
+
+/**
+ * @internal
+ */
+interface SkySortFixtureMenu {
+    buttonText: string;
+    isOpen: boolean;
+}
+
+/**
+ * @internal
+ */
+interface SkySortFixtureMenuItem {
+    index: number;
+    isActive: boolean;
+    text?: string;
+}
+
+/**
+ * Provides information for and interaction with a SKY UX sort component.
+ * By using the fixture API, a test insulates itself against updates to the internals
+ * of a component, such as changing its DOM structure.
+ * @internal
+ */
+declare class SkySortFixture {
+    #private;
+    /**
+     * The active sort menu item, if one exists. Menu items are only available when the menu dropdown
+     * is open. If the menu dropdown is closed, this property will be undefined.
+     */
+    get activeMenuItem(): SkySortFixtureMenuItem | undefined;
+    /**
+     * The sort menu's properties.
+     */
+    get menu(): SkySortFixtureMenu;
+    /**
+     * The properties of each sort menu item. Menu items are only available when the menu dropdown
+     * is open. If the menu dropdown is closed, this property will be undefined.
+     */
+    get menuItems(): SkySortFixtureMenuItem[] | undefined;
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
+    /**
+     * Closes the sort dropdown menu if it isn't closed already.
+     */
+    closeMenu(): Promise<void>;
+    /**
+     * Opens the sort dropdown menu if it isn't open already.
+     */
+    openMenu(): Promise<void>;
+    /**
+     * Ensures the sort menu is open and selects the menu item with the specified index, if it exists.
+     * @param menuItemIndex The index of the menu item to select.
+     */
+    selectMenuItemByIndex(menuItemIndex: number): Promise<void>;
+    /**
+     * Ensures the sort menu is open and selects the menu item with the specified text,
+     * if a matching item is available.
+     * @param menuItemText The text of the menu item to select.
+     */
+    selectMenuItemByText(menuItemText: string | undefined): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+declare class SkySortTestingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkySortTestingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkySortTestingModule, never, [typeof i1$1.NoopAnimationsModule], [typeof i1.SkySortModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SkySortTestingModule>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkySortHarness` instances.
+ */
+interface SkySortHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkySortItemHarness` instances.
+ */
+interface SkySortItemHarnessFilters extends BaseHarnessFilters {
+    /**
+     * Only find instances whose text content matches the given value.
+     */
+    text?: string;
+}
+
+/**
+ * Harness for interacting with a sort item component in tests.
+ */
+declare class SkySortItemHarness extends SkyDropdownItemHarness {
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkySortItemHarness` that meets certain criteria.
+     */
+    static with(filters: SkySortItemHarnessFilters): HarnessPredicate<SkySortItemHarness>;
+    /**
+     * Clicks the sort item.
+     */
+    click(): Promise<void>;
+    /**
+     * Gets the sort item role.
+     * This can't be set on sort items and should not be exposed.
+     * @internal
+     */
+    getAriaRole(): Promise<string | null>;
+    /**
+     * Gets the sort item text.
+     */
+    getText(): Promise<string | null>;
+    /**
+     * Whether the sort item is active.
+     */
+    isActive(): Promise<boolean>;
+}
+
+/**
+ * Harness for interacting with a sort component in tests.
+ */
+declare class SkySortHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkySortHarness` that meets certain criteria.
+     */
+    static with(filters: SkySortHarnessFilters): HarnessPredicate<SkySortHarness>;
+    /**
+     * Clicks the sort component.
+     */
+    click(): Promise<void>;
+    /**
+     * Gets the aria-label value.
+     */
+    getAriaLabel(): Promise<string | null>;
+    /**
+     * Gets the text that appears on the sort button.
+     */
+    getButtonText(): Promise<string>;
+    /**
+     * Gets a harness for a specific sort item that meets certain criteria.
+     */
+    getItem(filters: SkySortItemHarnessFilters): Promise<SkySortItemHarness>;
+    /**
+     * Gets an array of all sort items.
+     */
+    getItems(filters?: SkySortItemHarnessFilters): Promise<SkySortItemHarness[]>;
+}
+
+/**
+ * Provides information for and interaction with a SKY UX infinite scroll component.
+ * By using the fixture API, a test insulates itself against updates to the internals
+ * of a component, such as changing its DOM structure.
+ * @deprecated Use `SkyInfiniteScrollHarness` instead.
+ * @internal
+ */
+declare class SkyInfiniteScrollFixture {
+    #private;
+    constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
+    get loadMoreButtonIsVisible(): boolean;
+    clickLoadMoreButton(): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+declare class SkyInfiniteScrollTestingModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyInfiniteScrollTestingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyInfiniteScrollTestingModule, never, never, [typeof i1.SkyInfiniteScrollModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SkyInfiniteScrollTestingModule>;
+}
+
+/**
+ * A set of criteria that can be used to filter a list of `SkyInfiniteScrollHarness` instances.
+ */
+interface SkyInfiniteScrollHarnessFilters extends SkyHarnessFilters {
+}
+
+/**
+ * Harness for interacting with an infinite scroll component in tests.
+ */
+declare class SkyInfiniteScrollHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyInfiniteScrollHarness` that meets certain criteria.
+     */
+    static with(filters: SkyInfiniteScrollHarnessFilters): HarnessPredicate<SkyInfiniteScrollHarness>;
+    /**
+     * Whether the infinite scroll is enabled.
+     */
+    isEnabled(): Promise<boolean>;
+    /**
+     * Whether the infinite scroll is loading.
+     */
+    isLoading(): Promise<boolean>;
+    /**
+     * Clicks the "Load more" button.
+     */
+    loadMore(): Promise<void>;
+}
+
+export { SkyFilterButtonHarness, SkyFilterFixtureButton, SkyFilterFixtureSummary, SkyFilterInlineHarness, SkyFilterInlineItemHarness, SkyFilterSummaryHarness, SkyFilterSummaryItemHarness, SkyFilterTestingModule, SkyInfiniteScrollFixture, SkyInfiniteScrollHarness, SkyInfiniteScrollTestingModule, SkyPagingContentHarness, SkyPagingFixture, SkyPagingHarness, SkyPagingTestingModule, SkyRepeaterHarness, SkyRepeaterItemHarness, SkySortFixture, SkySortHarness, SkySortItemHarness, SkySortTestingModule };
+export type { SkyFilterButtonHarnessFilters, SkyFilterInlineHarnessFilters, SkyFilterInlineItemHarnessFilters, SkyFilterSummaryHarnessFilters, SkyFilterSummaryItemHarnessFilters, SkyInfiniteScrollHarnessFilters, SkyPagingFixtureButton, SkyPagingHarnessFilters, SkyRepeaterHarnessFilters, SkyRepeaterItemHarnessFilters, SkySortFixtureMenu, SkySortFixtureMenuItem, SkySortHarnessFilters, SkySortItemHarnessFilters };