@warp-ds/elements 2.9.0-next.5 → 2.9.0

package/dist/docs/slider/slider.md

@@ -18,120 +18,113 @@ Parent component for sliders (both single and range sliders). Used in combinatio
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| label | `string` | `-` | - |
+| _hasInternalError | `boolean` | `false` | - |
+| _invalidMessage | `string` | `''` | - |
+| _showError | `boolean` | `false` | - |
+| _tabbableElements | `Array<HTMLElement>` | `[]` | - |
+| componentHasError | `boolean` | `-` | - |
 | disabled | `boolean` | `false` | - |
-| openEnded | `boolean` | `false` | - |
+| edgeMax | `unknown` | `-` | - |
+| edgeMin | `unknown` | `-` | - |
 | error | `string` | `-` | - |
+| errorText | `string` | `-` | - |
+| fieldset | `HTMLFieldSetElement` | `-` | - |
 | helpText | `string` | `-` | - |
+| hiddenTextfield | `boolean` | `false` | - |
 | invalid | `boolean` | `false` | - |
-| required | `boolean` | `false` | - |
-| min | `string` | `-` | - |
+| label | `string` | `-` | The slider fieldset label. Required for proper accessibility. |
+| labelFormatter | `(slot: SliderSlot) => string` | `-` | Formatter for the min and max labels below the range. |
+| markers | `number` | `-` | Pass a value similar to step to create visual markers at that interval |
 | max | `string` | `-` | - |
-| markers | `number` | `-` | - |
+| min | `string` | `-` | - |
+| openEnded | `boolean` | `false` | Whether or not to allow values outside the range such as "Before 1950" and "2025+". |
+| required | `boolean` | `false` | Ensures a child slider thumb has a value before allowing the containing form to submit. |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
 | step | `number` | `-` | - |
-| suffix | `string` | `-` | - |
-| hiddenTextfield | `boolean` | `false` | - |
-| valueFormatter | `(value: string, slot: SliderSlot) => string` | `-` | - |
-| tooltipFormatter | `(value: string, slot: SliderSlot) => string` | `-` | - |
-| labelFormatter | `(slot: SliderSlot) => string` | `-` | - |
-| fieldset | `HTMLFieldSetElement` | `-` | - |
-| _invalidMessage | `string` | `''` | - |
-| _hasInternalError | `boolean` | `false` | - |
-| _showError | `boolean` | `false` | - |
-| _tabbableElements | `Array<HTMLElement>` | `[]` | - |
-| edgeMin | `unknown` | `-` | - |
-| edgeMax | `unknown` | `-` | - |
-| componentHasError | `boolean` | `-` | - |
-| errorText | `string` | `-` | - |
+| suffix | `string` | `-` | Suffix used in text input fields and for the min and max values of the slider. |
+| tooltipFormatter | `(value: string, slot: SliderSlot) => string` | `-` | Replaces valueFormatter for the tooltip. Use in open-ended sliders to show for example "300+ hk" instead of "Max" in the tooltip. |
+| valueFormatter | `(value: string, slot: SliderSlot) => string` | `-` | Formatter for the tooltip and input mask values. |
 
 ### Property Details
 
-#### shadowRootOptions
+#### _hasInternalError
 
 
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+- Type: `boolean`
+- Default: `false`
 
-#### label
+#### _invalidMessage
 
 
 
 - Type: `string`
-- Default: `-`
-
-#### disabled
-
-
-
-- Type: `boolean`
-- Default: `false`
+- Default: `''`
 
-#### openEnded
+#### _showError
 
 
 
 - Type: `boolean`
 - Default: `false`
 
-#### error
+#### _tabbableElements
 
 
 
-- Type: `string`
-- Default: `-`
+- Type: `Array<HTMLElement>`
+- Default: `[]`
 
-#### helpText
+#### componentHasError
 
 
 
-- Type: `string`
+- Type: `boolean`
 - Default: `-`
 
-#### invalid
+#### disabled
 
 
 
 - Type: `boolean`
 - Default: `false`
 
-#### required
+#### edgeMax
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `unknown`
+- Default: `-`
 
-#### min
+#### edgeMin
 
 
 
-- Type: `string`
+- Type: `unknown`
 - Default: `-`
 
-#### max
+#### error
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### markers
+#### errorText
 
 
 
-- Type: `number`
+- Type: `string`
 - Default: `-`
 
-#### step
+#### fieldset
 
 
 
-- Type: `number`
+- Type: `HTMLFieldSetElement`
 - Default: `-`
 
-#### suffix
+#### helpText
 
 
 
@@ -145,88 +138,97 @@ Parent component for sliders (both single and range sliders). Used in combinatio
 - Type: `boolean`
 - Default: `false`
 
-#### valueFormatter
+#### invalid
 
 
 
-- Type: `(value: string, slot: SliderSlot) => string`
-- Default: `-`
+- Type: `boolean`
+- Default: `false`
 
-#### tooltipFormatter
+#### label
 
+The slider fieldset label. Required for proper accessibility.
 
+If you need to display HTML, use the `label` slot instead (f. ex. `<legend class="sr-only" slot="label">Production year</legend>`)
 
-- Type: `(value: string, slot: SliderSlot) => string`
+- Type: `string`
 - Default: `-`
 
 #### labelFormatter
 
-
+Formatter for the min and max labels below the range.
 
 - Type: `(slot: SliderSlot) => string`
 - Default: `-`
 
-#### fieldset
-
+#### markers
 
+Pass a value similar to step to create visual markers at that interval
 
-- Type: `HTMLFieldSetElement`
+- Type: `number`
 - Default: `-`
 
-#### _invalidMessage
+#### max
 
 
 
 - Type: `string`
-- Default: `''`
+- Default: `-`
+
+#### min
 
-#### _hasInternalError
 
 
+- Type: `string`
+- Default: `-`
+
+#### openEnded
+
+Whether or not to allow values outside the range such as "Before 1950" and "2025+".
 
 - Type: `boolean`
 - Default: `false`
 
-#### _showError
-
+#### required
 
+Ensures a child slider thumb has a value before allowing the containing form to submit.
 
 - Type: `boolean`
 - Default: `false`
 
-#### _tabbableElements
+#### shadowRootOptions
 
 
 
-- Type: `Array<HTMLElement>`
-- Default: `[]`
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
-#### edgeMin
+#### step
 
 
 
-- Type: `unknown`
+- Type: `number`
 - Default: `-`
 
-#### edgeMax
-
+#### suffix
 
+Suffix used in text input fields and for the min and max values of the slider.
 
-- Type: `unknown`
+- Type: `string`
 - Default: `-`
 
-#### componentHasError
-
+#### tooltipFormatter
 
+Replaces valueFormatter for the tooltip. Use in open-ended sliders to show for example "300+ hk" instead of "Max" in the tooltip.
 
-- Type: `boolean`
+- Type: `(value: string, slot: SliderSlot) => string`
 - Default: `-`
 
-#### errorText
-
+#### valueFormatter
 
+Formatter for the tooltip and input mask values.
 
-- Type: `string`
+- Type: `(value: string, slot: SliderSlot) => string`
 - Default: `-`
 
 ### Types

package/dist/docs/slider-thumb/api.md

@@ -4,57 +4,51 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| ariaLabel | `string` | `-` | - |
 | ariaDescription | `string` | `-` | - |
+| ariaDescriptionText | `unknown` | `-` | - |
+| ariaLabel | `string` | `-` | - |
+| boundaryValue | `string` | `-` | - |
 | name | `string` | `-` | - |
-| value | `string` | `-` | - |
 | placeholder | `string` | `-` | - |
 | range | `HTMLInputElement` | `-` | - |
-| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| textFieldDisplayValue | `unknown` | `-` | Value to display in the textfield (shows boundary when focused on empty value) |
 | textfield | `WarpTextField` | `-` | - |
-| boundaryValue | `string` | `-` | - |
-| textFieldDisplayValue | `unknown` | `-` | - |
-| tooltipDisplayValue | `string | number` | `-` | - |
-| ariaDescriptionText | `unknown` | `-` | - |
-| disabled | `unknown` | `-` | - |
-| invalid | `unknown` | `-` | - |
-| openEnded | `unknown` | `-` | - |
-| valueFormatter | `unknown` | `-` | - |
-| tooltipFormatter | `unknown` | `-` | - |
-| labelFormatter | `unknown` | `-` | - |
+| tooltipDisplayValue | `string \| number` | `-` | Value to display in the tooltip |
+| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| value | `string` | `-` | - |
 
 ### Property Details
 
-#### shadowRootOptions
+#### ariaDescription
 
 
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+- Type: `string`
+- Default: `-`
 
-#### ariaLabel
+#### ariaDescriptionText
 
 
 
-- Type: `string`
+- Type: `unknown`
 - Default: `-`
 
-#### ariaDescription
+#### ariaLabel
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### name
+#### boundaryValue
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### value
+#### name
 
 
 
@@ -75,26 +69,12 @@
 - Type: `HTMLInputElement`
 - Default: `-`
 
-#### tooltipTarget
-
-
-
-- Type: `HTMLOutputElement`
-- Default: `-`
-
-#### textfield
-
-
-
-- Type: `WarpTextField`
-- Default: `-`
-
-#### boundaryValue
+#### shadowRootOptions
 
 
 
-- Type: `string`
-- Default: `-`
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
 #### textFieldDisplayValue
 
@@ -103,60 +83,32 @@ Value to display in the textfield (shows boundary when focused on empty value)
 - Type: `unknown`
 - Default: `-`
 
-#### tooltipDisplayValue
-
-Value to display in the tooltip
-
-- Type: `string | number`
-- Default: `-`
-
-#### ariaDescriptionText
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### disabled
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### invalid
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### openEnded
+#### textfield
 
 
 
-- Type: `unknown`
+- Type: `WarpTextField`
 - Default: `-`
 
-#### valueFormatter
-
+#### tooltipDisplayValue
 
+Value to display in the tooltip
 
-- Type: `unknown`
+- Type: `string \| number`
 - Default: `-`
 
-#### tooltipFormatter
+#### tooltipTarget
 
 
 
-- Type: `unknown`
+- Type: `HTMLOutputElement`
 - Default: `-`
 
-#### labelFormatter
+#### value
 
 
 
-- Type: `unknown`
+- Type: `string`
 - Default: `-`
 
 ### Types

package/dist/docs/slider-thumb/slider-thumb.md

@@ -18,57 +18,51 @@ Component to place inside a `<w-slider>`.
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| ariaLabel | `string` | `-` | - |
 | ariaDescription | `string` | `-` | - |
+| ariaDescriptionText | `unknown` | `-` | - |
+| ariaLabel | `string` | `-` | - |
+| boundaryValue | `string` | `-` | - |
 | name | `string` | `-` | - |
-| value | `string` | `-` | - |
 | placeholder | `string` | `-` | - |
 | range | `HTMLInputElement` | `-` | - |
-| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| textFieldDisplayValue | `unknown` | `-` | Value to display in the textfield (shows boundary when focused on empty value) |
 | textfield | `WarpTextField` | `-` | - |
-| boundaryValue | `string` | `-` | - |
-| textFieldDisplayValue | `unknown` | `-` | - |
-| tooltipDisplayValue | `string | number` | `-` | - |
-| ariaDescriptionText | `unknown` | `-` | - |
-| disabled | `unknown` | `-` | - |
-| invalid | `unknown` | `-` | - |
-| openEnded | `unknown` | `-` | - |
-| valueFormatter | `unknown` | `-` | - |
-| tooltipFormatter | `unknown` | `-` | - |
-| labelFormatter | `unknown` | `-` | - |
+| tooltipDisplayValue | `string \| number` | `-` | Value to display in the tooltip |
+| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| value | `string` | `-` | - |
 
 ### Property Details
 
-#### shadowRootOptions
+#### ariaDescription
 
 
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+- Type: `string`
+- Default: `-`
 
-#### ariaLabel
+#### ariaDescriptionText
 
 
 
-- Type: `string`
+- Type: `unknown`
 - Default: `-`
 
-#### ariaDescription
+#### ariaLabel
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### name
+#### boundaryValue
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### value
+#### name
 
 
 
@@ -89,26 +83,12 @@ Component to place inside a `<w-slider>`.
 - Type: `HTMLInputElement`
 - Default: `-`
 
-#### tooltipTarget
-
-
-
-- Type: `HTMLOutputElement`
-- Default: `-`
-
-#### textfield
-
-
-
-- Type: `WarpTextField`
-- Default: `-`
-
-#### boundaryValue
+#### shadowRootOptions
 
 
 
-- Type: `string`
-- Default: `-`
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
 #### textFieldDisplayValue
 
@@ -117,60 +97,32 @@ Value to display in the textfield (shows boundary when focused on empty value)
 - Type: `unknown`
 - Default: `-`
 
-#### tooltipDisplayValue
-
-Value to display in the tooltip
-
-- Type: `string | number`
-- Default: `-`
-
-#### ariaDescriptionText
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### disabled
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### invalid
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### openEnded
+#### textfield
 
 
 
-- Type: `unknown`
+- Type: `WarpTextField`
 - Default: `-`
 
-#### valueFormatter
-
+#### tooltipDisplayValue
 
+Value to display in the tooltip
 
-- Type: `unknown`
+- Type: `string \| number`
 - Default: `-`
 
-#### tooltipFormatter
+#### tooltipTarget
 
 
 
-- Type: `unknown`
+- Type: `HTMLOutputElement`
 - Default: `-`
 
-#### labelFormatter
+#### value
 
 
 
-- Type: `unknown`
+- Type: `string`
 - Default: `-`
 
 ### Types

package/dist/docs/switch/api.md

@@ -4,48 +4,48 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| name | `string` | `-` | - |
-| value | `string` | `-` | - |
 | checked | `boolean` | `false` | - |
 | disabled | `boolean` | `false` | - |
+| name | `string` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| value | `string` | `-` | - |
 
 ### Property Details
 
-#### shadowRootOptions
+#### checked
 
 
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+- Type: `boolean`
+- Default: `false`
 
-#### name
+#### disabled
 
 
 
-- Type: `string`
-- Default: `-`
+- Type: `boolean`
+- Default: `false`
 
-#### value
+#### name
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### checked
+#### shadowRootOptions
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
-#### disabled
+#### value
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string`
+- Default: `-`
 
 ### Types