@warp-ds/elements 2.9.1-next.3 → 2.9.1-next.4

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 (91) hide show
  1. package/dist/custom-elements.json +83 -239
  2. package/dist/docs/affix/affix.md +9 -10
  3. package/dist/docs/affix/api.md +9 -10
  4. package/dist/docs/alert/alert.md +4 -2
  5. package/dist/docs/alert/api.md +4 -2
  6. package/dist/docs/attention/api.md +16 -14
  7. package/dist/docs/attention/attention.md +16 -14
  8. package/dist/docs/badge/api.md +5 -6
  9. package/dist/docs/badge/badge.md +5 -6
  10. package/dist/docs/box/api.md +3 -4
  11. package/dist/docs/box/box.md +3 -4
  12. package/dist/docs/breadcrumbs/accessibility.md +46 -0
  13. package/dist/docs/breadcrumbs/api.md +8 -8
  14. package/dist/docs/breadcrumbs/breadcrumbs.md +127 -9
  15. package/dist/docs/breadcrumbs/examples.md +35 -0
  16. package/dist/docs/breadcrumbs/usage.md +36 -0
  17. package/dist/docs/button/api.md +15 -13
  18. package/dist/docs/button/button.md +15 -13
  19. package/dist/docs/card/api.md +5 -6
  20. package/dist/docs/card/card.md +5 -6
  21. package/dist/docs/combobox/api.md +18 -19
  22. package/dist/docs/combobox/combobox.md +18 -19
  23. package/dist/docs/datepicker/api.md +38 -39
  24. package/dist/docs/datepicker/datepicker.md +38 -39
  25. package/dist/docs/expandable/api.md +11 -12
  26. package/dist/docs/expandable/expandable.md +11 -12
  27. package/dist/docs/link/api.md +8 -6
  28. package/dist/docs/link/link.md +8 -6
  29. package/dist/docs/page-indicator/api.md +7 -8
  30. package/dist/docs/page-indicator/page-indicator.md +7 -8
  31. package/dist/docs/pagination/api.md +17 -9
  32. package/dist/docs/pagination/pagination.md +17 -9
  33. package/dist/docs/pill/api.md +30 -17
  34. package/dist/docs/pill/pill.md +30 -17
  35. package/dist/docs/select/api.md +17 -9
  36. package/dist/docs/select/select.md +17 -9
  37. package/dist/docs/slider/api.md +37 -116
  38. package/dist/docs/slider/examples.md +331 -0
  39. package/dist/docs/slider/slider.md +378 -118
  40. package/dist/docs/slider/usage.md +10 -0
  41. package/dist/docs/slider-thumb/api.md +26 -55
  42. package/dist/docs/slider-thumb/slider-thumb.md +26 -57
  43. package/dist/docs/step/api.md +3 -4
  44. package/dist/docs/step/step.md +3 -4
  45. package/dist/docs/step-indicator/api.md +3 -4
  46. package/dist/docs/step-indicator/step-indicator.md +3 -4
  47. package/dist/docs/switch/api.md +13 -5
  48. package/dist/docs/switch/switch.md +13 -5
  49. package/dist/docs/tab/api.md +9 -62
  50. package/dist/docs/tab/tab.md +9 -70
  51. package/dist/docs/tab-panel/api.md +7 -11
  52. package/dist/docs/tab-panel/tab-panel.md +7 -19
  53. package/dist/docs/tabs/accessibility.md +11 -0
  54. package/dist/docs/tabs/api.md +10 -18
  55. package/dist/docs/tabs/examples.md +68 -0
  56. package/dist/docs/tabs/tabs.md +97 -20
  57. package/dist/docs/tabs/usage.md +8 -0
  58. package/dist/docs/textarea/api.md +15 -16
  59. package/dist/docs/textarea/textarea.md +15 -16
  60. package/dist/docs/textfield/api.md +14 -15
  61. package/dist/docs/textfield/textfield.md +14 -15
  62. package/dist/index.d.ts +124 -224
  63. package/dist/packages/breadcrumbs/breadcrumbs.d.ts +7 -1
  64. package/dist/packages/breadcrumbs/breadcrumbs.js.map +2 -2
  65. package/dist/packages/pagination/pagination.test.js +38 -0
  66. package/dist/packages/slider/slider.d.ts +34 -45
  67. package/dist/packages/slider/slider.js +1 -1
  68. package/dist/packages/slider/slider.js.map +2 -2
  69. package/dist/packages/slider-thumb/slider-thumb.d.ts +36 -31
  70. package/dist/packages/slider-thumb/slider-thumb.js +1 -1
  71. package/dist/packages/slider-thumb/slider-thumb.js.map +2 -2
  72. package/dist/packages/tab/tab.d.ts +29 -24
  73. package/dist/packages/tab/tab.js +3 -3
  74. package/dist/packages/tab/tab.js.map +2 -2
  75. package/dist/packages/tab-panel/tab-panel.d.ts +9 -8
  76. package/dist/packages/tab-panel/tab-panel.js +3 -3
  77. package/dist/packages/tab-panel/tab-panel.js.map +2 -2
  78. package/dist/packages/tabs/index.d.ts +1 -0
  79. package/dist/packages/tabs/index.js +0 -1
  80. package/dist/packages/tabs/react.d.ts +4 -3
  81. package/dist/packages/tabs/tabs.d.ts +9 -3
  82. package/dist/packages/tabs/tabs.js.map +2 -2
  83. package/dist/packages/tabs/tabs.react.stories.d.ts +2 -2
  84. package/dist/web-types.json +201 -93
  85. package/package.json +2 -1
  86. package/dist/docs/tab/accessibility.md +0 -1
  87. package/dist/docs/tab/examples.md +0 -1
  88. package/dist/docs/tab/usage.md +0 -1
  89. package/dist/docs/tab-panel/accessibility.md +0 -1
  90. package/dist/docs/tab-panel/examples.md +0 -1
  91. package/dist/docs/tab-panel/usage.md +0 -1
@@ -1 +1,36 @@
1
1
  ## Examples
2
+
3
+ ### Basic
4
+
5
+ <elements-example>
6
+ ```html
7
+ <w-breadcrumbs>
8
+ <a href="#/real-estate">Real estate</a>
9
+ <a href="#/real-estate/homes">Homes for sale</a>
10
+ <span aria-current="page">Oslo</span>
11
+ </w-breadcrumbs>
12
+ ```
13
+ </elements-example>
14
+
15
+ ### Custom Accessible Label
16
+
17
+ <elements-example>
18
+ ```html
19
+ <w-breadcrumbs aria-label="Product category path">
20
+ <a href="#/marketplace">Marketplace</a>
21
+ <a href="#/marketplace/furniture">Furniture</a>
22
+ <span aria-current="page">Sofas</span>
23
+ </w-breadcrumbs>
24
+ ```
25
+ </elements-example>
26
+
27
+ ### Short Path
28
+
29
+ <elements-example>
30
+ ```html
31
+ <w-breadcrumbs>
32
+ <a href="#/help">Help</a>
33
+ <span aria-current="page">Contact us</span>
34
+ </w-breadcrumbs>
35
+ ```
36
+ </elements-example>
@@ -1 +1,37 @@
1
1
  ## Usage
2
+
3
+ Breadcrumbs show where the current page sits in a site hierarchy and let users move back to parent pages.
4
+
5
+ Use `w-breadcrumbs` near the top of a page or section, before the main page heading or primary content. Add each breadcrumb item as a direct child. The component adds separators automatically.
6
+
7
+ ### Basic Breadcrumbs
8
+
9
+ Use links for parent pages and mark the current page with `aria-current="page"`.
10
+
11
+ ```html
12
+ <w-breadcrumbs aria-label="You are here">
13
+ <a href="/real-estate">Real estate</a>
14
+ <a href="/real-estate/homes">Homes for sale</a>
15
+ <span aria-current="page">Oslo</span>
16
+ </w-breadcrumbs>
17
+ ```
18
+
19
+ ### Current Page
20
+
21
+ The current page should be the last breadcrumb item.
22
+
23
+ Use a `span` when the current page should not be clickable:
24
+
25
+ ```html
26
+ <w-breadcrumbs aria-label="You are here">
27
+ <a href="/real-estate">Real estate</a>
28
+ <a href="/real-estate/homes">Homes for sale</a>
29
+ <span aria-current="page">Oslo</span>
30
+ </w-breadcrumbs>
31
+ ```
32
+
33
+ ### Content Guidelines
34
+
35
+ Keep breadcrumb labels short and ordered from broadest section to most specific page. Do not add slash separators yourself; the component inserts them between items.
36
+
37
+ Breadcrumbs should not replace the page heading, primary navigation, or step navigation in a process.
@@ -1,21 +1,23 @@
1
- ## API Documentation
1
+ ## `<w-button>` API
2
+
3
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
2
4
 
3
5
  ### Properties
4
6
 
5
7
  | Name | Type | Default | Summary |
6
8
  |-|-|-|-|
7
- | ariaValueTextLoading | `unknown` | `-` | - |
9
+ | ariaValueTextLoading (JS only) | `unknown` | `-` | - |
8
10
  | autofocus | `boolean` | `false` | - |
9
- | buttonClass | `string` | `-` | **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. |
11
+ | button-class | `string` | `-` | **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. |
10
12
  | disabled | `boolean` | `false` | - |
11
- | fullWidth | `boolean` | `false` | - |
13
+ | full-width | `boolean` | `false` | - |
12
14
  | href | `string` | `-` | - |
13
- | iconOnly | `boolean` | `false` | - |
15
+ | icon-only | `boolean` | `false` | - |
14
16
  | loading | `boolean` | `false` | - |
15
17
  | name | `string` | `-` | - |
16
18
  | quiet | `boolean` | `false` | **Deprecated**: Use `variant="quiet"` instead |
17
19
  | rel | `string` | `-` | - |
18
- | shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
20
+ | shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
19
21
  | small | `boolean` | `false` | - |
20
22
  | target | `string` | `-` | - |
21
23
  | type | [`ButtonType`](#buttontype) | `-` | - |
@@ -24,7 +26,7 @@
24
26
 
25
27
  ### Property Details
26
28
 
27
- #### ariaValueTextLoading
29
+ #### ariaValueTextLoading (JS only)
28
30
 
29
31
 
30
32
 
@@ -38,7 +40,7 @@
38
40
  - Type: `boolean`
39
41
  - Default: `false`
40
42
 
41
- #### buttonClass
43
+ #### button-class
42
44
 
43
45
  **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
44
46
 
@@ -54,7 +56,7 @@
54
56
  - Type: `boolean`
55
57
  - Default: `false`
56
58
 
57
- #### fullWidth
59
+ #### full-width
58
60
 
59
61
 
60
62
 
@@ -68,7 +70,7 @@
68
70
  - Type: `string`
69
71
  - Default: `-`
70
72
 
71
- #### iconOnly
73
+ #### icon-only
72
74
 
73
75
 
74
76
 
@@ -105,7 +107,7 @@
105
107
  - Type: `string`
106
108
  - Default: `-`
107
109
 
108
- #### shadowRootOptions
110
+ #### shadowRootOptions (JS only)
109
111
 
110
112
 
111
113
 
@@ -151,9 +153,9 @@
151
153
 
152
154
  #### ButtonType
153
155
 
154
- `'button' \| 'submit' \| 'reset'`
156
+ `'button' | 'submit' | 'reset'`
155
157
 
156
158
  #### ButtonVariant
157
159
 
158
- `'negative' \| 'primary' \| 'secondary' \| 'negativeQuiet' \| 'utility' \| 'quiet' \| 'utilityQuiet' \| 'overlay' \| 'overlayInverted' \| 'overlayQuiet' \| 'overlayInvertedQuiet' \| 'pill' \| 'link'`
160
+ `'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link'`
159
161
 
@@ -12,24 +12,26 @@ Buttons are used to perform actions, widh different visuals for different needs.
12
12
 
13
13
  ## Examples
14
14
 
15
- ## API Documentation
15
+ ## `<w-button>` API
16
+
17
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
16
18
 
17
19
  ### Properties
18
20
 
19
21
  | Name | Type | Default | Summary |
20
22
  |-|-|-|-|
21
- | ariaValueTextLoading | `unknown` | `-` | - |
23
+ | ariaValueTextLoading (JS only) | `unknown` | `-` | - |
22
24
  | autofocus | `boolean` | `false` | - |
23
- | buttonClass | `string` | `-` | **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. |
25
+ | button-class | `string` | `-` | **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button. |
24
26
  | disabled | `boolean` | `false` | - |
25
- | fullWidth | `boolean` | `false` | - |
27
+ | full-width | `boolean` | `false` | - |
26
28
  | href | `string` | `-` | - |
27
- | iconOnly | `boolean` | `false` | - |
29
+ | icon-only | `boolean` | `false` | - |
28
30
  | loading | `boolean` | `false` | - |
29
31
  | name | `string` | `-` | - |
30
32
  | quiet | `boolean` | `false` | **Deprecated**: Use `variant="quiet"` instead |
31
33
  | rel | `string` | `-` | - |
32
- | shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
34
+ | shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
33
35
  | small | `boolean` | `false` | - |
34
36
  | target | `string` | `-` | - |
35
37
  | type | [`ButtonType`](#buttontype) | `-` | - |
@@ -38,7 +40,7 @@ Buttons are used to perform actions, widh different visuals for different needs.
38
40
 
39
41
  ### Property Details
40
42
 
41
- #### ariaValueTextLoading
43
+ #### ariaValueTextLoading (JS only)
42
44
 
43
45
 
44
46
 
@@ -52,7 +54,7 @@ Buttons are used to perform actions, widh different visuals for different needs.
52
54
  - Type: `boolean`
53
55
  - Default: `false`
54
56
 
55
- #### buttonClass
57
+ #### button-class
56
58
 
57
59
  **Deprecated**: This class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the appearance of the button.
58
60
 
@@ -68,7 +70,7 @@ Buttons are used to perform actions, widh different visuals for different needs.
68
70
  - Type: `boolean`
69
71
  - Default: `false`
70
72
 
71
- #### fullWidth
73
+ #### full-width
72
74
 
73
75
 
74
76
 
@@ -82,7 +84,7 @@ Buttons are used to perform actions, widh different visuals for different needs.
82
84
  - Type: `string`
83
85
  - Default: `-`
84
86
 
85
- #### iconOnly
87
+ #### icon-only
86
88
 
87
89
 
88
90
 
@@ -119,7 +121,7 @@ Buttons are used to perform actions, widh different visuals for different needs.
119
121
  - Type: `string`
120
122
  - Default: `-`
121
123
 
122
- #### shadowRootOptions
124
+ #### shadowRootOptions (JS only)
123
125
 
124
126
 
125
127
 
@@ -165,9 +167,9 @@ Buttons are used to perform actions, widh different visuals for different needs.
165
167
 
166
168
  #### ButtonType
167
169
 
168
- `'button' \| 'submit' \| 'reset'`
170
+ `'button' | 'submit' | 'reset'`
169
171
 
170
172
  #### ButtonVariant
171
173
 
172
- `'negative' \| 'primary' \| 'secondary' \| 'negativeQuiet' \| 'utility' \| 'quiet' \| 'utilityQuiet' \| 'overlay' \| 'overlayInverted' \| 'overlayQuiet' \| 'overlayInvertedQuiet' \| 'pill' \| 'link'`
174
+ `'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link'`
173
175
 
@@ -1,17 +1,19 @@
1
- ## API Documentation
1
+ ## `<w-card>` API
2
+
3
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
2
4
 
3
5
  ### Properties
4
6
 
5
7
  | Name | Type | Default | Summary |
6
8
  |-|-|-|-|
7
- | buttonText | `unknown` | `-` | - |
9
+ | buttonText (JS only) | `unknown` | `-` | - |
8
10
  | clickable | `boolean` | `false` | - |
9
11
  | flat | `boolean` | `false` | - |
10
12
  | selected | `boolean` | `false` | - |
11
13
 
12
14
  ### Property Details
13
15
 
14
- #### buttonText
16
+ #### buttonText (JS only)
15
17
 
16
18
 
17
19
 
@@ -39,6 +41,3 @@
39
41
  - Type: `boolean`
40
42
  - Default: `false`
41
43
 
42
- ### Types
43
-
44
- No types documented.
@@ -12,20 +12,22 @@ Card is a layout component used for separating content areas on a page.
12
12
 
13
13
  ## Examples
14
14
 
15
- ## API Documentation
15
+ ## `<w-card>` API
16
+
17
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
16
18
 
17
19
  ### Properties
18
20
 
19
21
  | Name | Type | Default | Summary |
20
22
  |-|-|-|-|
21
- | buttonText | `unknown` | `-` | - |
23
+ | buttonText (JS only) | `unknown` | `-` | - |
22
24
  | clickable | `boolean` | `false` | - |
23
25
  | flat | `boolean` | `false` | - |
24
26
  | selected | `boolean` | `false` | - |
25
27
 
26
28
  ### Property Details
27
29
 
28
- #### buttonText
30
+ #### buttonText (JS only)
29
31
 
30
32
 
31
33
 
@@ -53,6 +55,3 @@ Card is a layout component used for separating content areas on a page.
53
55
  - Type: `boolean`
54
56
  - Default: `false`
55
57
 
56
- ### Types
57
-
58
- No types documented.
@@ -1,23 +1,25 @@
1
- ## API Documentation
1
+ ## `<w-combobox>` API
2
+
3
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
2
4
 
3
5
  ### Properties
4
6
 
5
7
  | Name | Type | Default | Summary |
6
8
  |-|-|-|-|
7
9
  | autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
8
- | disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
10
+ | disable-static-filtering | `boolean` | `false` | Disable client-side static filtering |
9
11
  | disabled | `boolean` | `false` | Whether the element is disabled |
10
- | helpText | `string \| undefined` | `''` | The content to display as the help text |
12
+ | help-text | `string \| undefined` | `''` | The content to display as the help text |
11
13
  | invalid | `boolean` | `false` | Renders the input field in an invalid state |
12
14
  | label | `string \| undefined` | `''` | Label above input |
13
- | matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
15
+ | match-text-segments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
14
16
  | name | `string \| undefined` | `''` | Name attribute for form submission |
15
- | openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
17
+ | open-on-focus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
16
18
  | optional | `boolean` | `false` | Whether to show optional text |
17
19
  | options | `ComboboxOption[]` | `[]` | The available options to select from |
18
20
  | placeholder | `string \| undefined` | `''` | Input placeholder |
19
21
  | required | `boolean` | `false` | Whether the element is required |
20
- | selectOnBlur | `boolean` | `true` | Select active option on blur |
22
+ | select-on-blur | `boolean` | `true` | Select active option on blur |
21
23
  | value | `string` | `''` | The input value |
22
24
 
23
25
  ### Property Details
@@ -26,10 +28,10 @@
26
28
 
27
29
  Autocomplete attribute for the input field
28
30
 
29
- - Type: `string \| undefined`
31
+ - Type: `string | undefined`
30
32
  - Default: `'off'`
31
33
 
32
- #### disableStaticFiltering
34
+ #### disable-static-filtering
33
35
 
34
36
  Disable client-side static filtering
35
37
 
@@ -43,11 +45,11 @@ Whether the element is disabled
43
45
  - Type: `boolean`
44
46
  - Default: `false`
45
47
 
46
- #### helpText
48
+ #### help-text
47
49
 
48
50
  The content to display as the help text
49
51
 
50
- - Type: `string \| undefined`
52
+ - Type: `string | undefined`
51
53
  - Default: `''`
52
54
 
53
55
  #### invalid
@@ -61,10 +63,10 @@ Renders the input field in an invalid state
61
63
 
62
64
  Label above input
63
65
 
64
- - Type: `string \| undefined`
66
+ - Type: `string | undefined`
65
67
  - Default: `''`
66
68
 
67
- #### matchTextSegments
69
+ #### match-text-segments
68
70
 
69
71
  Whether the matching text segments in the options should be highlighted
70
72
 
@@ -75,10 +77,10 @@ Whether the matching text segments in the options should be highlighted
75
77
 
76
78
  Name attribute for form submission
77
79
 
78
- - Type: `string \| undefined`
80
+ - Type: `string | undefined`
79
81
  - Default: `''`
80
82
 
81
- #### openOnFocus
83
+ #### open-on-focus
82
84
 
83
85
  Whether the popover opens when focus is on the text field
84
86
 
@@ -103,7 +105,7 @@ The available options to select from
103
105
 
104
106
  Input placeholder
105
107
 
106
- - Type: `string \| undefined`
108
+ - Type: `string | undefined`
107
109
  - Default: `''`
108
110
 
109
111
  #### required
@@ -113,7 +115,7 @@ Whether the element is required
113
115
  - Type: `boolean`
114
116
  - Default: `false`
115
117
 
116
- #### selectOnBlur
118
+ #### select-on-blur
117
119
 
118
120
  Select active option on blur
119
121
 
@@ -127,6 +129,3 @@ The input value
127
129
  - Type: `string`
128
130
  - Default: `''`
129
131
 
130
- ### Types
131
-
132
- No types documented.
@@ -12,26 +12,28 @@ A combobox element for text input with selectable options.
12
12
 
13
13
  ## Examples
14
14
 
15
- ## API Documentation
15
+ ## `<w-combobox>` API
16
+
17
+ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
16
18
 
17
19
  ### Properties
18
20
 
19
21
  | Name | Type | Default | Summary |
20
22
  |-|-|-|-|
21
23
  | autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
22
- | disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
24
+ | disable-static-filtering | `boolean` | `false` | Disable client-side static filtering |
23
25
  | disabled | `boolean` | `false` | Whether the element is disabled |
24
- | helpText | `string \| undefined` | `''` | The content to display as the help text |
26
+ | help-text | `string \| undefined` | `''` | The content to display as the help text |
25
27
  | invalid | `boolean` | `false` | Renders the input field in an invalid state |
26
28
  | label | `string \| undefined` | `''` | Label above input |
27
- | matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
29
+ | match-text-segments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
28
30
  | name | `string \| undefined` | `''` | Name attribute for form submission |
29
- | openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
31
+ | open-on-focus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
30
32
  | optional | `boolean` | `false` | Whether to show optional text |
31
33
  | options | `ComboboxOption[]` | `[]` | The available options to select from |
32
34
  | placeholder | `string \| undefined` | `''` | Input placeholder |
33
35
  | required | `boolean` | `false` | Whether the element is required |
34
- | selectOnBlur | `boolean` | `true` | Select active option on blur |
36
+ | select-on-blur | `boolean` | `true` | Select active option on blur |
35
37
  | value | `string` | `''` | The input value |
36
38
 
37
39
  ### Property Details
@@ -40,10 +42,10 @@ A combobox element for text input with selectable options.
40
42
 
41
43
  Autocomplete attribute for the input field
42
44
 
43
- - Type: `string \| undefined`
45
+ - Type: `string | undefined`
44
46
  - Default: `'off'`
45
47
 
46
- #### disableStaticFiltering
48
+ #### disable-static-filtering
47
49
 
48
50
  Disable client-side static filtering
49
51
 
@@ -57,11 +59,11 @@ Whether the element is disabled
57
59
  - Type: `boolean`
58
60
  - Default: `false`
59
61
 
60
- #### helpText
62
+ #### help-text
61
63
 
62
64
  The content to display as the help text
63
65
 
64
- - Type: `string \| undefined`
66
+ - Type: `string | undefined`
65
67
  - Default: `''`
66
68
 
67
69
  #### invalid
@@ -75,10 +77,10 @@ Renders the input field in an invalid state
75
77
 
76
78
  Label above input
77
79
 
78
- - Type: `string \| undefined`
80
+ - Type: `string | undefined`
79
81
  - Default: `''`
80
82
 
81
- #### matchTextSegments
83
+ #### match-text-segments
82
84
 
83
85
  Whether the matching text segments in the options should be highlighted
84
86
 
@@ -89,10 +91,10 @@ Whether the matching text segments in the options should be highlighted
89
91
 
90
92
  Name attribute for form submission
91
93
 
92
- - Type: `string \| undefined`
94
+ - Type: `string | undefined`
93
95
  - Default: `''`
94
96
 
95
- #### openOnFocus
97
+ #### open-on-focus
96
98
 
97
99
  Whether the popover opens when focus is on the text field
98
100
 
@@ -117,7 +119,7 @@ The available options to select from
117
119
 
118
120
  Input placeholder
119
121
 
120
- - Type: `string \| undefined`
122
+ - Type: `string | undefined`
121
123
  - Default: `''`
122
124
 
123
125
  #### required
@@ -127,7 +129,7 @@ Whether the element is required
127
129
  - Type: `boolean`
128
130
  - Default: `false`
129
131
 
130
- #### selectOnBlur
132
+ #### select-on-blur
131
133
 
132
134
  Select active option on blur
133
135
 
@@ -141,6 +143,3 @@ The input value
141
143
  - Type: `string`
142
144
  - Default: `''`
143
145
 
144
- ### Types
145
-
146
- No types documented.