@skyux/lookup 6.11.2 → 6.14.0

package/index.d.ts

@@ -19,6 +19,8 @@ export * from './lib/modules/lookup/types/lookup-show-more-config';
 export * from './lib/modules/lookup/types/lookup-show-more-custom-picker';
 export * from './lib/modules/lookup/types/lookup-show-more-custom-picker-context';
 export * from './lib/modules/lookup/types/lookup-show-more-native-picker-config';
+export * from './lib/modules/autocomplete/types/autocomplete-search-args';
+export * from './lib/modules/autocomplete/types/autocomplete-search-context';
 export * from './lib/modules/search/search.module';
 export * from './lib/modules/search/search.component';
 export { SkyAutocompleteInputDirective as λ1 } from './lib/modules/autocomplete/autocomplete-input.directive';

package/lib/modules/autocomplete/autocomplete-input.directive.d.ts

@@ -37,6 +37,7 @@ export declare class SkyAutocompleteInputDirective implements OnInit, OnDestroy,
     setDisabledState(disabled: boolean): void;
     validate(control: AbstractControl): ValidationErrors | null;
     setActiveDescendant(descendantId: string | null): void;
+    setAriaOwns(overlayId: string | null): void;
     onChange(value: any): void;
     onTouched(): void;
     onValidatorChange: () => void;

package/lib/modules/autocomplete/types/autocomplete-search-args.d.ts

@@ -0,0 +1,4 @@
+import { SkyAutocompleteSearchContext } from './autocomplete-search-context';
+export declare type SkyAutocompleteSearchArgs = {
+    context?: SkyAutocompleteSearchContext;
+};

package/lib/modules/autocomplete/types/autocomplete-search-context.d.ts

@@ -0,0 +1 @@
+export declare type SkyAutocompleteSearchContext = 'popover' | 'modal';

package/lib/modules/autocomplete/types/autocomplete-search-function-filter.d.ts

@@ -1 +1,2 @@
-export declare type SkyAutocompleteSearchFunctionFilter = (searchText: string, item: any) => boolean;
+import { SkyAutocompleteSearchArgs } from './autocomplete-search-args';
+export declare type SkyAutocompleteSearchFunctionFilter = (searchText: string, item: any, args?: SkyAutocompleteSearchArgs) => boolean;

package/lib/modules/autocomplete/types/autocomplete-search-function.d.ts

@@ -1,2 +1,3 @@
+import { SkyAutocompleteSearchArgs } from './autocomplete-search-args';
 import { SkyAutocompleteSearchFunctionResponse } from './autocomplete-search-function-response';
-export declare type SkyAutocompleteSearchFunction = (searchText: string, data: any[]) => SkyAutocompleteSearchFunctionResponse;
+export declare type SkyAutocompleteSearchFunction = (searchText: string, data: any[], args?: SkyAutocompleteSearchArgs) => SkyAutocompleteSearchFunctionResponse;

package/lib/modules/lookup/lookup-show-more-async-modal.component.d.ts

@@ -1,4 +1,5 @@
 import { ChangeDetectorRef, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import { SkyLogService } from '@skyux/core';
 import { SkyModalInstance } from '@skyux/modals';
 import { Subject } from 'rxjs';
 import { SkyLookupShowMoreNativePickerAsyncContext } from './types/lookup-show-more-native-picker-async-context';
@@ -25,7 +26,7 @@ export declare class SkyLookupShowMoreAsyncModalComponent implements OnInit, OnD
     repeaterItemTemplate: TemplateRef<unknown> | null;
     searchText: string | undefined;
     selectedIdMap: Map<unknown, unknown>;
-    constructor(modalInstance: SkyModalInstance, context: SkyLookupShowMoreNativePickerAsyncContext, changeDetector: ChangeDetectorRef);
+    constructor(modalInstance: SkyModalInstance, context: SkyLookupShowMoreNativePickerAsyncContext, changeDetector: ChangeDetectorRef, logSvc: SkyLogService);
     ngOnInit(): void;
     ngOnDestroy(): void;
     addButtonClicked(): void;

package/lib/modules/lookup/lookup.component.d.ts

@@ -62,6 +62,7 @@ export declare class SkyLookupComponent extends SkyLookupAutocompleteAdapter imp
     /**
      * Specifies an object property that represents the object's unique identifier.
      * Specifying this property enables token animations and more efficient rendering.
+     * This property is required when using `enableShowMore` and `searchAsync` together.
      */
     idProperty: string | undefined;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lookup",
-  "version": "6.11.2",
+  "version": "6.14.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -41,19 +41,20 @@
   },
   "peerDependencies": {
     "@angular/animations": "^13.3.2",
+    "@angular/cdk": "^13.3.2",
     "@angular/common": "^13.3.2",
     "@angular/core": "^13.3.2",
     "@angular/forms": "^13.3.2",
     "@angular/platform-browser": "^13.3.2",
-    "@skyux-sdk/testing": "6.11.2",
-    "@skyux/core": "6.11.2",
-    "@skyux/forms": "6.11.2",
-    "@skyux/i18n": "6.11.2",
-    "@skyux/indicators": "6.11.2",
-    "@skyux/layout": "6.11.2",
-    "@skyux/lists": "6.11.2",
-    "@skyux/modals": "6.11.2",
-    "@skyux/theme": "6.11.2"
+    "@skyux-sdk/testing": "6.14.0",
+    "@skyux/core": "6.14.0",
+    "@skyux/forms": "6.14.0",
+    "@skyux/i18n": "6.14.0",
+    "@skyux/indicators": "6.14.0",
+    "@skyux/layout": "6.14.0",
+    "@skyux/lists": "6.14.0",
+    "@skyux/modals": "6.14.0",
+    "@skyux/theme": "6.14.0"
   },
   "dependencies": {
     "intl-tel-input": "17.0.16",

package/testing/autocomplete/autocomplete-harness-filters.d.ts

@@ -0,0 +1,6 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of SkyAutocompleteHarness instances.
+ */
+export interface SkyAutocompleteHarnessFilters extends SkyHarnessFilters {
+}

package/testing/autocomplete/autocomplete-harness.d.ts

@@ -0,0 +1,79 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyAutocompleteHarnessFilters } from './autocomplete-harness-filters';
+import { SkyAutocompleteSearchResultHarness } from './autocomplete-search-result-harness';
+import { SkyAutocompleteSearchResultHarnessFilters } from './autocomplete-search-result-harness-filters';
+/**
+ * Harness for interacting with an autocomplete component in tests.
+ */
+export declare class SkyAutocompleteHarness extends SkyComponentHarness {
+    #private;
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyAutocompleteHarness` that meets certain criteria.
+     */
+    static with(filters: SkyAutocompleteHarnessFilters): HarnessPredicate<SkyAutocompleteHarness>;
+    /**
+     * Blurs the autocomplete input.
+     */
+    blur(): Promise<void>;
+    /**
+     * Clears the input value.
+     */
+    clear(): Promise<void>;
+    /**
+     * Enters text into the autocomplete input.
+     */
+    enterText(value: string): Promise<void>;
+    /**
+     * Focuses the autocomplete input.
+     */
+    focus(): Promise<void>;
+    /**
+     * Returns search result harnesses.
+     */
+    getSearchResults(filters?: SkyAutocompleteSearchResultHarnessFilters): Promise<SkyAutocompleteSearchResultHarness[]>;
+    /**
+     * Returns the text content for each search result.
+     */
+    getSearchResultsText(filters?: SkyAutocompleteSearchResultHarnessFilters): Promise<string[]>;
+    /**
+     * Gets the value of the autocomplete input.
+     */
+    getValue(): Promise<string>;
+    /**
+     * Whether the autocomplete input is disabled.
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Whether the autocomplete input is focused.
+     */
+    isFocused(): Promise<boolean>;
+    /**
+     * Whether the autocomplete is open.
+     */
+    isOpen(): Promise<boolean>;
+    /**
+     * Selects a search result.
+     */
+    selectSearchResult(filters: SkyAutocompleteSearchResultHarnessFilters): Promise<void>;
+    /**
+     * Clicks the "Add" button in the autocomplete search results panel.
+     * (The "Add" functionality is not included in the public API
+     * of a "vanilla" autocomplete component, so this method is protected
+     * to prevent consumers of the autocomplete harness from calling it.
+     * The lookup harness, which extends the autocomplete harness, may
+     * still access this feature, however.)
+     */
+    protected clickAddButton(): Promise<void>;
+    /**
+     * Clicks the "Show more" button.
+     * (The "Show more" functionality is not included in the public API
+     * of a "vanilla" autocomplete component, so this method is protected
+     * to prevent consumers of the autocomplete harness from calling it.
+     * The lookup harness, which extends the autocomplete harness, may
+     * still access this feature, however.)
+     */
+    protected clickShowMoreButton(): Promise<void>;
+}

package/testing/autocomplete/autocomplete-input-harness.d.ts

@@ -0,0 +1,39 @@
+import { ComponentHarness } from '@angular/cdk/testing';
+/**
+ * @internal
+ */
+export declare class SkyAutocompleteInputHarness extends ComponentHarness {
+    static hostSelector: string;
+    /**
+     * Blurs the input.
+     */
+    blur(): Promise<void>;
+    /**
+     * Clears the input value.
+     */
+    clear(): Promise<void>;
+    /**
+     * Enters text into the input.
+     */
+    enterText(value: string): Promise<void>;
+    /**
+     * Focuses the input.
+     */
+    focus(): Promise<void>;
+    /**
+     * Gets the value of the input.
+     */
+    getValue(): Promise<string>;
+    /**
+     * Whether the input is disabled.
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Whether the input is focused.
+     */
+    isFocused(): Promise<boolean>;
+    /**
+     * Returns the value of the input's `aria-owns` attribute.
+     */
+    getAriaOwns(): Promise<string | null>;
+}

package/testing/autocomplete/autocomplete-search-result-harness-filters.d.ts

@@ -0,0 +1,10 @@
+import { BaseHarnessFilters } from '@angular/cdk/testing';
+/**
+ * A set of criteria that can be used to filter a list of SkyAutocompleteSearchResultHarness instances.
+ */
+export interface SkyAutocompleteSearchResultHarnessFilters extends Omit<BaseHarnessFilters, 'selector'> {
+    /**
+     * Only find instances whose content matches the given value.
+     */
+    textContent?: string | RegExp;
+}

package/testing/autocomplete/autocomplete-search-result-harness.d.ts

@@ -0,0 +1,30 @@
+import { ComponentHarness, HarnessPredicate, HarnessQuery } from '@angular/cdk/testing';
+import { SkyAutocompleteSearchResultHarnessFilters } from './autocomplete-search-result-harness-filters';
+/**
+ * Harness for interacting with an autocomplete search results in tests.
+ */
+export declare class SkyAutocompleteSearchResultHarness extends ComponentHarness {
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyAutocompleteSearchResultHarness` that meets certain criteria.
+     */
+    static with(filters: SkyAutocompleteSearchResultHarnessFilters): HarnessPredicate<SkyAutocompleteSearchResultHarness>;
+    /**
+     * Returns the value of the search result's descriptor property.
+     * This value is set by the autocomplete's `descriptorProperty` input.
+     */
+    getDescriptorValue(): Promise<string>;
+    /**
+     * Returns a child harness.
+     */
+    queryHarness<T extends ComponentHarness>(query: HarnessQuery<T>): Promise<T | null>;
+    /**
+     * Selects the search result.
+     */
+    select(): Promise<void>;
+    /**
+     * Returns the text content of the search result.
+     */
+    textContent(): Promise<string>;
+}

package/testing/public-api.d.ts

@@ -1,3 +1,7 @@
+export * from './autocomplete/autocomplete-harness';
+export * from './autocomplete/autocomplete-harness-filters';
+export * from './autocomplete/autocomplete-search-result-harness';
+export * from './autocomplete/autocomplete-search-result-harness-filters';
 export * from './country-field/country-field-fixture';
 export * from './country-field/country-field-testing.module';
 export * from './search/search-fixture';