@warp-ds/elements 2.10.0-next.10 → 2.10.0-next.12

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 (188) hide show
  1. package/dist/custom-elements.json +211 -189
  2. package/dist/docs/badge/api.md +4 -4
  3. package/dist/docs/badge/badge.md +4 -4
  4. package/dist/docs/button/api.md +24 -24
  5. package/dist/docs/button/button.md +24 -24
  6. package/dist/docs/checkbox/api.md +2 -2
  7. package/dist/docs/checkbox/checkbox.md +2 -2
  8. package/dist/docs/checkbox-group/api.md +6 -6
  9. package/dist/docs/checkbox-group/checkbox-group.md +6 -6
  10. package/dist/docs/datepicker/api.md +8 -8
  11. package/dist/docs/datepicker/datepicker.md +8 -8
  12. package/dist/docs/expandable/api.md +6 -6
  13. package/dist/docs/expandable/expandable.md +6 -6
  14. package/dist/docs/icon/api.md +4 -4
  15. package/dist/docs/icon/icon.md +4 -4
  16. package/dist/docs/link/api.md +10 -10
  17. package/dist/docs/link/link.md +10 -10
  18. package/dist/docs/modal/api.md +2 -2
  19. package/dist/docs/modal/modal.md +2 -2
  20. package/dist/docs/pagination/api.md +4 -4
  21. package/dist/docs/pagination/pagination.md +4 -4
  22. package/dist/docs/pill/api.md +8 -8
  23. package/dist/docs/pill/pill.md +8 -8
  24. package/dist/docs/select/api.md +10 -10
  25. package/dist/docs/select/select.md +10 -10
  26. package/dist/docs/slider/api.md +22 -22
  27. package/dist/docs/slider/slider.md +22 -22
  28. package/dist/docs/slider-thumb/api.md +12 -12
  29. package/dist/docs/slider-thumb/slider-thumb.md +12 -12
  30. package/dist/docs/tabs/api.md +2 -2
  31. package/dist/docs/tabs/tabs.md +2 -2
  32. package/dist/docs/textarea/api.md +14 -14
  33. package/dist/docs/textarea/textarea.md +14 -14
  34. package/dist/docs/textfield/api.md +34 -34
  35. package/dist/docs/textfield/textfield.md +34 -34
  36. package/dist/index.d.ts +285 -26
  37. package/dist/packages/affix/affix.d.ts +1 -1
  38. package/dist/packages/affix/affix.js +1 -1
  39. package/dist/packages/affix/affix.js.map +4 -4
  40. package/dist/packages/affix/styles.js +2 -2
  41. package/dist/packages/alert/alert.js +3 -3
  42. package/dist/packages/alert/alert.js.map +3 -3
  43. package/dist/packages/alert/styles.js +2 -2
  44. package/dist/packages/attention/attention.js +2 -2
  45. package/dist/packages/attention/attention.js.map +4 -4
  46. package/dist/packages/attention/attention.stories.js +1 -1
  47. package/dist/packages/attention/styles.js +2 -2
  48. package/dist/packages/badge/badge.d.ts +2 -2
  49. package/dist/packages/badge/badge.js +1 -1
  50. package/dist/packages/badge/badge.js.map +3 -3
  51. package/dist/packages/badge/styles.js +2 -2
  52. package/dist/packages/box/box.js +2 -2
  53. package/dist/packages/box/box.js.map +3 -3
  54. package/dist/packages/box/styles.js +2 -2
  55. package/dist/packages/breadcrumbs/breadcrumbs.d.ts +1 -2
  56. package/dist/packages/breadcrumbs/breadcrumbs.js +3 -3
  57. package/dist/packages/breadcrumbs/breadcrumbs.js.map +4 -4
  58. package/dist/packages/breadcrumbs/breadcrumbs.react.stories.d.ts +1 -1
  59. package/dist/packages/breadcrumbs/styles.js +2 -2
  60. package/dist/packages/button/button.d.ts +11 -11
  61. package/dist/packages/button/button.js +1 -1
  62. package/dist/packages/button/button.js.map +3 -3
  63. package/dist/packages/button/button.react.stories.d.ts +2 -2
  64. package/dist/packages/button/react.d.ts +1 -1
  65. package/dist/packages/card/card.js +2 -2
  66. package/dist/packages/card/card.js.map +4 -4
  67. package/dist/packages/card/styles.js +2 -2
  68. package/dist/packages/checkbox/checkbox.d.ts +2 -2
  69. package/dist/packages/checkbox/checkbox.js.map +2 -2
  70. package/dist/packages/checkbox-group/checkbox-group.d.ts +4 -4
  71. package/dist/packages/checkbox-group/checkbox-group.js.map +2 -2
  72. package/dist/packages/combobox/combobox.js +10 -11
  73. package/dist/packages/combobox/combobox.js.map +4 -4
  74. package/dist/packages/combobox/combobox.react.stories.d.ts +26 -10
  75. package/dist/packages/combobox/react.d.ts +13 -5
  76. package/dist/packages/combobox/styles.js +2 -3
  77. package/dist/packages/datepicker/datepicker.d.ts +5 -5
  78. package/dist/packages/datepicker/datepicker.js +12 -12
  79. package/dist/packages/datepicker/datepicker.js.map +3 -3
  80. package/dist/packages/datepicker/datepicker.react.stories.d.ts +12 -12
  81. package/dist/packages/datepicker/react.d.ts +6 -6
  82. package/dist/packages/expandable/expandable.d.ts +3 -3
  83. package/dist/packages/expandable/expandable.js +11 -11
  84. package/dist/packages/expandable/expandable.js.map +3 -3
  85. package/dist/packages/expandable/styles.js +2 -2
  86. package/dist/packages/icon/icon.d.ts +1 -1
  87. package/dist/packages/icon/icon.js +2 -2
  88. package/dist/packages/icon/icon.js.map +1 -1
  89. package/dist/packages/icon/icon.react.stories.d.ts +1 -1
  90. package/dist/packages/icon/icon.react.stories.js +2 -0
  91. package/dist/packages/icon/icon.stories.d.ts +7 -30
  92. package/dist/packages/icon/icon.stories.js +11 -2
  93. package/dist/packages/link/link.d.ts +5 -5
  94. package/dist/packages/link/link.js.map +1 -1
  95. package/dist/packages/modal/modal.d.ts +1 -1
  96. package/dist/packages/modal/modal.js.map +2 -2
  97. package/dist/packages/modal/modal.react.stories.d.ts +4 -4
  98. package/dist/packages/modal/modal.react.stories.js +9 -1
  99. package/dist/packages/modal/react.d.ts +34 -4
  100. package/dist/packages/modal/react.js +30 -0
  101. package/dist/packages/modal/util.js +3 -1
  102. package/dist/packages/modal-footer/modal-footer.js.map +2 -2
  103. package/dist/packages/modal-header/modal-header.js +4 -4
  104. package/dist/packages/modal-header/modal-header.js.map +3 -3
  105. package/dist/packages/modal-header/react.d.ts +2 -2
  106. package/dist/packages/page-indicator/page-indicator.d.ts +0 -4
  107. package/dist/packages/page-indicator/page-indicator.js +6 -6
  108. package/dist/packages/page-indicator/page-indicator.js.map +4 -4
  109. package/dist/packages/page-indicator/page-indicator.stories.d.ts +8 -26
  110. package/dist/packages/page-indicator/page-indicator.stories.js +9 -7
  111. package/dist/packages/pagination/pagination.d.ts +8 -9
  112. package/dist/packages/pagination/pagination.js +11 -11
  113. package/dist/packages/pagination/pagination.js.map +4 -4
  114. package/dist/packages/pagination/pagination.react.stories.d.ts +6 -6
  115. package/dist/packages/pagination/pagination.test.js +4 -7
  116. package/dist/packages/pagination/react.d.ts +3 -3
  117. package/dist/packages/pagination/styles.js +2 -2
  118. package/dist/packages/pill/pill.d.ts +4 -4
  119. package/dist/packages/pill/pill.js +3 -3
  120. package/dist/packages/pill/pill.js.map +4 -4
  121. package/dist/packages/pill/pill.react.stories.d.ts +8 -8
  122. package/dist/packages/pill/react.d.ts +4 -4
  123. package/dist/packages/pill/styles.js +2 -2
  124. package/dist/packages/radio/form-associated-element.d.ts +1 -1
  125. package/dist/packages/radio/radio.d.ts +1 -1
  126. package/dist/packages/radio-group/radio-group.d.ts +2 -2
  127. package/dist/packages/radio-group/radio-group.js.map +1 -1
  128. package/dist/packages/radio-group/react.d.ts +4 -4
  129. package/dist/packages/select/react.d.ts +3 -3
  130. package/dist/packages/select/select.d.ts +6 -7
  131. package/dist/packages/select/select.js +5 -5
  132. package/dist/packages/select/select.js.map +4 -4
  133. package/dist/packages/select/select.react.stories.d.ts +7 -7
  134. package/dist/packages/select/select.react.stories.js +15 -10
  135. package/dist/packages/select/styles.js +2 -2
  136. package/dist/packages/slider/slider.d.ts +14 -14
  137. package/dist/packages/slider/slider.js +6 -6
  138. package/dist/packages/slider/slider.js.map +3 -3
  139. package/dist/packages/slider/slider.stories.js +1 -0
  140. package/dist/packages/slider-thumb/react.d.ts +2 -2
  141. package/dist/packages/slider-thumb/slider-thumb.d.ts +14 -14
  142. package/dist/packages/slider-thumb/slider-thumb.js +2 -2
  143. package/dist/packages/slider-thumb/slider-thumb.js.map +3 -3
  144. package/dist/packages/slider-thumb/styles.d.ts +1 -0
  145. package/dist/packages/slider-thumb/styles.js +2 -0
  146. package/dist/packages/step/step.js +3 -3
  147. package/dist/packages/step/step.js.map +4 -4
  148. package/dist/packages/step-indicator/step-indicator.js +3 -3
  149. package/dist/packages/step-indicator/step-indicator.js.map +3 -3
  150. package/dist/packages/step-indicator/styles.js +2 -2
  151. package/dist/packages/switch/styles.js +2 -2
  152. package/dist/packages/switch/switch.d.ts +3 -3
  153. package/dist/packages/switch/switch.js +3 -3
  154. package/dist/packages/switch/switch.js.map +3 -3
  155. package/dist/packages/tab/react.d.ts +4 -4
  156. package/dist/packages/tab/tab.d.ts +1 -1
  157. package/dist/packages/tab/tab.js +4 -4
  158. package/dist/packages/tab/tab.js.map +3 -3
  159. package/dist/packages/tab-panel/tab-panel.js +1 -1
  160. package/dist/packages/tab-panel/tab-panel.js.map +3 -3
  161. package/dist/packages/tabs/styles.js +2 -2
  162. package/dist/packages/tabs/tabs.d.ts +4 -3
  163. package/dist/packages/tabs/tabs.js +1 -1
  164. package/dist/packages/tabs/tabs.js.map +3 -3
  165. package/dist/packages/textarea/react.d.ts +9 -9
  166. package/dist/packages/textarea/styles.js +2 -2
  167. package/dist/packages/textarea/textarea.a11y.test.js +1 -1
  168. package/dist/packages/textarea/textarea.d.ts +10 -10
  169. package/dist/packages/textarea/textarea.js +6 -6
  170. package/dist/packages/textarea/textarea.js.map +4 -4
  171. package/dist/packages/textarea/textarea.react.stories.d.ts +18 -18
  172. package/dist/packages/textfield/react.d.ts +9 -9
  173. package/dist/packages/textfield/styles.js +2 -2
  174. package/dist/packages/textfield/textfield.d.ts +22 -22
  175. package/dist/packages/textfield/textfield.js +4 -4
  176. package/dist/packages/textfield/textfield.js.map +3 -3
  177. package/dist/packages/textfield/textfield.react.stories.d.ts +18 -18
  178. package/dist/packages/toast/api.d.ts +1 -1
  179. package/dist/packages/toast/toast.d.ts +1 -1
  180. package/dist/packages/toast/toast.js +3 -3
  181. package/dist/packages/toast/toast.js.map +3 -3
  182. package/dist/packages/toast-container/styles.d.ts +1 -0
  183. package/dist/packages/toast-container/styles.js +2 -0
  184. package/dist/packages/toast-container/toast-container.js +2 -2
  185. package/dist/packages/toast-container/toast-container.js.map +2 -2
  186. package/dist/web-types.json +170 -159
  187. package/eik/index.js +21 -22
  188. package/package.json +4 -4
@@ -317,21 +317,21 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
317
317
  | Name | Type | Default | Summary |
318
318
  |-|-|-|-|
319
319
  | disabled | `boolean` | `false` | - |
320
- | error | `string` | `-` | Validation error text, if any |
321
- | help-text | `string` | `-` | Additional description to show below the fieldset |
320
+ | error | `string \| undefined` | `-` | Validation error text, if any |
321
+ | help-text | `string \| undefined` | `-` | Additional description to show below the fieldset |
322
322
  | hidden-textfield | `boolean` | `false` | Should only be used in special cases |
323
323
  | invalid | `boolean` | `false` | Sets the form fields and fieldset in an invalid state |
324
- | label | `string` | `-` | The slider fieldset label. Required for proper accessibility. |
325
- | labelFormatter (JS only) | `(slot: SliderSlot) => string` | `-` | Formatter for the min and max labels below the range. |
326
- | markers | `number` | `-` | Pass a value similar to step to create visual markers at that interval |
327
- | max | `string` | `100` | The maximum allowed value in the range inputs |
328
- | min | `string` | `0` | The minimum allowed value in the range inputs |
324
+ | label | `string \| undefined` | `-` | The slider fieldset label. Required for proper accessibility. |
325
+ | labelFormatter (JS only) | `((slot: SliderSlot) => string) \| undefined` | `-` | Formatter for the min and max labels below the range. |
326
+ | markers | `number \| undefined` | `-` | Pass a value similar to step to create visual markers at that interval |
327
+ | max | `string \| undefined` | `100` | The maximum allowed value in the range inputs |
328
+ | min | `string \| undefined` | `0` | The minimum allowed value in the range inputs |
329
329
  | open-ended | `boolean` | `false` | Whether or not to allow values outside the range such as "Before 1950" and "2025+". |
330
330
  | required | `boolean` | `false` | Ensures a child slider thumb has a value before allowing the containing form to submit |
331
- | step | `number` | `-` | ets step on the range input to jump between values when dragging |
332
- | suffix | `string` | `-` | Suffix used in text input fields and for the min and max values of the slider |
333
- | tooltipFormatter (JS only) | `(value: string, slot: SliderSlot) => string` | `-` | Overrides valueFormatter for the tooltip. |
334
- | valueFormatter (JS only) | `(value: string, slot: SliderSlot) => string` | `-` | Formatter for the tooltip and input mask values |
331
+ | step | `number \| undefined` | `-` | ets step on the range input to jump between values when dragging |
332
+ | suffix | `string \| undefined` | `-` | Suffix used in text input fields and for the min and max values of the slider |
333
+ | tooltipFormatter (JS only) | `((value: string, slot: SliderSlot) => string) \| undefined` | `-` | Overrides valueFormatter for the tooltip. |
334
+ | valueFormatter (JS only) | `((value: string, slot: SliderSlot) => string) \| undefined` | `-` | Formatter for the tooltip and input mask values |
335
335
 
336
336
  ### Property Details
337
337
 
@@ -346,14 +346,14 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
346
346
 
347
347
  Validation error text, if any
348
348
 
349
- - Type: `string`
349
+ - Type: `string | undefined`
350
350
  - Default: `-`
351
351
 
352
352
  #### help-text
353
353
 
354
354
  Additional description to show below the fieldset
355
355
 
356
- - Type: `string`
356
+ - Type: `string | undefined`
357
357
  - Default: `-`
358
358
 
359
359
  #### hidden-textfield
@@ -376,35 +376,35 @@ The slider fieldset label. Required for proper accessibility.
376
376
 
377
377
  If you need to display HTML, use the `label` slot instead (f. ex. `<legend class="sr-only" slot="label">Production year</legend>`)
378
378
 
379
- - Type: `string`
379
+ - Type: `string | undefined`
380
380
  - Default: `-`
381
381
 
382
382
  #### labelFormatter (JS only)
383
383
 
384
384
  Formatter for the min and max labels below the range.
385
385
 
386
- - Type: `(slot: SliderSlot) => string`
386
+ - Type: `((slot: SliderSlot) => string) | undefined`
387
387
  - Default: `-`
388
388
 
389
389
  #### markers
390
390
 
391
391
  Pass a value similar to step to create visual markers at that interval
392
392
 
393
- - Type: `number`
393
+ - Type: `number | undefined`
394
394
  - Default: `-`
395
395
 
396
396
  #### max
397
397
 
398
398
  The maximum allowed value in the range inputs
399
399
 
400
- - Type: `string`
400
+ - Type: `string | undefined`
401
401
  - Default: `100`
402
402
 
403
403
  #### min
404
404
 
405
405
  The minimum allowed value in the range inputs
406
406
 
407
- - Type: `string`
407
+ - Type: `string | undefined`
408
408
  - Default: `0`
409
409
 
410
410
  #### open-ended
@@ -425,14 +425,14 @@ Ensures a child slider thumb has a value before allowing the containing form to
425
425
 
426
426
  ets step on the range input to jump between values when dragging
427
427
 
428
- - Type: `number`
428
+ - Type: `number | undefined`
429
429
  - Default: `-`
430
430
 
431
431
  #### suffix
432
432
 
433
433
  Suffix used in text input fields and for the min and max values of the slider
434
434
 
435
- - Type: `string`
435
+ - Type: `string | undefined`
436
436
  - Default: `-`
437
437
 
438
438
  #### tooltipFormatter (JS only)
@@ -441,13 +441,13 @@ Overrides valueFormatter for the tooltip.
441
441
 
442
442
  Use in open-ended sliders to show for example "300+ hk" instead of "Max" in the tooltip.
443
443
 
444
- - Type: `(value: string, slot: SliderSlot) => string`
444
+ - Type: `((value: string, slot: SliderSlot) => string) | undefined`
445
445
  - Default: `-`
446
446
 
447
447
  #### valueFormatter (JS only)
448
448
 
449
449
  Formatter for the tooltip and input mask values
450
450
 
451
- - Type: `(value: string, slot: SliderSlot) => string`
451
+ - Type: `((value: string, slot: SliderSlot) => string) | undefined`
452
452
  - Default: `-`
453
453
 
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Default | Summary |
6
6
  |-|-|-|-|
7
- | aria-description | `string` | `-` | Contextual information for assistive technology, should it be needed |
8
- | aria-label | `string` | ``label` from `w-slider`` | Label for the range input. |
9
- | name | `string` | `-` | The name of this input field in the form. The canonical source of the value is the text field. |
10
- | placeholder | `string` | `-` | Placeholder in empty text fields |
11
- | value | `string` | `-` | The initial value, if any |
7
+ | aria-description | `string \| null` | `null` | Contextual information for assistive technology, should it be needed |
8
+ | aria-label | `string \| null` | `null` | Label for the range input. |
9
+ | name | `string \| undefined` | `-` | The name of this input field in the form. The canonical source of the value is the text field. |
10
+ | placeholder | `string \| undefined` | `-` | Placeholder in empty text fields |
11
+ | value | `string \| undefined` | `-` | The initial value, if any |
12
12
 
13
13
  #### Property Details
14
14
 
@@ -16,35 +16,35 @@
16
16
 
17
17
  Contextual information for assistive technology, should it be needed
18
18
 
19
- - Type: `string`
20
- - Default: `-`
19
+ - Type: `string | null`
20
+ - Default: `null`
21
21
 
22
22
  ##### aria-label
23
23
 
24
24
  Label for the range input.
25
25
 
26
- - Type: `string`
27
- - Default: ``label` from `w-slider``
26
+ - Type: `string | null`
27
+ - Default: `null`
28
28
 
29
29
  ##### name
30
30
 
31
31
  The name of this input field in the form. The canonical source of the value is the text field.
32
32
 
33
- - Type: `string`
33
+ - Type: `string | undefined`
34
34
  - Default: `-`
35
35
 
36
36
  ##### placeholder
37
37
 
38
38
  Placeholder in empty text fields
39
39
 
40
- - Type: `string`
40
+ - Type: `string | undefined`
41
41
  - Default: `-`
42
42
 
43
43
  ##### value
44
44
 
45
45
  The initial value, if any
46
46
 
47
- - Type: `string`
47
+ - Type: `string | undefined`
48
48
  - Default: `-`
49
49
 
50
50
  #### Events
@@ -18,11 +18,11 @@ Component to place inside a `<w-slider>`.
18
18
 
19
19
  | Name | Type | Default | Summary |
20
20
  |-|-|-|-|
21
- | aria-description | `string` | `-` | Contextual information for assistive technology, should it be needed |
22
- | aria-label | `string` | ``label` from `w-slider`` | Label for the range input. |
23
- | name | `string` | `-` | The name of this input field in the form. The canonical source of the value is the text field. |
24
- | placeholder | `string` | `-` | Placeholder in empty text fields |
25
- | value | `string` | `-` | The initial value, if any |
21
+ | aria-description | `string \| null` | `null` | Contextual information for assistive technology, should it be needed |
22
+ | aria-label | `string \| null` | `null` | Label for the range input. |
23
+ | name | `string \| undefined` | `-` | The name of this input field in the form. The canonical source of the value is the text field. |
24
+ | placeholder | `string \| undefined` | `-` | Placeholder in empty text fields |
25
+ | value | `string \| undefined` | `-` | The initial value, if any |
26
26
 
27
27
  #### Property Details
28
28
 
@@ -30,35 +30,35 @@ Component to place inside a `<w-slider>`.
30
30
 
31
31
  Contextual information for assistive technology, should it be needed
32
32
 
33
- - Type: `string`
34
- - Default: `-`
33
+ - Type: `string | null`
34
+ - Default: `null`
35
35
 
36
36
  ##### aria-label
37
37
 
38
38
  Label for the range input.
39
39
 
40
- - Type: `string`
41
- - Default: ``label` from `w-slider``
40
+ - Type: `string | null`
41
+ - Default: `null`
42
42
 
43
43
  ##### name
44
44
 
45
45
  The name of this input field in the form. The canonical source of the value is the text field.
46
46
 
47
- - Type: `string`
47
+ - Type: `string | undefined`
48
48
  - Default: `-`
49
49
 
50
50
  ##### placeholder
51
51
 
52
52
  Placeholder in empty text fields
53
53
 
54
- - Type: `string`
54
+ - Type: `string | undefined`
55
55
  - Default: `-`
56
56
 
57
57
  ##### value
58
58
 
59
59
  The initial value, if any
60
60
 
61
- - Type: `string`
61
+ - Type: `string | undefined`
62
62
  - Default: `-`
63
63
 
64
64
  #### Events
@@ -6,7 +6,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
6
6
 
7
7
  | Name | Type | Default | Summary |
8
8
  |-|-|-|-|
9
- | active | `string` | `"" (Shows the first tab)` | The `id` of the panel that should be active. |
9
+ | active | `string \| undefined` | `"" (Shows the first tab)` | The `id` of the panel that should be active. |
10
10
 
11
11
  ### Property Details
12
12
 
@@ -14,7 +14,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
14
14
 
15
15
  The `id` of the panel that should be active.
16
16
 
17
- - Type: `string`
17
+ - Type: `string | undefined`
18
18
  - Default: `"" (Shows the first tab)`
19
19
 
20
20
  ### Events
@@ -107,7 +107,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
107
107
 
108
108
  | Name | Type | Default | Summary |
109
109
  |-|-|-|-|
110
- | active | `string` | `"" (Shows the first tab)` | The `id` of the panel that should be active. |
110
+ | active | `string \| undefined` | `"" (Shows the first tab)` | The `id` of the panel that should be active. |
111
111
 
112
112
  ### Property Details
113
113
 
@@ -115,7 +115,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
115
115
 
116
116
  The `id` of the panel that should be active.
117
117
 
118
- - Type: `string`
118
+ - Type: `string | undefined`
119
119
  - Default: `"" (Shows the first tab)`
120
120
 
121
121
  ### Events
@@ -7,20 +7,20 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
7
7
  | Name | Type | Default | Summary |
8
8
  |-|-|-|-|
9
9
  | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
10
- | help-text | `string` | `-` | Description shown below the input field |
10
+ | help-text | `string \| undefined` | `-` | Description shown below the input field |
11
11
  | invalid | `boolean` | `false` | Mark the form field as invalid. |
12
- | label | `string` | `-` | Either a `label` or an `aria-label` must be provided. |
13
- | maximum-rows | `number` | `-` | Sets the maximum number of text rows before the content starts scrolling. |
14
- | minimum-rows | `number` | `-` | Sets the minimum number of text rows the textarea should display |
15
- | name | `string` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form |
12
+ | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
13
+ | maximum-rows | `number \| undefined` | `-` | Sets the maximum number of text rows before the content starts scrolling. |
14
+ | minimum-rows | `number \| undefined` | `-` | Sets the minimum number of text rows the textarea should display |
15
+ | name | `string \| undefined` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form |
16
16
  | optional | `boolean` | `false` | Show an icon behind the label indicating the field is optional |
17
- | placeholder | `string` | `-` | Shown in the textarea when it doesn't have a value |
17
+ | placeholder | `string \| undefined` | `-` | Shown in the textarea when it doesn't have a value |
18
18
  | read-only | `boolean` | `false` | **Deprecated**: Use the native `readonly` attribute instead |
19
19
  | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user |
20
20
  | required | `boolean` | `false` | Whether user input is required on the input before form submission |
21
21
  | validationMessage (JS only) | `string` | `-` | Returns the validation message if the textarea is invalid, otherwise an empty string |
22
22
  | validity (JS only) | `ValidityState` | `-` | Returns the validity state of the textarea |
23
- | value | `string` | `-` | Lets you set the current value |
23
+ | value | `string \| undefined` | `-` | Lets you set the current value |
24
24
 
25
25
  ### Property Details
26
26
 
@@ -40,7 +40,7 @@ Please consider more informative alternatives before choosing to use disabled on
40
40
  Use in combination with `invalid` to show as a validation error message,
41
41
  or on its own to show a help text.
42
42
 
43
- - Type: `string`
43
+ - Type: `string | undefined`
44
44
  - Default: `-`
45
45
 
46
46
  #### invalid
@@ -56,28 +56,28 @@ Make sure to also set a `help-text` to help users fix the validation problem.
56
56
 
57
57
  Either a `label` or an `aria-label` must be provided.
58
58
 
59
- - Type: `string`
59
+ - Type: `string | undefined`
60
60
  - Default: `-`
61
61
 
62
62
  #### maximum-rows
63
63
 
64
64
  Sets the maximum number of text rows before the content starts scrolling.
65
65
 
66
- - Type: `number`
66
+ - Type: `number | undefined`
67
67
  - Default: `-`
68
68
 
69
69
  #### minimum-rows
70
70
 
71
71
  Sets the minimum number of text rows the textarea should display
72
72
 
73
- - Type: `number`
73
+ - Type: `number | undefined`
74
74
  - Default: `-`
75
75
 
76
76
  #### name
77
77
 
78
78
  The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form
79
79
 
80
- - Type: `string`
80
+ - Type: `string | undefined`
81
81
  - Default: `-`
82
82
 
83
83
  #### optional
@@ -93,7 +93,7 @@ Set a text that is shown in the textarea when it doesn't have a value.
93
93
 
94
94
  Placeholder text should not be used as a substitute for labeling the element with a visible label.
95
95
 
96
- - Type: `string`
96
+ - Type: `string | undefined`
97
97
  - Default: `-`
98
98
 
99
99
  #### read-only
@@ -137,6 +137,6 @@ Returns the validity state of the textarea
137
137
 
138
138
  Lets you set the current value
139
139
 
140
- - Type: `string`
140
+ - Type: `string | undefined`
141
141
  - Default: `-`
142
142
 
@@ -122,20 +122,20 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
122
122
  | Name | Type | Default | Summary |
123
123
  |-|-|-|-|
124
124
  | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
125
- | help-text | `string` | `-` | Description shown below the input field |
125
+ | help-text | `string \| undefined` | `-` | Description shown below the input field |
126
126
  | invalid | `boolean` | `false` | Mark the form field as invalid. |
127
- | label | `string` | `-` | Either a `label` or an `aria-label` must be provided. |
128
- | maximum-rows | `number` | `-` | Sets the maximum number of text rows before the content starts scrolling. |
129
- | minimum-rows | `number` | `-` | Sets the minimum number of text rows the textarea should display |
130
- | name | `string` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form |
127
+ | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
128
+ | maximum-rows | `number \| undefined` | `-` | Sets the maximum number of text rows before the content starts scrolling. |
129
+ | minimum-rows | `number \| undefined` | `-` | Sets the minimum number of text rows the textarea should display |
130
+ | name | `string \| undefined` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form |
131
131
  | optional | `boolean` | `false` | Show an icon behind the label indicating the field is optional |
132
- | placeholder | `string` | `-` | Shown in the textarea when it doesn't have a value |
132
+ | placeholder | `string \| undefined` | `-` | Shown in the textarea when it doesn't have a value |
133
133
  | read-only | `boolean` | `false` | **Deprecated**: Use the native `readonly` attribute instead |
134
134
  | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user |
135
135
  | required | `boolean` | `false` | Whether user input is required on the input before form submission |
136
136
  | validationMessage (JS only) | `string` | `-` | Returns the validation message if the textarea is invalid, otherwise an empty string |
137
137
  | validity (JS only) | `ValidityState` | `-` | Returns the validity state of the textarea |
138
- | value | `string` | `-` | Lets you set the current value |
138
+ | value | `string \| undefined` | `-` | Lets you set the current value |
139
139
 
140
140
  ### Property Details
141
141
 
@@ -155,7 +155,7 @@ Please consider more informative alternatives before choosing to use disabled on
155
155
  Use in combination with `invalid` to show as a validation error message,
156
156
  or on its own to show a help text.
157
157
 
158
- - Type: `string`
158
+ - Type: `string | undefined`
159
159
  - Default: `-`
160
160
 
161
161
  #### invalid
@@ -171,28 +171,28 @@ Make sure to also set a `help-text` to help users fix the validation problem.
171
171
 
172
172
  Either a `label` or an `aria-label` must be provided.
173
173
 
174
- - Type: `string`
174
+ - Type: `string | undefined`
175
175
  - Default: `-`
176
176
 
177
177
  #### maximum-rows
178
178
 
179
179
  Sets the maximum number of text rows before the content starts scrolling.
180
180
 
181
- - Type: `number`
181
+ - Type: `number | undefined`
182
182
  - Default: `-`
183
183
 
184
184
  #### minimum-rows
185
185
 
186
186
  Sets the minimum number of text rows the textarea should display
187
187
 
188
- - Type: `number`
188
+ - Type: `number | undefined`
189
189
  - Default: `-`
190
190
 
191
191
  #### name
192
192
 
193
193
  The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form
194
194
 
195
- - Type: `string`
195
+ - Type: `string | undefined`
196
196
  - Default: `-`
197
197
 
198
198
  #### optional
@@ -208,7 +208,7 @@ Set a text that is shown in the textarea when it doesn't have a value.
208
208
 
209
209
  Placeholder text should not be used as a substitute for labeling the element with a visible label.
210
210
 
211
- - Type: `string`
211
+ - Type: `string | undefined`
212
212
  - Default: `-`
213
213
 
214
214
  #### read-only
@@ -252,6 +252,6 @@ Returns the validity state of the textarea
252
252
 
253
253
  Lets you set the current value
254
254
 
255
- - Type: `string`
255
+ - Type: `string | undefined`
256
256
  - Default: `-`
257
257
 
@@ -6,28 +6,28 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
6
6
 
7
7
  | Name | Type | Default | Summary |
8
8
  |-|-|-|-|
9
- | autocomplete | `string \| undefined` | `-` | A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill. |
9
+ | autocomplete | `HTMLInputElement["autocomplete"] \| undefined` | `-` | A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill. |
10
10
  | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
11
- | formatter (JS only) | `(value: string) => string` | `-` | Function to format value when the input field |
12
- | help-text | `string` | `-` | Description shown below the input field |
11
+ | formatter (JS only) | `((value: string) => string) \| undefined` | `-` | Function to format value when the input field |
12
+ | help-text | `string \| undefined` | `-` | Description shown below the input field |
13
13
  | invalid | `boolean` | `false` | Mark the form field as invalid. |
14
- | label | `string` | `-` | Either a `label` or an `aria-label` must be provided. |
15
- | max | `number` | `-` | Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength). |
16
- | max-length | `number` | `-` | **Deprecated**: Use the native `maxlength` attribute |
17
- | maxlength | `number` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed. |
18
- | min | `number` | `-` | Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength). |
19
- | min-length | `number` | `-` | **Deprecated**: Use the native `minlength` attribute |
20
- | minlength | `number` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required. |
21
- | name | `string` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form. |
22
- | pattern | `string` | `-` | Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern) |
23
- | placeholder | `string` | `-` | Shown in the textfield when it doesn't have a value |
14
+ | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
15
+ | max | `number \| undefined` | `-` | Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength). |
16
+ | max-length | `number \| undefined` | `-` | **Deprecated**: Use the native `maxlength` attribute |
17
+ | maxlength | `number \| undefined` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed. |
18
+ | min | `number \| undefined` | `-` | Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength). |
19
+ | min-length | `number \| undefined` | `-` | **Deprecated**: Use the native `minlength` attribute |
20
+ | minlength | `number \| undefined` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required. |
21
+ | name | `string \| undefined` | `-` | The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form. |
22
+ | pattern | `string \| undefined` | `-` | Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern) |
23
+ | placeholder | `string \| undefined` | `-` | Shown in the textfield when it doesn't have a value |
24
24
  | read-only | `boolean` | `false` | **Deprecated**: Use the native readonly attribute instead. |
25
25
  | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user. |
26
26
  | required | `boolean` | `false` | Whether user input is required on the input before form submission. |
27
- | size | `string` | `-` | Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs. |
28
- | step | `number` | `-` | Forces `number` inputs to be a whole number of `step` |
29
- | type | `string` | `-` | The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types). |
30
- | value | `string` | `-` | Lets you set the current value. |
27
+ | size | `string \| undefined` | `-` | Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs. |
28
+ | step | `number \| undefined` | `-` | Forces `number` inputs to be a whole number of `step` |
29
+ | type | `string \| undefined` | `-` | The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types). |
30
+ | value | `string \| undefined` | `-` | Lets you set the current value. |
31
31
 
32
32
  ### Property Details
33
33
 
@@ -35,7 +35,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
35
35
 
36
36
  A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill.
37
37
 
38
- - Type: `string | undefined`
38
+ - Type: `HTMLInputElement["autocomplete"] | undefined`
39
39
  - Default: `-`
40
40
 
41
41
  #### disabled
@@ -56,7 +56,7 @@ Function to format value when the input field.
56
56
  Only active when the input field does not have focus,
57
57
  similar to the accessible input [masking example from Filament Group](https://filamentgroup.github.io/politespace/demo/demo.html).
58
58
 
59
- - Type: `(value: string) => string`
59
+ - Type: `((value: string) => string) | undefined`
60
60
  - Default: `-`
61
61
 
62
62
  #### help-text
@@ -64,7 +64,7 @@ similar to the accessible input [masking example from Filament Group](https://fi
64
64
  Use in combination with `invalid` to show as a validation error message,
65
65
  or on its own to show a help text.
66
66
 
67
- - Type: `string`
67
+ - Type: `string | undefined`
68
68
  - Default: `-`
69
69
 
70
70
  #### invalid
@@ -78,14 +78,14 @@ Mark the form field as invalid. Make sure to also set a `help-text` to help user
78
78
 
79
79
  Either a `label` or an `aria-label` must be provided.
80
80
 
81
- - Type: `string`
81
+ - Type: `string | undefined`
82
82
  - Default: `-`
83
83
 
84
84
  #### max
85
85
 
86
86
  Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).
87
87
 
88
- - Type: `number`
88
+ - Type: `number | undefined`
89
89
  - Default: `-`
90
90
 
91
91
  #### max-length
@@ -94,21 +94,21 @@ Use with `type="number"` to set the [maximum allowed value](https://developer.mo
94
94
 
95
95
 
96
96
 
97
- - Type: `number`
97
+ - Type: `number | undefined`
98
98
  - Default: `-`
99
99
 
100
100
  #### maxlength
101
101
 
102
102
  For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.
103
103
 
104
- - Type: `number`
104
+ - Type: `number | undefined`
105
105
  - Default: `-`
106
106
 
107
107
  #### min
108
108
 
109
109
  Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).
110
110
 
111
- - Type: `number`
111
+ - Type: `number | undefined`
112
112
  - Default: `-`
113
113
 
114
114
  #### min-length
@@ -117,28 +117,28 @@ Use with `type="number"` to set the [minimum allowed value](https://developer.mo
117
117
 
118
118
 
119
119
 
120
- - Type: `number`
120
+ - Type: `number | undefined`
121
121
  - Default: `-`
122
122
 
123
123
  #### minlength
124
124
 
125
125
  For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.
126
126
 
127
- - Type: `number`
127
+ - Type: `number | undefined`
128
128
  - Default: `-`
129
129
 
130
130
  #### name
131
131
 
132
132
  The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form.
133
133
 
134
- - Type: `string`
134
+ - Type: `string | undefined`
135
135
  - Default: `-`
136
136
 
137
137
  #### pattern
138
138
 
139
139
  Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern)
140
140
 
141
- - Type: `string`
141
+ - Type: `string | undefined`
142
142
  - Default: `-`
143
143
 
144
144
  #### placeholder
@@ -147,7 +147,7 @@ Set a text that is shown in the textfield when it doesn't have a value.
147
147
 
148
148
  Placeholder text should not be used as a substitute for labeling the element with a visible label.
149
149
 
150
- - Type: `string`
150
+ - Type: `string | undefined`
151
151
  - Default: `-`
152
152
 
153
153
  #### read-only
@@ -177,7 +177,7 @@ Whether user input is required on the input before form submission.
177
177
 
178
178
  Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs.
179
179
 
180
- - Type: `string`
180
+ - Type: `string | undefined`
181
181
  - Default: `-`
182
182
 
183
183
  #### step
@@ -187,20 +187,20 @@ When used with `number` this attribute forces inputs to be a whole number of `st
187
187
  For example with a `step="5"` only values that divide evenly on 5 are allowed.
188
188
  Using arrow up and down in the input field increments and decrements by 5.
189
189
 
190
- - Type: `number`
190
+ - Type: `number | undefined`
191
191
  - Default: `-`
192
192
 
193
193
  #### type
194
194
 
195
195
  The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).
196
196
 
197
- - Type: `string`
197
+ - Type: `string | undefined`
198
198
  - Default: `-`
199
199
 
200
200
  #### value
201
201
 
202
202
  Lets you set the current value.
203
203
 
204
- - Type: `string`
204
+ - Type: `string | undefined`
205
205
  - Default: `-`
206
206