@warp-ds/elements 2.9.0-next.5 → 2.9.0-next.6
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.
- package/dist/custom-elements.json +159 -97
- package/dist/docs/affix/affix.md +25 -23
- package/dist/docs/affix/api.md +25 -23
- package/dist/docs/alert/alert.md +12 -12
- package/dist/docs/alert/api.md +12 -12
- package/dist/docs/attention/api.md +46 -46
- package/dist/docs/attention/attention.md +46 -46
- package/dist/docs/badge/accessibility.md +44 -0
- package/dist/docs/badge/api.md +12 -8
- package/dist/docs/badge/badge.md +191 -10
- package/dist/docs/badge/examples.md +82 -0
- package/dist/docs/badge/usage.md +53 -0
- package/dist/docs/button/api.md +46 -42
- package/dist/docs/button/button.md +46 -42
- package/dist/docs/card/api.md +11 -11
- package/dist/docs/card/card.md +11 -11
- package/dist/docs/combobox/api.md +62 -62
- package/dist/docs/combobox/combobox.md +62 -62
- package/dist/docs/datepicker/api.md +74 -66
- package/dist/docs/datepicker/datepicker.md +74 -66
- package/dist/docs/expandable/api.md +26 -26
- package/dist/docs/expandable/expandable.md +26 -26
- package/dist/docs/link/api.md +28 -28
- package/dist/docs/link/link.md +28 -28
- package/dist/docs/page-indicator/api.md +6 -6
- package/dist/docs/page-indicator/page-indicator.md +6 -6
- package/dist/docs/pagination/api.md +3 -3
- package/dist/docs/pagination/pagination.md +3 -3
- package/dist/docs/pill/api.md +19 -15
- package/dist/docs/pill/pill.md +19 -15
- package/dist/docs/select/api.md +44 -44
- package/dist/docs/select/select.md +44 -44
- package/dist/docs/slider/api.md +80 -78
- package/dist/docs/slider/slider.md +80 -78
- package/dist/docs/slider-thumb/api.md +28 -76
- package/dist/docs/slider-thumb/slider-thumb.md +28 -76
- package/dist/docs/switch/api.md +16 -16
- package/dist/docs/switch/switch.md +16 -16
- package/dist/docs/tab/api.md +26 -40
- package/dist/docs/tab/tab.md +26 -40
- package/dist/docs/tab-panel/api.md +1 -17
- package/dist/docs/tab-panel/tab-panel.md +1 -17
- package/dist/docs/tabs/api.md +3 -3
- package/dist/docs/tabs/tabs.md +3 -3
- package/dist/docs/textarea/api.md +42 -40
- package/dist/docs/textarea/textarea.md +42 -40
- package/dist/docs/textfield/accessibility.md +15 -0
- package/dist/docs/textfield/api.md +86 -83
- package/dist/docs/textfield/examples.md +147 -0
- package/dist/docs/textfield/textfield.md +279 -86
- package/dist/docs/textfield/usage.md +30 -0
- package/dist/index.d.ts +220 -196
- package/dist/packages/badge/badge.d.ts +7 -5
- package/dist/packages/badge/badge.js.map +2 -2
- package/dist/packages/datepicker/datepicker.js +1 -1
- package/dist/packages/datepicker/datepicker.js.map +2 -2
- package/dist/packages/datepicker/datepicker.react.stories.d.ts +9 -1
- package/dist/packages/datepicker/react.d.ts +4 -0
- package/dist/packages/datepicker/react.js +4 -0
- package/dist/packages/textfield/textfield.d.ts +57 -60
- package/dist/packages/textfield/textfield.js +5 -5
- package/dist/packages/textfield/textfield.js.map +2 -2
- package/dist/packages/textfield/textfield.react.stories.d.ts +1 -1
- package/dist/web-types.json +392 -116
- package/package.json +1 -1
|
@@ -18,38 +18,31 @@ Buttons are used to perform actions, widh different visuals for different needs.
|
|
|
18
18
|
|
|
19
19
|
| Name | Type | Default | Summary |
|
|
20
20
|
|-|-|-|-|
|
|
21
|
-
|
|
|
22
|
-
| type | [`ButtonType`](#buttontype) | `-` | - |
|
|
21
|
+
| ariaValueTextLoading | `unknown` | `-` | - |
|
|
23
22
|
| autofocus | `boolean` | `false` | - |
|
|
24
|
-
|
|
|
25
|
-
| quiet | `boolean` | `false` | - |
|
|
26
|
-
| iconOnly | `boolean` | `false` | - |
|
|
27
|
-
| small | `boolean` | `false` | - |
|
|
28
|
-
| loading | `boolean` | `false` | - |
|
|
29
|
-
| href | `string` | `-` | - |
|
|
30
|
-
| target | `string` | `-` | - |
|
|
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. |
|
|
31
24
|
| disabled | `boolean` | `false` | - |
|
|
32
|
-
| rel | `string` | `-` | - |
|
|
33
25
|
| fullWidth | `boolean` | `false` | - |
|
|
34
|
-
|
|
|
26
|
+
| href | `string` | `-` | - |
|
|
27
|
+
| iconOnly | `boolean` | `false` | - |
|
|
28
|
+
| loading | `boolean` | `false` | - |
|
|
35
29
|
| name | `string` | `-` | - |
|
|
30
|
+
| quiet | `boolean` | `false` | **Deprecated**: Use `variant="quiet"` instead |
|
|
31
|
+
| rel | `string` | `-` | - |
|
|
32
|
+
| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
|
|
33
|
+
| small | `boolean` | `false` | - |
|
|
34
|
+
| target | `string` | `-` | - |
|
|
35
|
+
| type | [`ButtonType`](#buttontype) | `-` | - |
|
|
36
36
|
| value | `string` | `-` | - |
|
|
37
|
-
|
|
|
37
|
+
| variant | [`ButtonVariant`](#buttonvariant) | `-` | - |
|
|
38
38
|
|
|
39
39
|
### Property Details
|
|
40
40
|
|
|
41
|
-
####
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
- Type: `object`
|
|
46
|
-
- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
|
|
47
|
-
|
|
48
|
-
#### type
|
|
41
|
+
#### ariaValueTextLoading
|
|
49
42
|
|
|
50
43
|
|
|
51
44
|
|
|
52
|
-
- Type:
|
|
45
|
+
- Type: `unknown`
|
|
53
46
|
- Default: `-`
|
|
54
47
|
|
|
55
48
|
#### autofocus
|
|
@@ -59,56 +52,60 @@ Buttons are used to perform actions, widh different visuals for different needs.
|
|
|
59
52
|
- Type: `boolean`
|
|
60
53
|
- Default: `false`
|
|
61
54
|
|
|
62
|
-
####
|
|
55
|
+
#### buttonClass
|
|
63
56
|
|
|
57
|
+
**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.
|
|
64
58
|
|
|
65
59
|
|
|
66
|
-
|
|
60
|
+
|
|
61
|
+
- Type: `string`
|
|
67
62
|
- Default: `-`
|
|
68
63
|
|
|
69
|
-
####
|
|
64
|
+
#### disabled
|
|
70
65
|
|
|
71
66
|
|
|
72
67
|
|
|
73
68
|
- Type: `boolean`
|
|
74
69
|
- Default: `false`
|
|
75
70
|
|
|
76
|
-
####
|
|
71
|
+
#### fullWidth
|
|
77
72
|
|
|
78
73
|
|
|
79
74
|
|
|
80
75
|
- Type: `boolean`
|
|
81
76
|
- Default: `false`
|
|
82
77
|
|
|
83
|
-
####
|
|
78
|
+
#### href
|
|
84
79
|
|
|
85
80
|
|
|
86
81
|
|
|
87
|
-
- Type: `
|
|
88
|
-
- Default:
|
|
82
|
+
- Type: `string`
|
|
83
|
+
- Default: `-`
|
|
89
84
|
|
|
90
|
-
####
|
|
85
|
+
#### iconOnly
|
|
91
86
|
|
|
92
87
|
|
|
93
88
|
|
|
94
89
|
- Type: `boolean`
|
|
95
90
|
- Default: `false`
|
|
96
91
|
|
|
97
|
-
####
|
|
92
|
+
#### loading
|
|
98
93
|
|
|
99
94
|
|
|
100
95
|
|
|
101
|
-
- Type: `
|
|
102
|
-
- Default:
|
|
96
|
+
- Type: `boolean`
|
|
97
|
+
- Default: `false`
|
|
103
98
|
|
|
104
|
-
####
|
|
99
|
+
#### name
|
|
105
100
|
|
|
106
101
|
|
|
107
102
|
|
|
108
103
|
- Type: `string`
|
|
109
104
|
- Default: `-`
|
|
110
105
|
|
|
111
|
-
####
|
|
106
|
+
#### quiet
|
|
107
|
+
|
|
108
|
+
**Deprecated**: Use `variant="quiet"` instead
|
|
112
109
|
|
|
113
110
|
|
|
114
111
|
|
|
@@ -122,25 +119,32 @@ Buttons are used to perform actions, widh different visuals for different needs.
|
|
|
122
119
|
- Type: `string`
|
|
123
120
|
- Default: `-`
|
|
124
121
|
|
|
125
|
-
####
|
|
122
|
+
#### shadowRootOptions
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
- Type: `object`
|
|
127
|
+
- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
|
|
128
|
+
|
|
129
|
+
#### small
|
|
126
130
|
|
|
127
131
|
|
|
128
132
|
|
|
129
133
|
- Type: `boolean`
|
|
130
134
|
- Default: `false`
|
|
131
135
|
|
|
132
|
-
####
|
|
136
|
+
#### target
|
|
133
137
|
|
|
134
138
|
|
|
135
139
|
|
|
136
140
|
- Type: `string`
|
|
137
141
|
- Default: `-`
|
|
138
142
|
|
|
139
|
-
####
|
|
143
|
+
#### type
|
|
140
144
|
|
|
141
145
|
|
|
142
146
|
|
|
143
|
-
- Type: `
|
|
147
|
+
- Type: [`ButtonType`](#buttontype)
|
|
144
148
|
- Default: `-`
|
|
145
149
|
|
|
146
150
|
#### value
|
|
@@ -150,20 +154,20 @@ Buttons are used to perform actions, widh different visuals for different needs.
|
|
|
150
154
|
- Type: `string`
|
|
151
155
|
- Default: `-`
|
|
152
156
|
|
|
153
|
-
####
|
|
157
|
+
#### variant
|
|
154
158
|
|
|
155
159
|
|
|
156
160
|
|
|
157
|
-
- Type: `
|
|
161
|
+
- Type: [`ButtonVariant`](#buttonvariant)
|
|
158
162
|
- Default: `-`
|
|
159
163
|
|
|
160
164
|
### Types
|
|
161
165
|
|
|
162
166
|
#### ButtonType
|
|
163
167
|
|
|
164
|
-
`'button'
|
|
168
|
+
`'button' \| 'submit' \| 'reset'`
|
|
165
169
|
|
|
166
170
|
#### ButtonVariant
|
|
167
171
|
|
|
168
|
-
`'negative'
|
|
172
|
+
`'negative' \| 'primary' \| 'secondary' \| 'negativeQuiet' \| 'utility' \| 'quiet' \| 'utilityQuiet' \| 'overlay' \| 'overlayInverted' \| 'overlayQuiet' \| 'overlayInvertedQuiet' \| 'pill' \| 'link'`
|
|
169
173
|
|
package/dist/docs/card/api.md
CHANGED
|
@@ -4,40 +4,40 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Default | Summary |
|
|
6
6
|
|-|-|-|-|
|
|
7
|
-
| selected | `boolean` | `false` | - |
|
|
8
|
-
| flat | `boolean` | `false` | - |
|
|
9
|
-
| clickable | `boolean` | `false` | - |
|
|
10
7
|
| buttonText | `unknown` | `-` | - |
|
|
8
|
+
| clickable | `boolean` | `false` | - |
|
|
9
|
+
| flat | `boolean` | `false` | - |
|
|
10
|
+
| selected | `boolean` | `false` | - |
|
|
11
11
|
|
|
12
12
|
### Property Details
|
|
13
13
|
|
|
14
|
-
####
|
|
14
|
+
#### buttonText
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
18
|
-
- Type: `
|
|
19
|
-
- Default:
|
|
18
|
+
- Type: `unknown`
|
|
19
|
+
- Default: `-`
|
|
20
20
|
|
|
21
|
-
####
|
|
21
|
+
#### clickable
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
- Type: `boolean`
|
|
26
26
|
- Default: `false`
|
|
27
27
|
|
|
28
|
-
####
|
|
28
|
+
#### flat
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
- Type: `boolean`
|
|
33
33
|
- Default: `false`
|
|
34
34
|
|
|
35
|
-
####
|
|
35
|
+
#### selected
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
39
|
-
- Type: `
|
|
40
|
-
- Default:
|
|
39
|
+
- Type: `boolean`
|
|
40
|
+
- Default: `false`
|
|
41
41
|
|
|
42
42
|
### Types
|
|
43
43
|
|
package/dist/docs/card/card.md
CHANGED
|
@@ -18,40 +18,40 @@ Card is a layout component used for separating content areas on a page.
|
|
|
18
18
|
|
|
19
19
|
| Name | Type | Default | Summary |
|
|
20
20
|
|-|-|-|-|
|
|
21
|
-
| selected | `boolean` | `false` | - |
|
|
22
|
-
| flat | `boolean` | `false` | - |
|
|
23
|
-
| clickable | `boolean` | `false` | - |
|
|
24
21
|
| buttonText | `unknown` | `-` | - |
|
|
22
|
+
| clickable | `boolean` | `false` | - |
|
|
23
|
+
| flat | `boolean` | `false` | - |
|
|
24
|
+
| selected | `boolean` | `false` | - |
|
|
25
25
|
|
|
26
26
|
### Property Details
|
|
27
27
|
|
|
28
|
-
####
|
|
28
|
+
#### buttonText
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
- Type: `
|
|
33
|
-
- Default:
|
|
32
|
+
- Type: `unknown`
|
|
33
|
+
- Default: `-`
|
|
34
34
|
|
|
35
|
-
####
|
|
35
|
+
#### clickable
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
- Type: `boolean`
|
|
40
40
|
- Default: `false`
|
|
41
41
|
|
|
42
|
-
####
|
|
42
|
+
#### flat
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
- Type: `boolean`
|
|
47
47
|
- Default: `false`
|
|
48
48
|
|
|
49
|
-
####
|
|
49
|
+
#### selected
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
|
53
|
-
- Type: `
|
|
54
|
-
- Default:
|
|
53
|
+
- Type: `boolean`
|
|
54
|
+
- Default: `false`
|
|
55
55
|
|
|
56
56
|
### Types
|
|
57
57
|
|
|
@@ -4,129 +4,129 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Default | Summary |
|
|
6
6
|
|-|-|-|-|
|
|
7
|
-
|
|
|
8
|
-
|
|
|
9
|
-
|
|
|
10
|
-
|
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
| matchTextSegments | `boolean` | `false` |
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
|
|
|
21
|
-
|
|
|
7
|
+
| autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
|
|
8
|
+
| disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
|
|
9
|
+
| disabled | `boolean` | `false` | Whether the element is disabled |
|
|
10
|
+
| helpText | `string \| undefined` | `''` | The content to display as the help text |
|
|
11
|
+
| invalid | `boolean` | `false` | Renders the input field in an invalid state |
|
|
12
|
+
| label | `string \| undefined` | `''` | Label above input |
|
|
13
|
+
| matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
|
|
14
|
+
| name | `string \| undefined` | `''` | Name attribute for form submission |
|
|
15
|
+
| openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
|
|
16
|
+
| optional | `boolean` | `false` | Whether to show optional text |
|
|
17
|
+
| options | `ComboboxOption[]` | `[]` | The available options to select from |
|
|
18
|
+
| placeholder | `string \| undefined` | `''` | Input placeholder |
|
|
19
|
+
| required | `boolean` | `false` | Whether the element is required |
|
|
20
|
+
| selectOnBlur | `boolean` | `true` | Select active option on blur |
|
|
21
|
+
| value | `string` | `''` | The input value |
|
|
22
22
|
|
|
23
23
|
### Property Details
|
|
24
24
|
|
|
25
|
-
####
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
- Type: `ComboboxOption[]`
|
|
30
|
-
- Default: `[]`
|
|
31
|
-
|
|
32
|
-
#### label
|
|
25
|
+
#### autocomplete
|
|
33
26
|
|
|
27
|
+
Autocomplete attribute for the input field
|
|
34
28
|
|
|
29
|
+
- Type: `string \| undefined`
|
|
30
|
+
- Default: `'off'`
|
|
35
31
|
|
|
36
|
-
|
|
37
|
-
- Default: `''`
|
|
32
|
+
#### disableStaticFiltering
|
|
38
33
|
|
|
39
|
-
|
|
34
|
+
Disable client-side static filtering
|
|
40
35
|
|
|
36
|
+
- Type: `boolean`
|
|
37
|
+
- Default: `false`
|
|
41
38
|
|
|
39
|
+
#### disabled
|
|
42
40
|
|
|
43
|
-
|
|
44
|
-
- Default: `''`
|
|
41
|
+
Whether the element is disabled
|
|
45
42
|
|
|
46
|
-
|
|
43
|
+
- Type: `boolean`
|
|
44
|
+
- Default: `false`
|
|
47
45
|
|
|
46
|
+
#### helpText
|
|
48
47
|
|
|
48
|
+
The content to display as the help text
|
|
49
49
|
|
|
50
|
-
- Type: `string`
|
|
50
|
+
- Type: `string \| undefined`
|
|
51
51
|
- Default: `''`
|
|
52
52
|
|
|
53
|
-
####
|
|
54
|
-
|
|
53
|
+
#### invalid
|
|
55
54
|
|
|
55
|
+
Renders the input field in an invalid state
|
|
56
56
|
|
|
57
57
|
- Type: `boolean`
|
|
58
58
|
- Default: `false`
|
|
59
59
|
|
|
60
|
-
####
|
|
61
|
-
|
|
60
|
+
#### label
|
|
62
61
|
|
|
62
|
+
Label above input
|
|
63
63
|
|
|
64
|
-
- Type: `
|
|
65
|
-
- Default: `
|
|
64
|
+
- Type: `string \| undefined`
|
|
65
|
+
- Default: `''`
|
|
66
66
|
|
|
67
67
|
#### matchTextSegments
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Whether the matching text segments in the options should be highlighted
|
|
70
70
|
|
|
71
71
|
- Type: `boolean`
|
|
72
72
|
- Default: `false`
|
|
73
73
|
|
|
74
|
-
####
|
|
74
|
+
#### name
|
|
75
75
|
|
|
76
|
+
Name attribute for form submission
|
|
76
77
|
|
|
78
|
+
- Type: `string \| undefined`
|
|
79
|
+
- Default: `''`
|
|
80
|
+
|
|
81
|
+
#### openOnFocus
|
|
82
|
+
|
|
83
|
+
Whether the popover opens when focus is on the text field
|
|
77
84
|
|
|
78
85
|
- Type: `boolean`
|
|
79
86
|
- Default: `false`
|
|
80
87
|
|
|
81
|
-
####
|
|
82
|
-
|
|
88
|
+
#### optional
|
|
83
89
|
|
|
90
|
+
Whether to show optional text
|
|
84
91
|
|
|
85
92
|
- Type: `boolean`
|
|
86
93
|
- Default: `false`
|
|
87
94
|
|
|
88
|
-
####
|
|
89
|
-
|
|
90
|
-
|
|
95
|
+
#### options
|
|
91
96
|
|
|
92
|
-
|
|
93
|
-
- Default: `''`
|
|
97
|
+
The available options to select from
|
|
94
98
|
|
|
95
|
-
|
|
99
|
+
- Type: `ComboboxOption[]`
|
|
100
|
+
- Default: `[]`
|
|
96
101
|
|
|
102
|
+
#### placeholder
|
|
97
103
|
|
|
104
|
+
Input placeholder
|
|
98
105
|
|
|
99
|
-
- Type: `
|
|
100
|
-
- Default: `
|
|
106
|
+
- Type: `string \| undefined`
|
|
107
|
+
- Default: `''`
|
|
101
108
|
|
|
102
109
|
#### required
|
|
103
110
|
|
|
104
|
-
|
|
111
|
+
Whether the element is required
|
|
105
112
|
|
|
106
113
|
- Type: `boolean`
|
|
107
114
|
- Default: `false`
|
|
108
115
|
|
|
109
|
-
####
|
|
110
|
-
|
|
116
|
+
#### selectOnBlur
|
|
111
117
|
|
|
118
|
+
Select active option on blur
|
|
112
119
|
|
|
113
120
|
- Type: `boolean`
|
|
114
|
-
- Default: `
|
|
115
|
-
|
|
116
|
-
#### name
|
|
121
|
+
- Default: `true`
|
|
117
122
|
|
|
123
|
+
#### value
|
|
118
124
|
|
|
125
|
+
The input value
|
|
119
126
|
|
|
120
|
-
- Type: `string
|
|
127
|
+
- Type: `string`
|
|
121
128
|
- Default: `''`
|
|
122
129
|
|
|
123
|
-
#### autocomplete
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
- Type: `string | undefined`
|
|
128
|
-
- Default: `'off'`
|
|
129
|
-
|
|
130
130
|
### Types
|
|
131
131
|
|
|
132
132
|
No types documented.
|
|
@@ -18,129 +18,129 @@ A combobox element for text input with selectable options.
|
|
|
18
18
|
|
|
19
19
|
| Name | Type | Default | Summary |
|
|
20
20
|
|-|-|-|-|
|
|
21
|
-
|
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
| matchTextSegments | `boolean` | `false` |
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
21
|
+
| autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
|
|
22
|
+
| disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
|
|
23
|
+
| disabled | `boolean` | `false` | Whether the element is disabled |
|
|
24
|
+
| helpText | `string \| undefined` | `''` | The content to display as the help text |
|
|
25
|
+
| invalid | `boolean` | `false` | Renders the input field in an invalid state |
|
|
26
|
+
| label | `string \| undefined` | `''` | Label above input |
|
|
27
|
+
| matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
|
|
28
|
+
| name | `string \| undefined` | `''` | Name attribute for form submission |
|
|
29
|
+
| openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
|
|
30
|
+
| optional | `boolean` | `false` | Whether to show optional text |
|
|
31
|
+
| options | `ComboboxOption[]` | `[]` | The available options to select from |
|
|
32
|
+
| placeholder | `string \| undefined` | `''` | Input placeholder |
|
|
33
|
+
| required | `boolean` | `false` | Whether the element is required |
|
|
34
|
+
| selectOnBlur | `boolean` | `true` | Select active option on blur |
|
|
35
|
+
| value | `string` | `''` | The input value |
|
|
36
36
|
|
|
37
37
|
### Property Details
|
|
38
38
|
|
|
39
|
-
####
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
- Type: `ComboboxOption[]`
|
|
44
|
-
- Default: `[]`
|
|
45
|
-
|
|
46
|
-
#### label
|
|
39
|
+
#### autocomplete
|
|
47
40
|
|
|
41
|
+
Autocomplete attribute for the input field
|
|
48
42
|
|
|
43
|
+
- Type: `string \| undefined`
|
|
44
|
+
- Default: `'off'`
|
|
49
45
|
|
|
50
|
-
|
|
51
|
-
- Default: `''`
|
|
46
|
+
#### disableStaticFiltering
|
|
52
47
|
|
|
53
|
-
|
|
48
|
+
Disable client-side static filtering
|
|
54
49
|
|
|
50
|
+
- Type: `boolean`
|
|
51
|
+
- Default: `false`
|
|
55
52
|
|
|
53
|
+
#### disabled
|
|
56
54
|
|
|
57
|
-
|
|
58
|
-
- Default: `''`
|
|
55
|
+
Whether the element is disabled
|
|
59
56
|
|
|
60
|
-
|
|
57
|
+
- Type: `boolean`
|
|
58
|
+
- Default: `false`
|
|
61
59
|
|
|
60
|
+
#### helpText
|
|
62
61
|
|
|
62
|
+
The content to display as the help text
|
|
63
63
|
|
|
64
|
-
- Type: `string`
|
|
64
|
+
- Type: `string \| undefined`
|
|
65
65
|
- Default: `''`
|
|
66
66
|
|
|
67
|
-
####
|
|
68
|
-
|
|
67
|
+
#### invalid
|
|
69
68
|
|
|
69
|
+
Renders the input field in an invalid state
|
|
70
70
|
|
|
71
71
|
- Type: `boolean`
|
|
72
72
|
- Default: `false`
|
|
73
73
|
|
|
74
|
-
####
|
|
75
|
-
|
|
74
|
+
#### label
|
|
76
75
|
|
|
76
|
+
Label above input
|
|
77
77
|
|
|
78
|
-
- Type: `
|
|
79
|
-
- Default: `
|
|
78
|
+
- Type: `string \| undefined`
|
|
79
|
+
- Default: `''`
|
|
80
80
|
|
|
81
81
|
#### matchTextSegments
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
Whether the matching text segments in the options should be highlighted
|
|
84
84
|
|
|
85
85
|
- Type: `boolean`
|
|
86
86
|
- Default: `false`
|
|
87
87
|
|
|
88
|
-
####
|
|
88
|
+
#### name
|
|
89
89
|
|
|
90
|
+
Name attribute for form submission
|
|
90
91
|
|
|
92
|
+
- Type: `string \| undefined`
|
|
93
|
+
- Default: `''`
|
|
94
|
+
|
|
95
|
+
#### openOnFocus
|
|
96
|
+
|
|
97
|
+
Whether the popover opens when focus is on the text field
|
|
91
98
|
|
|
92
99
|
- Type: `boolean`
|
|
93
100
|
- Default: `false`
|
|
94
101
|
|
|
95
|
-
####
|
|
96
|
-
|
|
102
|
+
#### optional
|
|
97
103
|
|
|
104
|
+
Whether to show optional text
|
|
98
105
|
|
|
99
106
|
- Type: `boolean`
|
|
100
107
|
- Default: `false`
|
|
101
108
|
|
|
102
|
-
####
|
|
103
|
-
|
|
104
|
-
|
|
109
|
+
#### options
|
|
105
110
|
|
|
106
|
-
|
|
107
|
-
- Default: `''`
|
|
111
|
+
The available options to select from
|
|
108
112
|
|
|
109
|
-
|
|
113
|
+
- Type: `ComboboxOption[]`
|
|
114
|
+
- Default: `[]`
|
|
110
115
|
|
|
116
|
+
#### placeholder
|
|
111
117
|
|
|
118
|
+
Input placeholder
|
|
112
119
|
|
|
113
|
-
- Type: `
|
|
114
|
-
- Default: `
|
|
120
|
+
- Type: `string \| undefined`
|
|
121
|
+
- Default: `''`
|
|
115
122
|
|
|
116
123
|
#### required
|
|
117
124
|
|
|
118
|
-
|
|
125
|
+
Whether the element is required
|
|
119
126
|
|
|
120
127
|
- Type: `boolean`
|
|
121
128
|
- Default: `false`
|
|
122
129
|
|
|
123
|
-
####
|
|
124
|
-
|
|
130
|
+
#### selectOnBlur
|
|
125
131
|
|
|
132
|
+
Select active option on blur
|
|
126
133
|
|
|
127
134
|
- Type: `boolean`
|
|
128
|
-
- Default: `
|
|
129
|
-
|
|
130
|
-
#### name
|
|
135
|
+
- Default: `true`
|
|
131
136
|
|
|
137
|
+
#### value
|
|
132
138
|
|
|
139
|
+
The input value
|
|
133
140
|
|
|
134
|
-
- Type: `string
|
|
141
|
+
- Type: `string`
|
|
135
142
|
- Default: `''`
|
|
136
143
|
|
|
137
|
-
#### autocomplete
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
- Type: `string | undefined`
|
|
142
|
-
- Default: `'off'`
|
|
143
|
-
|
|
144
144
|
### Types
|
|
145
145
|
|
|
146
146
|
No types documented.
|