@skyux/lookup 12.40.0 → 12.41.1

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

@@ -29,8 +29,10 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     ariaLabelledBy: string | undefined;
     /**
      * The static data source for the autocomplete component to search
-     * when users enter text. For a dynamic data source such as an array that
+     * when users enter text. For a dynamic data source, such as an array that
      * changes due to server calls, use `search` or `searchAsync` instead.
+     * You can specify static data, such as an array of objects,
+     * or you can pull data from a database.
      */
     set data(value: any[] | undefined);
     get data(): any[];
@@ -77,7 +79,7 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     set propertiesToSearch(value: string[] | undefined);
     get propertiesToSearch(): string[];
     /**
-     * The function that dynamically manages the data source when users
+     * The function that dynamically manages the data to display in search results 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.
@@ -100,11 +102,12 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
     set searchTextMinimumCharacters(value: number | undefined);
     get searchTextMinimumCharacters(): number;
     /**
-     * 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
+     * The array of functions to call against each search result. This filters
+     * the search results when using the `data` input and the default search function.
+     *  When the `search` property specifies a custom search function, you must
      * manually apply filters inside that function. The function must return `true`
      * or `false` for each result to indicate whether to display it in the dropdown list.
+     *
      * @deprecated We recommend against using this property. To filter results, use the `searchAsync` event instead.
      */
     set searchFilters(value: SkyAutocompleteSearchFunctionFilter[] | undefined);
@@ -135,14 +138,14 @@ export declare class SkyAutocompleteComponent implements OnDestroy, AfterViewIni
      */
     searchAsyncDisabled: boolean | undefined;
     /**
-     * Allows the user to specify arbitrary values not in the search results.
+     * Allows users to specify arbitrary values not in the search results.
      * @default false
      */
     allowAnyValue: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
     /**
-     * Highlights the search text in each search result. Set this to false
-     * when your search finds results that are not exact text matches, e.g.
-     * returning "Bob" for the term "Robert."
+     * Highlights the search text in each search result. Set this to `false`
+     * when your search returns results that aren't exact text matches, such as
+     * returning "Bob" for "Robert."
      * @default true
      */
     highlightSearchText: import("@angular/core").InputSignalWithTransform<boolean, unknown>;

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

@@ -29,7 +29,7 @@ export declare class SkyLookupAutocompleteAdapter {
     set propertiesToSearch(value: string[] | undefined);
     get propertiesToSearch(): string[];
     /**
-     * The function to dynamically manage the data source when users
+     * The function that dynamically manages the data to display in search results 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.
@@ -39,8 +39,8 @@ export declare class SkyLookupAutocompleteAdapter {
     get search(): SkyAutocompleteSearchFunction | undefined;
     /**
      * 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.
+     * injects values into the template as `item` variables that reference all of the object
+     * properties of the search results.
      */
     searchResultTemplate: TemplateRef<unknown> | undefined;
     /**
@@ -68,7 +68,7 @@ export declare class SkyLookupAutocompleteAdapter {
     searchResultsLimit: number | undefined;
     /**
      * Fires when users enter new search information and allows results to be
-     * returned via an observable. The event is also fired with empty search text
+     * returned via an observable. The event is also fired
      * when the "Show more" picker is opened without search text.
      */
     searchAsync: EventEmitter<SkyAutocompleteSearchAsyncArgs>;

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

@@ -36,15 +36,16 @@ export declare class SkyLookupComponent extends SkyLookupAutocompleteAdapter imp
      */
     ariaLabelledBy: string | undefined;
     /**
-     * The value for the `autocomplete` attribute on the form input.
+     * The value to provide to the `autocomplete` attribute on the form input.
      * @default 'off'
      * @deprecated SKY UX only supports browser autofill on components where the direct input matches the return value. This input may not behave as expected due to the dropdown selection interaction.
      */
     autocompleteAttribute: string | undefined;
     /**
      * 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
+     * enter text. You can specify static data, such as an array of objects, or
      * you can pull data from a database.
+     *
      * @default []
      * @deprecated Use the `searchAsync` event emitter and callback instead to provide data to the lookup component.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lookup",
-  "version": "12.40.0",
+  "version": "12.41.1",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -22,16 +22,16 @@
     "@angular/core": "^19.2.14",
     "@angular/forms": "^19.2.14",
     "@angular/platform-browser": "^19.2.14",
-    "@skyux-sdk/testing": "12.40.0",
-    "@skyux/core": "12.40.0",
-    "@skyux/forms": "12.40.0",
-    "@skyux/i18n": "12.40.0",
-    "@skyux/icon": "12.40.0",
-    "@skyux/indicators": "12.40.0",
-    "@skyux/layout": "12.40.0",
-    "@skyux/lists": "12.40.0",
-    "@skyux/modals": "12.40.0",
-    "@skyux/theme": "12.40.0"
+    "@skyux-sdk/testing": "12.41.1",
+    "@skyux/core": "12.41.1",
+    "@skyux/forms": "12.41.1",
+    "@skyux/i18n": "12.41.1",
+    "@skyux/icon": "12.41.1",
+    "@skyux/indicators": "12.41.1",
+    "@skyux/layout": "12.41.1",
+    "@skyux/lists": "12.41.1",
+    "@skyux/modals": "12.41.1",
+    "@skyux/theme": "12.41.1"
   },
   "dependencies": {
     "intl-tel-input": "25.2.1",