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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs.json +110 -3
  2. package/package.json +3 -3
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2022-11-15T10:30:10",
2
+ "timestamp": "2022-11-15T17:39:44",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.19.1",
@@ -5745,6 +5745,23 @@
5745
5745
  "docsTags": [],
5746
5746
  "usage": {},
5747
5747
  "props": [
5748
+ {
5749
+ "name": "charactersUntilSuggestions",
5750
+ "type": "number",
5751
+ "mutable": false,
5752
+ "attr": "characters-until-suggestions",
5753
+ "reflectToAttr": false,
5754
+ "docs": "Number of characters until suggestions appear for a searchable select.",
5755
+ "docsTags": [],
5756
+ "default": "0",
5757
+ "values": [
5758
+ {
5759
+ "type": "number"
5760
+ }
5761
+ ],
5762
+ "optional": true,
5763
+ "required": false
5764
+ },
5748
5765
  {
5749
5766
  "name": "dense",
5750
5767
  "type": "boolean",
@@ -5779,6 +5796,23 @@
5779
5796
  "optional": true,
5780
5797
  "required": false
5781
5798
  },
5799
+ {
5800
+ "name": "emptyOptionListText",
5801
+ "type": "string",
5802
+ "mutable": false,
5803
+ "attr": "empty-option-list-text",
5804
+ "reflectToAttr": false,
5805
+ "docs": "Provide text for empty results list",
5806
+ "docsTags": [],
5807
+ "default": "\"No results found\"",
5808
+ "values": [
5809
+ {
5810
+ "type": "string"
5811
+ }
5812
+ ],
5813
+ "optional": false,
5814
+ "required": false
5815
+ },
5782
5816
  {
5783
5817
  "name": "fullWidth",
5784
5818
  "type": "boolean",
@@ -5830,6 +5864,40 @@
5830
5864
  "optional": true,
5831
5865
  "required": false
5832
5866
  },
5867
+ {
5868
+ "name": "includeDescriptionsInSearch",
5869
+ "type": "boolean",
5870
+ "mutable": false,
5871
+ "attr": "include-descriptions-in-search",
5872
+ "reflectToAttr": false,
5873
+ "docs": "If true, descriptions of options are included when filtering options in a searchable select.",
5874
+ "docsTags": [],
5875
+ "default": "false",
5876
+ "values": [
5877
+ {
5878
+ "type": "boolean"
5879
+ }
5880
+ ],
5881
+ "optional": true,
5882
+ "required": false
5883
+ },
5884
+ {
5885
+ "name": "includeGroupTitlesInSearch",
5886
+ "type": "boolean",
5887
+ "mutable": false,
5888
+ "attr": "include-group-titles-in-search",
5889
+ "reflectToAttr": false,
5890
+ "docs": "If true, group titles of grouped options are included when filtering options in a searchable select.",
5891
+ "docsTags": [],
5892
+ "default": "false",
5893
+ "values": [
5894
+ {
5895
+ "type": "boolean"
5896
+ }
5897
+ ],
5898
+ "optional": true,
5899
+ "required": false
5900
+ },
5833
5901
  {
5834
5902
  "name": "label",
5835
5903
  "type": "string",
@@ -5930,13 +5998,52 @@
5930
5998
  "optional": true,
5931
5999
  "required": false
5932
6000
  },
6001
+ {
6002
+ "name": "searchMatchPosition",
6003
+ "type": "\"anywhere\" | \"start\"",
6004
+ "mutable": false,
6005
+ "attr": "search-match-position",
6006
+ "reflectToAttr": false,
6007
+ "docs": "Whether the search string of the searchable select should match the start of or anywhere in the options.",
6008
+ "docsTags": [],
6009
+ "default": "\"anywhere\"",
6010
+ "values": [
6011
+ {
6012
+ "value": "anywhere",
6013
+ "type": "string"
6014
+ },
6015
+ {
6016
+ "value": "start",
6017
+ "type": "string"
6018
+ }
6019
+ ],
6020
+ "optional": true,
6021
+ "required": false
6022
+ },
6023
+ {
6024
+ "name": "searchable",
6025
+ "type": "boolean",
6026
+ "mutable": false,
6027
+ "attr": "searchable",
6028
+ "reflectToAttr": false,
6029
+ "docs": "If true, the select can be typed in to filter options.",
6030
+ "docsTags": [],
6031
+ "default": "false",
6032
+ "values": [
6033
+ {
6034
+ "type": "boolean"
6035
+ }
6036
+ ],
6037
+ "optional": true,
6038
+ "required": false
6039
+ },
5933
6040
  {
5934
6041
  "name": "showClearButton",
5935
6042
  "type": "boolean",
5936
6043
  "mutable": false,
5937
6044
  "attr": "show-clear-button",
5938
6045
  "reflectToAttr": false,
5939
- "docs": "Display a button which clears the input when clicked.",
6046
+ "docs": "Display a button which clears the input when clicked. The button will always appear on the searchable select.",
5940
6047
  "docsTags": [],
5941
6048
  "default": "false",
5942
6049
  "values": [
@@ -8443,7 +8550,7 @@
8443
8550
  "mutable": false,
8444
8551
  "attr": "spacing",
8445
8552
  "reflectToAttr": false,
8446
- "docs": "Adds margin to the bottom of the typography relative to the font-size.",
8553
+ "docs": "Adds appropriate margins to the top and bottom of the typography.",
8447
8554
  "docsTags": [],
8448
8555
  "default": "false",
8449
8556
  "values": [
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ukic/docs",
3
- "version": "2.0.0-alpha.108",
4
- "description": "API docs for ic-ui-kit stencil.",
3
+ "version": "2.0.0-alpha.109",
4
+ "description": "API docs for ic-ui-kit.",
5
5
  "main": "docs.json",
6
6
  "types": "docs.d.ts",
7
7
  "files": [
@@ -10,5 +10,5 @@
10
10
  ],
11
11
  "author": "ICDS Team",
12
12
  "license": "MIT",
13
- "gitHead": "4deaa17746fb4b314bc767c3ffc3a4fa80d2cd3d"
13
+ "gitHead": "dbf6985a251c4cd436ae536ec15b1df0292b1ea9"
14
14
  }