@skyux/lookup 7.4.2 → 7.6.0

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

@@ -6,13 +6,13 @@ import * as i0 from "@angular/core";
 export declare class SkyAutocompleteInputDirective implements OnInit, OnDestroy, ControlValueAccessor, Validator {
     #private;
     /**
-     * Specifies the value for the `autocomplete` attribute on the form input.
+     * The value for the `autocomplete` attribute on the form input.
      * @default "off"
      */
     set autocompleteAttribute(value: string | undefined);
     get autocompleteAttribute(): string;
     /**
-     * Indicates whether to disable the autocomplete field.
+     * Whether to disable the autocomplete field.
      * @default false
      */
     set disabled(value: boolean | undefined);

package/lib/modules/autocomplete/autocomplete-search-async-disabled.pipe.d.ts

@@ -4,8 +4,8 @@ import * as i0 from "@angular/core";
 /**
  * @internal
  */
-export declare class SkyAutcompleteSearchAsyncDisabledPipe implements PipeTransform {
+export declare class SkyAutocompleteSearchAsyncDisabledPipe implements PipeTransform {
     transform(searchAsync: EventEmitter<SkyAutocompleteSearchAsyncArgs>, searchAsyncDisabled: boolean | undefined): boolean;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyAutcompleteSearchAsyncDisabledPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<SkyAutcompleteSearchAsyncDisabledPipe, "skyAutocompleteSearchAsyncDisabled", false>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyAutocompleteSearchAsyncDisabledPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SkyAutocompleteSearchAsyncDisabledPipe, "skyAutocompleteSearchAsyncDisabled", false>;
 }

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

@@ -21,27 +21,27 @@ interface SkyAutocompleteSearchResult {
 export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewInit {
     #private;
     /**
-     * Specifies the HTML element ID (without the leading `#`) of the element that labels
+     * The HTML element ID (without the leading `#`) of the element that labels
      * the autocomplete text input. This sets the input's `aria-labelledby` attribute
      * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
      */
     ariaLabelledBy: string | undefined;
     /**
-     * Specifies a static data source for the autocomplete component to search
+     * The static data source for the autocomplete component to search
      * when users enter text. For a dynamic data source such as an array that
      * changes due to server calls, use `search` or `searchAsync` instead.
      */
     set data(value: any[] | undefined);
     get data(): any[];
     /**
-     * Specifies how many milliseconds to wait before searching while users
+     * How many milliseconds to wait before searching while users
      * enter text in the autocomplete field.
      * @default 0
      */
     set debounceTime(value: number | undefined);
     get debounceTime(): number;
     /**
-     * Specifies an object property to display in the text input after users
+     * The object property to display in the text input after users
      * select an item in the dropdown list.
      * @default "name"
      */
@@ -49,11 +49,11 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     get descriptorProperty(): string;
     /**
      * @internal
-     * Indicates whether to display a button in the dropdown that opens a picker where users can view all options.
+     * Whether to display a button in the dropdown that opens a picker where users can view all options.
      */
     enableShowMore: boolean | undefined;
     /**
-     * Specifies an observable of `SkyAutocompleteMessage` that can close the dropdown.
+     * The observable of `SkyAutocompleteMessage` that can close the dropdown.
      * @internal
      */
     set messageStream(value: Subject<SkyAutocompleteMessage> | undefined);
@@ -63,14 +63,14 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
      */
     wrapperClass: string | undefined;
     /**
-     * Specifies the object properties to search.
+     * The object properties to search.
      * @default ["name"]
      * @deprecated We recommend against using this property. To search specific properties, use the `searchAsync` event instead.
      */
     set propertiesToSearch(value: string[] | undefined);
     get propertiesToSearch(): string[];
     /**
-     * Specifies a function to dynamically manage the data source when users
+     * The function that dynamically manages the data source when users
      * change the text in the autocomplete field. The search function must return
      * an array or a promise of an array. The `search` property is particularly
      * useful when the data source does not live in the source code.
@@ -79,13 +79,13 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     set search(value: SkyAutocompleteSearchFunction | undefined);
     get search(): SkyAutocompleteSearchFunction | undefined;
     /**
-     * Specifies a template to format each search result in the dropdown list.
+     * The template that formats each search result in the dropdown list.
      * The autocomplete component injects search result values into the template
      * as `item` variables that reference all of the object properties of the search results.
      */
     searchResultTemplate: TemplateRef<unknown> | undefined;
     /**
-     * Specifies the minimum number of characters that users must enter before
+     * The minimum number of characters that users must enter before
      * the autocomplete component searches the data source and displays search
      * results in the dropdown list.
      * @default 1
@@ -93,7 +93,7 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     set searchTextMinimumCharacters(value: number | undefined);
     get searchTextMinimumCharacters(): number;
     /**
-     * Specifies an array of functions to call against each search result in order
+     * The array of functions to call against each search result in order
      * to filter the search results when using the default search function. When
      * using the `search` property to specify a custom search function, you must
      * manually apply filters inside that function. The function must return `true`
@@ -103,19 +103,19 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     set searchFilters(value: SkyAutocompleteSearchFunctionFilter[] | undefined);
     get searchFilters(): SkyAutocompleteSearchFunctionFilter[] | undefined;
     /**
-     * Specifies the maximum number of search results to display in the dropdown list.
+     * The maximum number of search results to display in the dropdown list.
      * By default, the component displays all matching results.
      */
     set searchResultsLimit(value: number | undefined);
     get searchResultsLimit(): number;
     /**
      * @internal
-     * Indicates whether to display a button that lets users add options to the data source.
+     * Whether to display a button that lets users add options to the data source.
      * @default false
      */
     showAddButton: boolean | undefined;
     /**
-     * Specifies the text to display when no search results are found.
+     * The text to display when no search results are found.
      * @default "No matches found"
      */
     noResultsFoundText: string | undefined;

package/lib/modules/autocomplete/autocomplete.module.d.ts

@@ -10,6 +10,6 @@ import * as i8 from "../shared/sky-lookup-resources.module";
 import * as i9 from "@skyux/theme";
 export declare class SkyAutocompleteModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyAutocompleteModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAutocompleteModule, [typeof i1.SkyAutocompleteComponent, typeof i2.SkyAutocompleteInputDirective, typeof i3.SkyAutcompleteSearchAsyncDisabledPipe], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i6.SkyAffixModule, typeof i7.SkyTextHighlightModule, typeof i7.SkyIconModule, typeof i6.SkyIdModule, typeof i8.SkyLookupResourcesModule, typeof i6.SkyNumericModule, typeof i6.SkyOverlayModule, typeof i9.SkyThemeModule, typeof i7.SkyWaitModule], [typeof i1.SkyAutocompleteComponent, typeof i2.SkyAutocompleteInputDirective]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAutocompleteModule, [typeof i1.SkyAutocompleteComponent, typeof i2.SkyAutocompleteInputDirective, typeof i3.SkyAutocompleteSearchAsyncDisabledPipe], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i6.SkyAffixModule, typeof i7.SkyTextHighlightModule, typeof i7.SkyIconModule, typeof i6.SkyIdModule, typeof i8.SkyLookupResourcesModule, typeof i6.SkyNumericModule, typeof i6.SkyOverlayModule, typeof i9.SkyThemeModule, typeof i7.SkyWaitModule], [typeof i1.SkyAutocompleteComponent, typeof i2.SkyAutocompleteInputDirective]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyAutocompleteModule>;
 }

package/lib/modules/autocomplete/types/autocomplete-message.d.ts

@@ -4,7 +4,7 @@ import { SkyAutocompleteMessageType } from './autocomplete-message-type';
  */
 export interface SkyAutocompleteMessage {
     /**
-     * Specifies the type of message.
+     * The type of message.
      */
     type?: SkyAutocompleteMessageType;
 }

package/lib/modules/autocomplete/types/autocomplete-search-async-result.d.ts

@@ -8,7 +8,7 @@ export interface SkyAutocompleteSearchAsyncResult {
      */
     continuationData?: unknown;
     /**
-     * Indicates whether there are more results that match the search criteria.
+     * Whether there are more results that match the search criteria.
      */
     hasMore?: boolean;
     /**

package/lib/modules/autocomplete/types/autocomplete-selection-change.d.ts

@@ -1,6 +1,6 @@
 export interface SkyAutocompleteSelectionChange {
     /**
-     * References a search result object that users select in the dropdown list.
+     * The search result object that users select in the dropdown list.
      */
     selectedItem?: any;
 }

package/lib/modules/country-field/country-field.component.d.ts

@@ -12,11 +12,11 @@ export declare class SkyCountryFieldComponent implements AfterViewInit, ControlV
     #private;
     inputBoxHostSvc?: SkyInputBoxHostService | undefined;
     /**
-     * Specifies the value for the `autocomplete` attribute on the form input.
+     * The value for the `autocomplete` attribute on the form input.
      */
     autocompleteAttribute: string | undefined;
     /**
-     * Specifies the [International Organization for Standardization Alpha 2](https://www.nationsonline.org/oneworld/country_code_list.htm)
+     * The [International Organization for Standardization Alpha 2](https://www.nationsonline.org/oneworld/country_code_list.htm)
      * country code for the default country.
      * When search results include the default country, it appears at the top of the list.
      * @default "us"
@@ -24,25 +24,25 @@ export declare class SkyCountryFieldComponent implements AfterViewInit, ControlV
     set defaultCountry(value: string | undefined);
     get defaultCountry(): string | undefined;
     /**
-     * Indicates whether to disable the country field.
+     * Whether to disable the country field.
      * @default false
      */
     set disabled(isDisabled: boolean | undefined);
     get disabled(): boolean;
     /**
-     * Indicates whether to hide the flag in the input element.
+     * Whether to hide the flag in the input element.
      * @default false
      */
     set hideSelectedCountryFlag(value: boolean | undefined);
     get hideSelectedCountryFlag(): boolean;
     /**
-     * Indicates whether to include phone information in the selected country and country dropdown.
+     * Whether to include phone information in the selected country and country dropdown.
      * @default false
      */
     set includePhoneInfo(value: boolean | undefined);
     get includePhoneInfo(): boolean;
     /**
-     * Specifies the [International Organization for Standardization Alpha 2](https://www.nationsonline.org/oneworld/country_code_list.htm)
+     * The [International Organization for Standardization Alpha 2](https://www.nationsonline.org/oneworld/country_code_list.htm)
      * country codes for the countries that users can select. By default, all countries are available.
      */
     set supportedCountryISOs(value: string[] | undefined);
@@ -70,7 +70,7 @@ export declare class SkyCountryFieldComponent implements AfterViewInit, ControlV
     ngOnInit(): void;
     ngAfterViewInit(): void;
     /**
-     * Angular lifecycle hook for when the compoennt is destructed.
+     * Angular lifecycle hook for when the component is destructed.
      * @internal
      */
     ngOnDestroy(): void;

package/lib/modules/country-field/types/country.d.ts

@@ -13,7 +13,7 @@ export interface SkyCountryFieldCountry {
      */
     name?: string;
     /**
-     * Specifies the country's international dial code.
+     * The country's international dial code.
      * This property will only be set if the `includePhoneInfo` input is set.
      */
     dialCode?: string;

package/lib/modules/lookup/lookup-autocomplete-adapter.d.ts

@@ -9,26 +9,26 @@ import * as i0 from "@angular/core";
 export declare class SkyLookupAutocompleteAdapter {
     #private;
     /**
-     * Specifies how many milliseconds to wait before searching while users
+     * How many milliseconds to wait before searching while users
      * enter text in the lookup field.
      * @default 0
      */
     debounceTime: number | undefined;
     /**
-     * Specifies an object property to display in the text input after users
+     * The object property to display in the text input after users
      * select an item in the dropdown list.
      * @default "name"
      */
     set descriptorProperty(value: string | undefined);
     get descriptorProperty(): string;
     /**
-     * Specifies an array of object properties to search.
+     * The array of object properties to search.
      * @default ["name"]
      */
     set propertiesToSearch(value: string[] | undefined);
     get propertiesToSearch(): string[];
     /**
-     * Specifies a function to dynamically manage the data source when users
+     * The function to dynamically manage the data source when users
      * change the text in the lookup field. The search function must return
      * an array or a promise of an array. The `search` property is particularly
      * useful when the data source does not live in the source code. If the
@@ -38,20 +38,20 @@ export declare class SkyLookupAutocompleteAdapter {
     set search(value: SkyAutocompleteSearchFunction | undefined);
     get search(): SkyAutocompleteSearchFunction | undefined;
     /**
-     * Specifies a template to format each option in the dropdown list. The lookup component
+     * The template that formats each option in the dropdown list. The lookup component
      * injects values into the template as `item` variables that reference all the object
      * properties of the options.
      */
     searchResultTemplate: TemplateRef<unknown> | undefined;
     /**
-     * Specifies the minimum number of characters that users must enter before
+     * The minimum number of characters that users must enter before
      * the lookup component searches the data source and displays search results
      * in the dropdown list.
      * @default 1
      */
     searchTextMinimumCharacters: number | undefined;
     /**
-     * Specifies an array of functions to call against each search result in order
+     * The array of functions to call against each search result in order
      * to filter the search results when using the default search function. When
      * using a custom search function via the `search` property filters must be
      * applied manually inside that function. The function must return `true` or
@@ -60,7 +60,7 @@ export declare class SkyLookupAutocompleteAdapter {
     set searchFilters(value: SkyAutocompleteSearchFunctionFilter[] | undefined);
     get searchFilters(): SkyAutocompleteSearchFunctionFilter[] | undefined;
     /**
-     * Specifies the maximum number of search results to display in the dropdown
+     * The maximum number of search results to display in the dropdown
      * list. By default, the lookup component displays all matching results.
      */
     searchResultsLimit: number | undefined;

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

@@ -24,24 +24,24 @@ export declare class SkyLookupComponent extends SkyLookupAutocompleteAdapter imp
     inputBoxHostSvc?: SkyInputBoxHostService | undefined;
     themeSvc?: SkyThemeService | undefined;
     /**
-     * Specifies an ARIA label for the typeahead search input
+     * The ARIA label for the typeahead search input
      * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
      * If the input includes a visible label, use `ariaLabelledBy` instead.
      */
     ariaLabel: string | undefined;
     /**
-     * Specifies the HTML element ID (without the leading `#`) of the element that labels
+     * The HTML element ID (without the leading `#`) of the element that labels
      * the typeahead search input. This sets the input's `aria-labelledby` attribute
      * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
      * If the input does not include a visible label, use `ariaLabel` instead.
      */
     ariaLabelledBy: string | undefined;
     /**
-     * Specifies the value for the `autocomplete` attribute on the form input.
+     * The value for the `autocomplete` attribute on the form input.
      */
     autocompleteAttribute: string | undefined;
     /**
-     * Specifies a data source for the lookup component to search when users
+     * The data source for the lookup component to search when users
      * enter text. You can specify static data such as an array of objects, or
      * you can pull data from a database.
      * @default []
@@ -49,39 +49,39 @@ export declare class SkyLookupComponent extends SkyLookupAutocompleteAdapter imp
     set data(value: any[] | undefined);
     get data(): any[];
     /**
-     * Indicates whether to disable the lookup field.
+     * Whether to disable the lookup field.
      * @default false
      */
     set disabled(value: boolean | undefined);
     get disabled(): boolean;
     /**
-     * Indicates whether to enable users to open a picker where they can view all options.
+     * Whether to enable users to open a picker where they can view all options.
      * @default false
      */
     set enableShowMore(value: boolean | undefined);
     get enableShowMore(): boolean;
     /**
-     * Specifies placeholder text to display in the lookup field.
+     * Placeholder text to display in the lookup field.
      */
     placeholderText: string | undefined;
     /**
-     * Specifies an object property that represents the object's unique identifier.
+     * The 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;
     /**
-     * Indicates whether to display a button that lets users add options to the list.
+     * Whether to display a button that lets users add options to the list.
      * @default false
      */
     set showAddButton(value: boolean | undefined);
     get showAddButton(): boolean;
     /**
-     * Specifies configuration options for the picker that displays all options.
+     * Configuration options for the picker that displays all options.
      */
     showMoreConfig: SkyLookupShowMoreConfig | undefined;
     /**
-     * Specifies whether users can select one option or multiple options.
+     * The ability for users to select one option or multiple options.
      * @default "multiple"
      */
     set selectMode(value: SkyLookupSelectModeType | undefined);

package/lib/modules/lookup/types/lookup-show-more-config.d.ts

@@ -8,11 +8,11 @@ import { SkyLookupShowMoreNativePickerConfig } from './lookup-show-more-native-p
  */
 export interface SkyLookupShowMoreConfig {
     /**
-     * Specifies a configuration object to display a custom picker.
+     * The configuration object to display a custom picker.
      */
     customPicker?: SkyLookupShowMoreCustomPicker;
     /**
-     * Specifies configuration options for the native picker.
+     * Configuration options for the native picker.
      */
     nativePickerConfig?: SkyLookupShowMoreNativePickerConfig;
 }

package/lib/modules/lookup/types/lookup-show-more-custom-picker-context.d.ts

@@ -4,15 +4,15 @@
  */
 export declare class SkyLookupShowMoreCustomPickerContext {
     /**
-     * Specifies the options that users can select in the custom picker.
+     * The options that users can select in the custom picker.
      */
     items: any[];
     /**
-     * Specifies search text to filter the contents of the custom picker.
+     * Search text to filter the contents of the custom picker.
      */
     initialSearch: string;
     /**
-     * Specifies the current selections in the lookup field.
+     * The current selections in the lookup field.
      */
     initialValue: any;
 }

package/lib/modules/lookup/types/lookup-show-more-native-picker-config.d.ts

@@ -5,14 +5,14 @@ import { TemplateRef } from '@angular/core';
  */
 export interface SkyLookupShowMoreNativePickerConfig {
     /**
-     * Specifies a template to format each option in the picker. The lookup component
+     * The template that formats each option in the picker. The lookup component
      * injects values into the template as `item` variables that reference all the object
      * properties of the options. If you do not specify a template, the picker uses
      * the same template as the dropdown list.
      */
     itemTemplate?: TemplateRef<unknown>;
     /**
-     * Specifies a title for the picker.
+     * The title for the picker.
      * @default "Select an option/Select options"
      */
     title?: string;

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

@@ -19,11 +19,11 @@ export declare class SkySearchComponent implements OnDestroy, OnInit, OnChanges
      */
     searchClear: EventEmitter<void>;
     /**
-     * Specifies default search criteria for the input.
+     * Default search criteria for the input.
      */
     searchText: string | undefined;
     /**
-     * Specifies the expand mode for the search input. The valid options
+     * The expand mode for the search input. The valid options
      * include `"responsive"` to collapse the search input into a button on
      * mobile devices, `"none"` to *not* collapse the search input on mobile
      * devices, and `"fit"` to extend the search input to fit the width of its container.
@@ -32,19 +32,19 @@ export declare class SkySearchComponent implements OnDestroy, OnInit, OnChanges
     set expandMode(value: string | undefined);
     get expandMode(): string;
     /**
-     * Specifies how many milliseconds to wait before searching after users enter text in the search input.
+     * How many milliseconds to wait before searching after users enter text in the search input.
      * @default 0
      */
     set debounceTime(value: number | undefined);
     get debounceTime(): number;
     /**
-     * Indicates whether to disable the filter button.
+     * Whether to disable the filter button.
      * @default false
      */
     set disabled(value: boolean | undefined);
     get disabled(): boolean;
     /**
-     * Specifies placeholder text to display in the search input until users
+     * Placeholder text to display in the search input until users
      * enter search criteria.
      * @default "Find in this list"
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lookup",
-  "version": "7.4.2",
+  "version": "7.6.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -46,15 +46,15 @@
     "@angular/core": "^14.2.11",
     "@angular/forms": "^14.2.11",
     "@angular/platform-browser": "^14.2.11",
-    "@skyux-sdk/testing": "7.4.2",
-    "@skyux/core": "7.4.2",
-    "@skyux/forms": "7.4.2",
-    "@skyux/i18n": "7.4.2",
-    "@skyux/indicators": "7.4.2",
-    "@skyux/layout": "7.4.2",
-    "@skyux/lists": "7.4.2",
-    "@skyux/modals": "7.4.2",
-    "@skyux/theme": "7.4.2"
+    "@skyux-sdk/testing": "7.6.0",
+    "@skyux/core": "7.6.0",
+    "@skyux/forms": "7.6.0",
+    "@skyux/i18n": "7.6.0",
+    "@skyux/indicators": "7.6.0",
+    "@skyux/layout": "7.6.0",
+    "@skyux/lists": "7.6.0",
+    "@skyux/modals": "7.6.0",
+    "@skyux/theme": "7.6.0"
   },
   "dependencies": {
     "intl-tel-input": "17.0.19",