@ukic/docs 2.0.0-alpha.105 → 2.0.0-alpha.109

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 The Secret Intelligence Service (MI6)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-11-10T13:59:05",
+  "timestamp": "2022-11-15T17:39:44",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.19.1",
@@ -5745,6 +5745,23 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "charactersUntilSuggestions",
+          "type": "number",
+          "mutable": false,
+          "attr": "characters-until-suggestions",
+          "reflectToAttr": false,
+          "docs": "Number of characters until suggestions appear for a searchable select.",
+          "docsTags": [],
+          "default": "0",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "dense",
           "type": "boolean",
@@ -5779,6 +5796,23 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "emptyOptionListText",
+          "type": "string",
+          "mutable": false,
+          "attr": "empty-option-list-text",
+          "reflectToAttr": false,
+          "docs": "Provide text for empty results list",
+          "docsTags": [],
+          "default": "\"No results found\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "fullWidth",
           "type": "boolean",
@@ -5830,6 +5864,40 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "includeDescriptionsInSearch",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "include-descriptions-in-search",
+          "reflectToAttr": false,
+          "docs": "If true, descriptions of options are included when filtering options in a searchable select.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "includeGroupTitlesInSearch",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "include-group-titles-in-search",
+          "reflectToAttr": false,
+          "docs": "If true, group titles of grouped options are included when filtering options in a searchable select.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -5930,13 +5998,52 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "searchMatchPosition",
+          "type": "\"anywhere\" | \"start\"",
+          "mutable": false,
+          "attr": "search-match-position",
+          "reflectToAttr": false,
+          "docs": "Whether the search string of the searchable select should match the start of or anywhere in the options.",
+          "docsTags": [],
+          "default": "\"anywhere\"",
+          "values": [
+            {
+              "value": "anywhere",
+              "type": "string"
+            },
+            {
+              "value": "start",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "searchable",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "searchable",
+          "reflectToAttr": false,
+          "docs": "If true, the select can be typed in to filter options.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "showClearButton",
           "type": "boolean",
           "mutable": false,
           "attr": "show-clear-button",
           "reflectToAttr": false,
-          "docs": "Display a button which clears the input when clicked.",
+          "docs": "Display a button which clears the input when clicked. The button will always appear on the searchable select.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -8443,7 +8550,7 @@
           "mutable": false,
           "attr": "spacing",
           "reflectToAttr": false,
-          "docs": "Adds margin to the bottom of the typography relative to the font-size.",
+          "docs": "Adds appropriate margins to the top and bottom of the typography.",
           "docsTags": [],
           "default": "false",
           "values": [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ukic/docs",
-  "version": "2.0.0-alpha.105",
-  "description": "API docs for ic-ui-kit stencil.",
+  "version": "2.0.0-alpha.109",
+  "description": "API docs for ic-ui-kit.",
   "main": "docs.json",
   "types": "docs.d.ts",
   "files": [
@@ -9,5 +9,6 @@
     "docs.d.ts"
   ],
   "author": "ICDS Team",
-  "license": "MIT"
+  "license": "MIT",
+  "gitHead": "dbf6985a251c4cd436ae536ec15b1df0292b1ea9"
 }