@warp-ds/elements 2.9.0-next.1 → 2.9.0-next.3

package/dist/docs/slider/slider.md

@@ -0,0 +1,222 @@
+# Slider (w-slider)
+
+## Description
+
+Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.
+
+[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-slider-and-range-slider--docs)
+
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| label | `string` | `-` | - |
+| disabled | `boolean` | `false` | - |
+| openEnded | `boolean` | `false` | - |
+| error | `string` | `-` | - |
+| helpText | `string` | `-` | - |
+| invalid | `boolean` | `false` | - |
+| required | `boolean` | `false` | - |
+| min | `string` | `-` | - |
+| max | `string` | `-` | - |
+| markers | `number` | `-` | - |
+| step | `number` | `-` | - |
+| suffix | `string` | `-` | - |
+| hiddenTextfield | `boolean` | `false` | - |
+| valueFormatter | `(value: string, slot: SliderSlot) => string` | `-` | - |
+| tooltipFormatter | `(value: string, slot: SliderSlot) => string` | `-` | - |
+| labelFormatter | `(slot: SliderSlot) => string` | `-` | - |
+| _invalidMessage | `string` | `''` | - |
+| _hasInternalError | `boolean` | `false` | - |
+| _showError | `boolean` | `false` | - |
+| _tabbableElements | `Array<HTMLElement>` | `[]` | - |
+| edgeMin | `unknown` | `-` | - |
+| edgeMax | `unknown` | `-` | - |
+| componentHasError | `boolean` | `-` | - |
+| errorText | `string` | `-` | - |
+
+### Property Details
+
+#### shadowRootOptions
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+
+#### 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: `string`
+- Default: `-`
+
+#### disabled
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### openEnded
+
+Whether or not to allow values outside the range such as "Before 1950" and "2025+".
+
+- Type: `boolean`
+- Default: `false`
+
+#### error
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### helpText
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### invalid
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### required
+
+Ensures a child slider thumb has a value before allowing the containing form to submit.
+
+- Type: `boolean`
+- Default: `false`
+
+#### min
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### max
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### markers
+
+Pass a value similar to step to create visual markers at that interval
+
+- Type: `number`
+- Default: `-`
+
+#### step
+
+
+
+- Type: `number`
+- Default: `-`
+
+#### suffix
+
+Suffix used in text input fields and for the min and max values of the slider.
+
+- Type: `string`
+- Default: `-`
+
+#### hiddenTextfield
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### valueFormatter
+
+Formatter for the tooltip and input mask values.
+
+- Type: `(value: string, slot: SliderSlot) => string`
+- Default: `-`
+
+#### tooltipFormatter
+
+Replaces valueFormatter for the tooltip. Use in open-ended sliders to show for example "300+ hk" instead of "Max" in the tooltip.
+
+- Type: `(value: string, slot: SliderSlot) => string`
+- Default: `-`
+
+#### labelFormatter
+
+Formatter for the min and max labels below the range.
+
+- Type: `(slot: SliderSlot) => string`
+- Default: `-`
+
+#### _invalidMessage
+
+
+
+- Type: `string`
+- Default: `''`
+
+#### _hasInternalError
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### _showError
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### _tabbableElements
+
+
+
+- Type: `Array<HTMLElement>`
+- Default: `[]`
+
+#### edgeMin
+
+
+
+- Type: `unknown`
+- Default: `-`
+
+#### edgeMax
+
+
+
+- Type: `unknown`
+- Default: `-`
+
+#### componentHasError
+
+
+
+- Type: `boolean`
+- Default: `-`
+
+#### errorText
+
+
+
+- Type: `string`
+- Default: `-`
+
+### Types
+
+No types documented.

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

@@ -0,0 +1,116 @@
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| ariaLabel | `string` | `-` | - |
+| ariaDescription | `string` | `-` | - |
+| name | `string` | `-` | - |
+| value | `string` | `-` | - |
+| placeholder | `string` | `-` | - |
+| range | `HTMLInputElement` | `-` | - |
+| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| textfield | `WarpTextField` | `-` | - |
+| boundaryValue | `string` | `-` | - |
+| textFieldDisplayValue | `unknown` | `-` | - |
+| tooltipDisplayValue | `string | number` | `-` | - |
+| ariaDescriptionText | `unknown` | `-` | - |
+
+### Property Details
+
+#### shadowRootOptions
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+
+#### ariaLabel
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### ariaDescription
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### name
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### value
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### placeholder
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### range
+
+
+
+- Type: `HTMLInputElement`
+- Default: `-`
+
+#### tooltipTarget
+
+
+
+- Type: `HTMLOutputElement`
+- Default: `-`
+
+#### textfield
+
+
+
+- Type: `WarpTextField`
+- Default: `-`
+
+#### boundaryValue
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### textFieldDisplayValue
+
+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: `-`
+
+### Types
+
+No types documented.

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

@@ -0,0 +1,124 @@
+# SliderThumb (w-slider-thumb)
+
+## Description
+
+Component to place inside a `<w-slider>`.
+
+[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-slider-and-range-slider--docs)
+
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| ariaLabel | `string` | `-` | - |
+| ariaDescription | `string` | `-` | - |
+| name | `string` | `-` | - |
+| value | `string` | `-` | - |
+| placeholder | `string` | `-` | - |
+| range | `HTMLInputElement` | `-` | - |
+| tooltipTarget | `HTMLOutputElement` | `-` | - |
+| textfield | `WarpTextField` | `-` | - |
+| boundaryValue | `string` | `-` | - |
+| textFieldDisplayValue | `unknown` | `-` | - |
+| tooltipDisplayValue | `string | number` | `-` | - |
+| ariaDescriptionText | `unknown` | `-` | - |
+
+### Property Details
+
+#### shadowRootOptions
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+
+#### ariaLabel
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### ariaDescription
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### name
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### value
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### placeholder
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### range
+
+
+
+- Type: `HTMLInputElement`
+- Default: `-`
+
+#### tooltipTarget
+
+
+
+- Type: `HTMLOutputElement`
+- Default: `-`
+
+#### textfield
+
+
+
+- Type: `WarpTextField`
+- Default: `-`
+
+#### boundaryValue
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### textFieldDisplayValue
+
+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: `-`
+
+### Types
+
+No types documented.

package/dist/docs/step/api.md

@@ -0,0 +1,28 @@
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| active | `boolean` | `false` | - |
+| completed | `boolean` | `false` | - |
+
+### Property Details
+
+#### active
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### completed
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.

package/dist/docs/step/step.md

@@ -0,0 +1,34 @@
+# Step (w-step)
+
+## Description
+
+Individual step component that shows a single step in a process
+
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| active | `boolean` | `false` | - |
+| completed | `boolean` | `false` | - |
+
+### Property Details
+
+#### active
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### completed
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.

package/dist/docs/step-indicator/api.md

@@ -0,0 +1,28 @@
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| horizontal | `boolean` | `false` | - |
+| right | `boolean` | `false` | - |
+
+### Property Details
+
+#### horizontal
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### right
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.

package/dist/docs/step-indicator/step-indicator.md

@@ -0,0 +1,36 @@
+# StepIndicator (w-step-indicator)
+
+## Description
+
+Steps are used to show progress through a process or to guide users through a multi-step task.
+
+[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/components-steps--docs)
+
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| horizontal | `boolean` | `false` | - |
+| right | `boolean` | `false` | - |
+
+### Property Details
+
+#### horizontal
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### right
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.

package/dist/docs/switch/api.md

@@ -0,0 +1,52 @@
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| name | `string` | `-` | - |
+| value | `string` | `-` | - |
+| checked | `boolean` | `false` | - |
+| disabled | `boolean` | `false` | - |
+
+### Property Details
+
+#### shadowRootOptions
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+
+#### name
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### value
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### checked
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### disabled
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.

package/dist/docs/switch/switch.md

@@ -0,0 +1,58 @@
+# Switch (w-switch)
+
+## Description
+
+
+
+## API Documentation
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| name | `string` | `-` | - |
+| value | `string` | `-` | - |
+| checked | `boolean` | `false` | - |
+| disabled | `boolean` | `false` | - |
+
+### Property Details
+
+#### shadowRootOptions
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+
+#### name
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### value
+
+
+
+- Type: `string`
+- Default: `-`
+
+#### checked
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+#### disabled
+
+
+
+- Type: `boolean`
+- Default: `false`
+
+### Types
+
+No types documented.