@warp-ds/elements 2.10.0-next.13 → 2.10.0-next.15

package/dist/docs/snackbar-item/api.md

@@ -0,0 +1,41 @@
+### `<w-snackbar-item>` API
+
+#### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| action-placement | [`SnackbarActionPlacement`](#snackbaractionplacement) | `'inline'` | The placement of the action and close buttons. |
+| close (JS only) | `close() => void` | `-` | Remove the snackbar item from the document. |
+| duration | `number` | `-` | How long the message should stay in the document before removing itself. |
+
+#### Property Details
+
+##### action-placement
+
+The placement of the action and close buttons.
+
+- Type: [`SnackbarActionPlacement`](#snackbaractionplacement)
+- Default: `'inline'`
+
+##### close (JS only)
+
+Remove the snackbar item from the document.
+
+Moves focus to the last focused element outside of the snackbar item, if available.
+
+- Type: `close() => void`
+- Default: `-`
+
+##### duration
+
+How long the message should stay in the document before removing itself.
+
+- Type: `number`
+- Default: `-`
+
+#### Types
+
+##### SnackbarActionPlacement
+
+`'inline' | 'block'`
+

package/dist/docs/snackbar-item/snackbar-item.md

@@ -0,0 +1,49 @@
+# SnackbarItem (w-snackbar-item)
+
+## Description
+
+An item to show in a `w-snackbar`.
+
+See the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.
+
+### `<w-snackbar-item>` API
+
+#### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| action-placement | [`SnackbarActionPlacement`](#snackbaractionplacement) | `'inline'` | The placement of the action and close buttons. |
+| close (JS only) | `close() => void` | `-` | Remove the snackbar item from the document. |
+| duration | `number` | `-` | How long the message should stay in the document before removing itself. |
+
+#### Property Details
+
+##### action-placement
+
+The placement of the action and close buttons.
+
+- Type: [`SnackbarActionPlacement`](#snackbaractionplacement)
+- Default: `'inline'`
+
+##### close (JS only)
+
+Remove the snackbar item from the document.
+
+Moves focus to the last focused element outside of the snackbar item, if available.
+
+- Type: `close() => void`
+- Default: `-`
+
+##### duration
+
+How long the message should stay in the document before removing itself.
+
+- Type: `number`
+- Default: `-`
+
+#### Types
+
+##### SnackbarActionPlacement
+
+`'inline' | 'block'`
+

package/dist/docs/step/api.md

@@ -6,6 +6,8 @@
 |-|-|-|-|
 | active | `boolean` | `false` | Whether this step is active. |
 | completed | `boolean` | `false` | Whether this step is completed. |
+| getAriaLabel (JS only) | `getAriaLabel() => void` | `-` | - |
+| setContext (JS only) | `setContext(context: StepsContext) => void` | `-` | - |
 
 #### Property Details
 
@@ -27,3 +29,17 @@ Completed steps display a checkmark icon and a filled indicator.
 - Type: `boolean`
 - Default: `false`
 
+##### getAriaLabel (JS only)
+
+
+
+- Type: `getAriaLabel() => void`
+- Default: `-`
+
+##### setContext (JS only)
+
+
+
+- Type: `setContext(context: StepsContext) => void`
+- Default: `-`
+

package/dist/docs/step/step.md

@@ -12,6 +12,8 @@ Individual step component that shows a single step in a process
 |-|-|-|-|
 | active | `boolean` | `false` | Whether this step is active. |
 | completed | `boolean` | `false` | Whether this step is completed. |
+| getAriaLabel (JS only) | `getAriaLabel() => void` | `-` | - |
+| setContext (JS only) | `setContext(context: StepsContext) => void` | `-` | - |
 
 #### Property Details
 
@@ -33,3 +35,17 @@ Completed steps display a checkmark icon and a filled indicator.
 - Type: `boolean`
 - Default: `false`
 
+##### getAriaLabel (JS only)
+
+
+
+- Type: `getAriaLabel() => void`
+- Default: `-`
+
+##### setContext (JS only)
+
+
+
+- Type: `setContext(context: StepsContext) => void`
+- Default: `-`
+

package/dist/docs/switch/api.md

@@ -9,6 +9,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | checked | `boolean` | `false` | Whether the switch is on (checked). |
 | disabled | `boolean` | `false` | Whether the switch is disabled. |
 | name | `string` | `-` | Name used when submitting an HTML form. |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
 | value | `string` | `-` | Value submitted when the switch is checked. |
 
 ### Property Details
@@ -34,6 +35,13 @@ Name used when submitting an HTML form.
 - Type: `string`
 - Default: `-`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
 #### value
 
 Value submitted when the switch is checked.

package/dist/docs/switch/switch.md

@@ -47,6 +47,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | checked | `boolean` | `false` | Whether the switch is on (checked). |
 | disabled | `boolean` | `false` | Whether the switch is disabled. |
 | name | `string` | `-` | Name used when submitting an HTML form. |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
 | value | `string` | `-` | Value submitted when the switch is checked. |
 
 ### Property Details
@@ -72,6 +73,13 @@ Name used when submitting an HTML form.
 - Type: `string`
 - Default: `-`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
 #### value
 
 Value submitted when the switch is checked.

package/dist/docs/textarea/api.md

@@ -6,7 +6,9 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
+| checkValidity (JS only) | `checkValidity() => boolean` | `-` | Checks whether the textarea passes constraint validation |
 | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
+| handler (JS only) | `handler(e: InputEvent) => void` | `-` | - |
 | help-text | `string \| undefined` | `-` | Description shown below the input field |
 | invalid | `boolean` | `false` | Mark the form field as invalid. |
 | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
@@ -17,13 +19,23 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | placeholder | `string \| undefined` | `-` | Shown in the textarea when it doesn't have a value |
 | read-only | `boolean` | `false` | **Deprecated**: Use the native `readonly` attribute instead |
 | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user |
+| reportValidity (JS only) | `reportValidity() => boolean` | `-` | Checks validity and shows the browser's validation message if invalid |
 | required | `boolean` | `false` | Whether user input is required on the input before form submission |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
+| setCustomValidity (JS only) | `setCustomValidity(message: string) => void` | `-` | Sets a custom validation message. Pass an empty string to clear. |
 | validationMessage (JS only) | `string` | `-` | Returns the validation message if the textarea is invalid, otherwise an empty string |
 | validity (JS only) | `ValidityState` | `-` | Returns the validity state of the textarea |
 | value | `string \| undefined` | `-` | Lets you set the current value |
 
 ### Property Details
 
+#### checkValidity (JS only)
+
+Checks whether the textarea passes constraint validation
+
+- Type: `checkValidity() => boolean`
+- Default: `-`
+
 #### disabled
 
 Keep in mind that using disabled in its current form is an anti-pattern.
@@ -35,6 +47,13 @@ Please consider more informative alternatives before choosing to use disabled on
 - Type: `boolean`
 - Default: `false`
 
+#### handler (JS only)
+
+
+
+- Type: `handler(e: InputEvent) => void`
+- Default: `-`
+
 #### help-text
 
 Use in combination with `invalid` to show as a validation error message,
@@ -112,6 +131,13 @@ Whether the input can be selected but not changed by the user
 - Type: `boolean`
 - Default: `false`
 
+#### reportValidity (JS only)
+
+Checks validity and shows the browser's validation message if invalid
+
+- Type: `reportValidity() => boolean`
+- Default: `-`
+
 #### required
 
 Whether user input is required on the input before form submission
@@ -119,6 +145,20 @@ Whether user input is required on the input before form submission
 - Type: `boolean`
 - Default: `false`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
+#### setCustomValidity (JS only)
+
+Sets a custom validation message. Pass an empty string to clear.
+
+- Type: `setCustomValidity(message: string) => void`
+- Default: `-`
+
 #### validationMessage (JS only)
 
 Returns the validation message if the textarea is invalid, otherwise an empty string

package/dist/docs/textarea/textarea.md

@@ -121,7 +121,9 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
+| checkValidity (JS only) | `checkValidity() => boolean` | `-` | Checks whether the textarea passes constraint validation |
 | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
+| handler (JS only) | `handler(e: InputEvent) => void` | `-` | - |
 | help-text | `string \| undefined` | `-` | Description shown below the input field |
 | invalid | `boolean` | `false` | Mark the form field as invalid. |
 | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
@@ -132,13 +134,23 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | placeholder | `string \| undefined` | `-` | Shown in the textarea when it doesn't have a value |
 | read-only | `boolean` | `false` | **Deprecated**: Use the native `readonly` attribute instead |
 | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user |
+| reportValidity (JS only) | `reportValidity() => boolean` | `-` | Checks validity and shows the browser's validation message if invalid |
 | required | `boolean` | `false` | Whether user input is required on the input before form submission |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
+| setCustomValidity (JS only) | `setCustomValidity(message: string) => void` | `-` | Sets a custom validation message. Pass an empty string to clear. |
 | validationMessage (JS only) | `string` | `-` | Returns the validation message if the textarea is invalid, otherwise an empty string |
 | validity (JS only) | `ValidityState` | `-` | Returns the validity state of the textarea |
 | value | `string \| undefined` | `-` | Lets you set the current value |
 
 ### Property Details
 
+#### checkValidity (JS only)
+
+Checks whether the textarea passes constraint validation
+
+- Type: `checkValidity() => boolean`
+- Default: `-`
+
 #### disabled
 
 Keep in mind that using disabled in its current form is an anti-pattern.
@@ -150,6 +162,13 @@ Please consider more informative alternatives before choosing to use disabled on
 - Type: `boolean`
 - Default: `false`
 
+#### handler (JS only)
+
+
+
+- Type: `handler(e: InputEvent) => void`
+- Default: `-`
+
 #### help-text
 
 Use in combination with `invalid` to show as a validation error message,
@@ -227,6 +246,13 @@ Whether the input can be selected but not changed by the user
 - Type: `boolean`
 - Default: `false`
 
+#### reportValidity (JS only)
+
+Checks validity and shows the browser's validation message if invalid
+
+- Type: `reportValidity() => boolean`
+- Default: `-`
+
 #### required
 
 Whether user input is required on the input before form submission
@@ -234,6 +260,20 @@ Whether user input is required on the input before form submission
 - Type: `boolean`
 - Default: `false`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
+#### setCustomValidity (JS only)
+
+Sets a custom validation message. Pass an empty string to clear.
+
+- Type: `setCustomValidity(message: string) => void`
+- Default: `-`
+
 #### validationMessage (JS only)
 
 Returns the validation message if the textarea is invalid, otherwise an empty string

package/dist/docs/textfield/api.md

@@ -9,6 +9,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | 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. |
 | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
 | formatter (JS only) | `((value: string) => string) \| undefined` | `-` | Function to format value when the input field |
+| handler (JS only) | `handler(e: Event) => void` | `-` | - |
 | help-text | `string \| undefined` | `-` | Description shown below the input field |
 | invalid | `boolean` | `false` | Mark the form field as invalid. |
 | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
@@ -21,11 +22,14 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | 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. |
 | 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) |
 | placeholder | `string \| undefined` | `-` | Shown in the textfield when it doesn't have a value |
+| prefixSlotChange (JS only) | `prefixSlotChange() => void` | `-` | - |
 | read-only | `boolean` | `false` | **Deprecated**: Use the native readonly attribute instead. |
 | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user. |
 | required | `boolean` | `false` | Whether user input is required on the input before form submission. |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
 | 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. |
 | step | `number \| undefined` | `-` | Forces `number` inputs to be a whole number of `step` |
+| suffixSlotChange (JS only) | `suffixSlotChange() => void` | `-` | - |
 | type | `string \| undefined` | `-` | The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types). |
 | value | `string \| undefined` | `-` | Lets you set the current value. |
 
@@ -59,6 +63,13 @@ similar to the accessible input [masking example from Filament Group](https://fi
 - Type: `((value: string) => string) | undefined`
 - Default: `-`
 
+#### handler (JS only)
+
+
+
+- Type: `handler(e: Event) => void`
+- Default: `-`
+
 #### help-text
 
 Use in combination with `invalid` to show as a validation error message,
@@ -150,6 +161,13 @@ Placeholder text should not be used as a substitute for labeling the element wit
 - Type: `string | undefined`
 - Default: `-`
 
+#### prefixSlotChange (JS only)
+
+
+
+- Type: `prefixSlotChange() => void`
+- Default: `-`
+
 #### read-only
 
 **Deprecated**: Use the native readonly attribute instead.
@@ -173,6 +191,13 @@ Whether user input is required on the input before form submission.
 - Type: `boolean`
 - Default: `false`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
 #### size
 
 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.
@@ -190,6 +215,13 @@ Using arrow up and down in the input field increments and decrements by 5.
 - Type: `number | undefined`
 - Default: `-`
 
+#### suffixSlotChange (JS only)
+
+
+
+- Type: `suffixSlotChange() => void`
+- Default: `-`
+
 #### type
 
 The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).

package/dist/docs/textfield/textfield.md

@@ -194,6 +194,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | 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. |
 | disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
 | formatter (JS only) | `((value: string) => string) \| undefined` | `-` | Function to format value when the input field |
+| handler (JS only) | `handler(e: Event) => void` | `-` | - |
 | help-text | `string \| undefined` | `-` | Description shown below the input field |
 | invalid | `boolean` | `false` | Mark the form field as invalid. |
 | label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
@@ -206,11 +207,14 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 | 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. |
 | 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) |
 | placeholder | `string \| undefined` | `-` | Shown in the textfield when it doesn't have a value |
+| prefixSlotChange (JS only) | `prefixSlotChange() => void` | `-` | - |
 | read-only | `boolean` | `false` | **Deprecated**: Use the native readonly attribute instead. |
 | readonly | `boolean` | `false` | Whether the input can be selected but not changed by the user. |
 | required | `boolean` | `false` | Whether user input is required on the input before form submission. |
+| resetFormControl (JS only) | `resetFormControl() => void` | `-` | - |
 | 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. |
 | step | `number \| undefined` | `-` | Forces `number` inputs to be a whole number of `step` |
+| suffixSlotChange (JS only) | `suffixSlotChange() => void` | `-` | - |
 | type | `string \| undefined` | `-` | The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types). |
 | value | `string \| undefined` | `-` | Lets you set the current value. |
 
@@ -244,6 +248,13 @@ similar to the accessible input [masking example from Filament Group](https://fi
 - Type: `((value: string) => string) | undefined`
 - Default: `-`
 
+#### handler (JS only)
+
+
+
+- Type: `handler(e: Event) => void`
+- Default: `-`
+
 #### help-text
 
 Use in combination with `invalid` to show as a validation error message,
@@ -335,6 +346,13 @@ Placeholder text should not be used as a substitute for labeling the element wit
 - Type: `string | undefined`
 - Default: `-`
 
+#### prefixSlotChange (JS only)
+
+
+
+- Type: `prefixSlotChange() => void`
+- Default: `-`
+
 #### read-only
 
 **Deprecated**: Use the native readonly attribute instead.
@@ -358,6 +376,13 @@ Whether user input is required on the input before form submission.
 - Type: `boolean`
 - Default: `false`
 
+#### resetFormControl (JS only)
+
+
+
+- Type: `resetFormControl() => void`
+- Default: `-`
+
 #### size
 
 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.
@@ -375,6 +400,13 @@ Using arrow up and down in the input field increments and decrements by 5.
 - Type: `number | undefined`
 - Default: `-`
 
+#### suffixSlotChange (JS only)
+
+
+
+- Type: `suffixSlotChange() => void`
+- Default: `-`
+
 #### type
 
 The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).