@skyux/lookup 13.0.0 → 13.1.0

package/index.d.ts

@@ -227,8 +227,10 @@ declare class SkyAutocompleteComponent implements OnDestroy, AfterViewInit {
     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[];
@@ -275,7 +277,7 @@ declare class SkyAutocompleteComponent implements OnDestroy, AfterViewInit {
     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.
@@ -298,11 +300,12 @@ declare class SkyAutocompleteComponent implements OnDestroy, AfterViewInit {
     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);
@@ -340,9 +343,9 @@ declare class SkyAutocompleteComponent implements OnDestroy, AfterViewInit {
      */
     allowAnyValue: i0.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: i0.InputSignalWithTransform<boolean, unknown>;
@@ -597,7 +600,7 @@ 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.
@@ -607,8 +610,8 @@ 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;
     /**
@@ -636,7 +639,7 @@ 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>;
@@ -766,15 +769,16 @@ declare class SkyLookupComponent extends SkyLookupAutocompleteAdapter implements
      */
     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": "13.0.0",
+  "version": "13.1.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -22,16 +22,16 @@
     "@angular/core": "^20.3.0",
     "@angular/forms": "^20.3.0",
     "@angular/platform-browser": "^20.3.0",
-    "@skyux-sdk/testing": "13.0.0",
-    "@skyux/core": "13.0.0",
-    "@skyux/forms": "13.0.0",
-    "@skyux/i18n": "13.0.0",
-    "@skyux/icon": "13.0.0",
-    "@skyux/indicators": "13.0.0",
-    "@skyux/layout": "13.0.0",
-    "@skyux/lists": "13.0.0",
-    "@skyux/modals": "13.0.0",
-    "@skyux/theme": "13.0.0"
+    "@skyux-sdk/testing": "13.1.0",
+    "@skyux/core": "13.1.0",
+    "@skyux/forms": "13.1.0",
+    "@skyux/i18n": "13.1.0",
+    "@skyux/icon": "13.1.0",
+    "@skyux/indicators": "13.1.0",
+    "@skyux/layout": "13.1.0",
+    "@skyux/lists": "13.1.0",
+    "@skyux/modals": "13.1.0",
+    "@skyux/theme": "13.1.0"
   },
   "dependencies": {
     "intl-tel-input": "25.3.1",