@skyux/lookup 5.2.1 → 5.2.2

package/bundles/skyux-lookup.umd.js

@@ -944,7 +944,7 @@
             /**
              * Specifies an object property to display in the text input after users
              * select an item in the dropdown list.
-             * @default name
+             * @default "name"
              */
             set: function (value) {
                 this._descriptorProperty = value;
@@ -973,7 +973,7 @@
             },
             /**
              * Specifies the object properties to search.
-             * @default ['name']
+             * @default ["name"]
              */
             set: function (value) {
                 this._propertiesToSearch = value;
@@ -1736,7 +1736,7 @@
              * Specifies 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
+             * @default "us"
              */
             set: function (value) {
                 var _this = this;
@@ -1755,6 +1755,7 @@
             },
             /**
              * Indicates whether to disable the country field.
+             * @default false
              */
             set: function (isDisabled) {
                 this.removeEventListeners();
@@ -2160,7 +2161,7 @@
             /**
              * Specifies an object property to display in the text input after users
              * select an item in the dropdown list.
-             * @default name
+             * @default "name"
              */
             set: function (value) {
                 this._descriptorProperty = value;
@@ -2174,7 +2175,7 @@
             },
             /**
              * Specifies an array of object properties to search.
-             * @default ['name']
+             * @default ["name"]
              */
             set: function (value) {
                 this._propertiesToSearch = value;
@@ -2329,10 +2330,10 @@
             this.searchClear = new i0.EventEmitter();
             /**
              * Specifies 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.
-             * @default responsive
+             * 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.
+             * @default "responsive"
              */
             this.expandMode = EXPAND_MODE_RESPONSIVE;
             /**

package/documentation.json

@@ -587,11 +587,11 @@
               "isPublic": true
             },
             "comment": {
-              "shortText": "Specifies the expand mode for the search input. The valid options\ninclude `responsive` to collapse the search input into a button on\nmobile devices, `none` to *not* collapse the search input on mobile\ndevices, and `fit` to extend the search input to fit the width of its container.",
+              "shortText": "Specifies the expand mode for the search input. The valid options\ninclude `\"responsive\"` to collapse the search input into a button on\nmobile devices, `\"none\"` to *not* collapse the search input on mobile\ndevices, and `\"fit\"` to extend the search input to fit the width of its container.",
               "tags": [
                 {
                   "tag": "default",
-                  "text": "responsive\n"
+                  "text": "\"responsive\"\n"
                 }
               ]
             },
@@ -715,7 +715,7 @@
               "tags": [
                 {
                   "tag": "default",
-                  "text": "Find in this list\n"
+                  "text": "\"Find in this list\"\n"
                 }
               ]
             },
@@ -2865,7 +2865,7 @@
               "tags": [
                 {
                   "tag": "default",
-                  "text": "No matches found\n"
+                  "text": "\"No matches found\"\n"
                 }
               ]
             },
@@ -3253,7 +3253,7 @@
                   "tags": [
                     {
                       "tag": "default",
-                      "text": "name\n"
+                      "text": "\"name\"\n"
                     }
                   ]
                 },
@@ -3365,7 +3365,7 @@
                   "tags": [
                     {
                       "tag": "default",
-                      "text": "['name']\n"
+                      "text": "[\"name\"]\n"
                     }
                   ]
                 },
@@ -4263,7 +4263,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 267,
+                "line": 268,
                 "character": 2
               }
             ],
@@ -4393,7 +4393,7 @@
               "tags": [
                 {
                   "tag": "default",
-                  "text": "'off'\n"
+                  "text": "\"off\"\n"
                 }
               ]
             },
@@ -4430,7 +4430,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 166,
+                "line": 167,
                 "character": 9
               }
             ],
@@ -4466,7 +4466,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 175,
+                "line": 176,
                 "character": 9
               }
             ],
@@ -4487,7 +4487,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 168,
+                "line": 169,
                 "character": 9
               }
             ],
@@ -4507,7 +4507,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 229,
+                "line": 230,
                 "character": 9
               }
             ],
@@ -4547,7 +4547,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 124,
+                "line": 125,
                 "character": 9
               }
             ],
@@ -4581,7 +4581,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 231,
+                "line": 232,
                 "character": 9
               }
             ],
@@ -4601,7 +4601,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 170,
+                "line": 171,
                 "character": 9
               }
             ],
@@ -4622,7 +4622,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 372,
+                "line": 373,
                 "character": 9
               }
             ],
@@ -4643,7 +4643,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 375,
+                "line": 376,
                 "character": 9
               }
             ],
@@ -4664,7 +4664,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 172,
+                "line": 173,
                 "character": 9
               }
             ],
@@ -4698,7 +4698,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 164,
+                "line": 165,
                 "character": 9
               }
             ],
@@ -4768,7 +4768,7 @@
                   "tags": [
                     {
                       "tag": "default",
-                      "text": "us\n"
+                      "text": "\"us\"\n"
                     }
                   ]
                 },
@@ -4813,7 +4813,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 103,
+                "line": 104,
                 "character": 13
               }
             ],
@@ -4841,7 +4841,13 @@
                 "kindString": "Set signature",
                 "flags": {},
                 "comment": {
-                  "shortText": "Indicates whether to disable the country field."
+                  "shortText": "Indicates whether to disable the country field.",
+                  "tags": [
+                    {
+                      "tag": "default",
+                      "text": "false\n"
+                    }
+                  ]
                 },
                 "parameters": [
                   {
@@ -4884,7 +4890,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 131,
+                "line": 132,
                 "character": 13
               }
             ],
@@ -4951,7 +4957,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 177,
+                "line": 178,
                 "character": 13
               }
             ],
@@ -5018,7 +5024,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 146,
+                "line": 147,
                 "character": 13
               }
             ],
@@ -5085,7 +5091,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 322,
+                "line": 323,
                 "character": 9
               }
             ],
@@ -5122,7 +5128,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 377,
+                "line": 378,
                 "character": 9
               }
             ],
@@ -5204,7 +5210,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 381,
+                "line": 382,
                 "character": 9
               }
             ],
@@ -5273,7 +5279,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 386,
+                "line": 387,
                 "character": 9
               }
             ],
@@ -5323,7 +5329,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 390,
+                "line": 391,
                 "character": 9
               }
             ],
@@ -5373,7 +5379,7 @@
             "sources": [
               {
                 "fileName": "projects/lookup/src/modules/country-field/country-field.component.ts",
-                "line": 404,
+                "line": 405,
                 "character": 9
               }
             ],
@@ -6535,7 +6541,7 @@
                   "tags": [
                     {
                       "tag": "default",
-                      "text": "name\n"
+                      "text": "\"name\"\n"
                     }
                   ]
                 },
@@ -6615,7 +6621,7 @@
                   "tags": [
                     {
                       "tag": "default",
-                      "text": "['name']\n"
+                      "text": "[\"name\"]\n"
                     }
                   ]
                 },
@@ -8733,7 +8739,7 @@
               "tags": [
                 {
                   "tag": "default",
-                  "text": "'Select an option/Select options'\n"
+                  "text": "\"Select an option/Select options\"\n"
                 }
               ]
             },
@@ -9130,6 +9136,26 @@
       "filePath": "/projects/lookup/documentation/code-examples/country-field/basic/country-field-demo.module.ts",
       "rawContents": "import { NgModule } from '@angular/core';\n\nimport { CommonModule } from '@angular/common';\n\nimport { ReactiveFormsModule } from '@angular/forms';\n\nimport { SkyInputBoxModule } from '@skyux/forms';\n\nimport { SkyCountryFieldModule } from '@skyux/lookup';\n\nimport { CountryFieldDemoComponent } from './country-field-demo.component';\n\n@NgModule({\n  imports: [\n    CommonModule,\n    ReactiveFormsModule,\n    SkyCountryFieldModule,\n    SkyInputBoxModule,\n  ],\n  declarations: [CountryFieldDemoComponent],\n  exports: [CountryFieldDemoComponent],\n})\nexport class CountryFieldDemoModule {}\n"
     },
+    {
+      "fileName": "lookup-async-demo.component.html",
+      "filePath": "/projects/lookup/documentation/code-examples/lookup/async/lookup-async-demo.component.html",
+      "rawContents": "<form\n  class=\"lookup-demo-form\"\n  novalidate\n  [formGroup]=\"myForm\"\n  (ngSubmit)=\"onSubmit()\"\n>\n  <div class=\"sky-form-group\">\n    <sky-input-box>\n      <label class=\"sky-control-label\" skyId #nameLabel=\"skyId\">\n        Favorite name\n      </label>\n      <sky-lookup\n        formControlName=\"name\"\n        selectMode=\"single\"\n        [ariaLabelledBy]=\"nameLabel.id\"\n        [data]=\"people\"\n        [searchFilters]=\"getSearchFilters()\"\n        (searchAsync)=\"searchAsync($event)\"\n      >\n      </sky-lookup>\n    </sky-input-box>\n  </div>\n  <div class=\"lookup-demo-alert\">\n    <strong>Form model:</strong>\n    <pre>{{ myForm.value | json }}</pre>\n  </div>\n  <button class=\"sky-btn sky-btn-default\" type=\"submit\">Submit</button>\n</form>\n"
+    },
+    {
+      "fileName": "lookup-async-demo.component.scss",
+      "filePath": "/projects/lookup/documentation/code-examples/lookup/async/lookup-async-demo.component.scss",
+      "rawContents": ".lookup-demo-alert {\n  padding: 10px;\n  margin-bottom: 10px;\n  border: 1px solid #cdcfd2;\n  border-radius: 3px;\n}\n\n.lookup-demo-alert pre {\n  margin: 0;\n}\n"
+    },
+    {
+      "fileName": "lookup-async-demo.component.ts",
+      "filePath": "/projects/lookup/documentation/code-examples/lookup/async/lookup-async-demo.component.ts",
+      "rawContents": "import { Component, OnInit } from '@angular/core';\n\nimport { FormBuilder, FormControl, FormGroup } from '@angular/forms';\nimport { SkyAutocompleteSearchAsyncArgs } from 'lookup';\n\nimport {\n  SkyAutocompleteSearchAsyncResult,\n  SkyAutocompleteSearchFunctionFilter,\n} from '@skyux/lookup';\nimport { Subject } from 'rxjs';\n\n@Component({\n  selector: 'app-async-lookup-demo',\n  templateUrl: './lookup-async-demo.component.html',\n  styleUrls: ['./lookup-async-demo.component.scss'],\n})\nexport class LookupAsyncDemoComponent implements OnInit {\n  public myForm: FormGroup;\n\n  public people: any[] = [\n    { name: 'Abed' },\n    { name: 'Alex' },\n    { name: 'Ben' },\n    { name: 'Britta' },\n    { name: 'Buzz' },\n    { name: 'Craig' },\n    { name: 'Elroy' },\n    { name: 'Garrett' },\n    { name: 'Ian' },\n    { name: 'Jeff' },\n    { name: 'Leonard' },\n    { name: 'Neil' },\n    { name: 'Pierce' },\n    { name: 'Preston' },\n    { name: 'Rachel' },\n    { name: 'Shirley' },\n    { name: 'Todd' },\n    { name: 'Troy' },\n    { name: 'Vaughn' },\n    { name: 'Vicki' },\n  ];\n\n  public name: any[] = [this.people[15]];\n\n  constructor(private formBuilder: FormBuilder) {}\n\n  public ngOnInit(): void {\n    this.createForm();\n\n    // If you need to execute some logic after the lookup values change,\n    // subscribe to Angular's built-in value changes observable.\n    this.myForm.valueChanges.subscribe((changes) => {\n      console.log('Lookup value changes:', changes);\n    });\n  }\n\n  // Only show people in the search results that have not been chosen already.\n  public getSearchFilters(): SkyAutocompleteSearchFunctionFilter[] {\n    const name: any[] = this.myForm.controls.name.value;\n    return [\n      (searchText: string, item: any): boolean => {\n        const found = name.find((option) => option.name === item.name);\n        return !found;\n      },\n    ];\n  }\n\n  public onSubmit(): void {\n    alert('Form submitted with: ' + JSON.stringify(this.myForm.value));\n  }\n\n  public searchAsync($event: SkyAutocompleteSearchAsyncArgs) {\n    const result = new Subject<SkyAutocompleteSearchAsyncResult>();\n    $event.result = result;\n    setTimeout(() => {\n      const searchText = $event.searchText.toLowerCase();\n      const items = this.people.filter((person) => {\n        return person.name.toLowerCase().includes(searchText)\n      });\n      result.next({\n        hasMore: false,\n        items,\n        totalCount: items.length,\n      });\n    }, 800);\n  }\n\n  private createForm(): void {\n    this.myForm = this.formBuilder.group({\n      name: new FormControl(this.name),\n    });\n  }\n}\n"
+    },
+    {
+      "fileName": "lookup-async-demo.module.ts",
+      "filePath": "/projects/lookup/documentation/code-examples/lookup/async/lookup-async-demo.module.ts",
+      "rawContents": "import { NgModule } from '@angular/core';\n\nimport { CommonModule } from '@angular/common';\n\nimport { ReactiveFormsModule } from '@angular/forms';\n\nimport { SkyIdModule } from '@skyux/core';\n\nimport { SkyInputBoxModule } from '@skyux/forms';\n\nimport { SkyLookupModule } from '@skyux/lookup';\n\nimport { LookupAsyncDemoComponent } from './lookup-async-demo.component';\n\n@NgModule({\n  imports: [\n    CommonModule,\n    ReactiveFormsModule,\n    SkyIdModule,\n    SkyInputBoxModule,\n    SkyLookupModule,\n  ],\n  declarations: [LookupAsyncDemoComponent],\n  exports: [LookupAsyncDemoComponent],\n})\nexport class LookupAsyncDemoModule {}\n"
+    },
     {
       "fileName": "lookup-custom-picker-demo-modal.component.html",
       "filePath": "/projects/lookup/documentation/code-examples/lookup/custom-picker/lookup-custom-picker-demo-modal.component.html",