@skyux/lookup 13.0.0 → 13.1.0

package/fesm2022/skyux-lookup.mjs

@@ -531,8 +531,10 @@ let uniqueId$1 = 0;
 class SkyAutocompleteComponent {
     /**
      * 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) {
         this.#_data = value ?? [];
@@ -597,7 +599,7 @@ class SkyAutocompleteComponent {
         return this.#_propertiesToSearch;
     }
     /**
-     * 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.
@@ -628,11 +630,12 @@ class SkyAutocompleteComponent {
         return this.#_searchTextMinimumCharacters;
     }
     /**
-     * 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) {
@@ -796,9 +799,9 @@ class SkyAutocompleteComponent {
          */
         this.allowAnyValue = input(false, ...(ngDevMode ? [{ debugName: "allowAnyValue", transform: booleanAttribute }] : [{ transform: booleanAttribute }]));
         /**
-         * 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
          */
         this.highlightSearchText = input(true, ...(ngDevMode ? [{ debugName: "highlightSearchText", transform: booleanAttribute }] : [{ transform: booleanAttribute }]));
@@ -2661,7 +2664,7 @@ class SkyLookupAutocompleteAdapter {
     constructor() {
         /**
          * 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.
          */
         this.searchAsync = new EventEmitter();
@@ -2696,7 +2699,7 @@ class SkyLookupAutocompleteAdapter {
         return this.#_propertiesToSearch;
     }
     /**
-     * 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.
@@ -3069,8 +3072,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.0", ngImpor
 class SkyLookupComponent extends SkyLookupAutocompleteAdapter {
     /**
      * 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.
      */