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

package/dist/docs/switch/switch.md

@@ -16,48 +16,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
 

package/dist/docs/tab/api.md

@@ -4,67 +4,53 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| id | `string` | `-` | - |
+| _computedAriaSelected | `'true' \| 'false' \| undefined` | `-` | Computed aria-selected: prefers parent-managed, falls back to own property |
+| active | `boolean` | `false` | **Deprecated**: Use `aria-selected="true"` instead |
+| ariaSelected | `'true' \| 'false'` | `-` | - |
 | for | `string` | `-` | - |
-| tabIndex | `number` | `-` | - |
-| _computedAriaSelected | `'true' | 'false' | undefined` | `-` | - |
-| ariaSelected | `'true' | 'false'` | `-` | - |
-| active | `boolean` | `false` | - |
+| id | `string` | `-` | - |
 | over | `boolean` | `false` | - |
-| _parentTabIndex | `unknown` | `-` | - |
-| _parentAriaSelected | `unknown` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| tabIndex | `number` | `-` | Override tabIndex setter to set _parentTabIndex (for backwards compatibility). |
 
 ### Property Details
 
-#### shadowRootOptions
-
-
-
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
-
-#### id
-
+#### _computedAriaSelected
 
+Computed aria-selected: prefers parent-managed, falls back to own property
 
-- Type: `string`
+- Type: `'true' \| 'false' \| undefined`
 - Default: `-`
 
-#### for
-
+#### active
 
+**Deprecated**: Use `aria-selected="true"` instead
 
-- Type: `string`
-- Default: `-`
 
-#### tabIndex
 
-Override tabIndex setter to set _parentTabIndex (for backwards compatibility).
+- Type: `boolean`
+- Default: `false`
 
-- Type: `number`
-- Default: `-`
+#### ariaSelected
 
-#### _computedAriaSelected
 
-Computed aria-selected: prefers parent-managed, falls back to own property
 
-- Type: `'true' | 'false' | undefined`
+- Type: `'true' \| 'false'`
 - Default: `-`
 
-#### ariaSelected
+#### for
 
 
 
-- Type: `'true' | 'false'`
+- Type: `string`
 - Default: `-`
 
-#### active
+#### id
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string`
+- Default: `-`
 
 #### over
 
@@ -73,18 +59,18 @@ Computed aria-selected: prefers parent-managed, falls back to own property
 - Type: `boolean`
 - Default: `false`
 
-#### _parentTabIndex
-
+#### shadowRootOptions
 
 
-- Type: `unknown`
-- Default: `-`
 
-#### _parentAriaSelected
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
+#### tabIndex
 
+Override tabIndex setter to set _parentTabIndex (for backwards compatibility).
 
-- Type: `unknown`
+- Type: `number`
 - Default: `-`
 
 ### Types

package/dist/docs/tab/tab.md

@@ -18,67 +18,53 @@ Individual tab component used within w-tabs container.
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| id | `string` | `-` | - |
+| _computedAriaSelected | `'true' \| 'false' \| undefined` | `-` | Computed aria-selected: prefers parent-managed, falls back to own property |
+| active | `boolean` | `false` | **Deprecated**: Use `aria-selected="true"` instead |
+| ariaSelected | `'true' \| 'false'` | `-` | - |
 | for | `string` | `-` | - |
-| tabIndex | `number` | `-` | - |
-| _computedAriaSelected | `'true' | 'false' | undefined` | `-` | - |
-| ariaSelected | `'true' | 'false'` | `-` | - |
-| active | `boolean` | `false` | - |
+| id | `string` | `-` | - |
 | over | `boolean` | `false` | - |
-| _parentTabIndex | `unknown` | `-` | - |
-| _parentAriaSelected | `unknown` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| tabIndex | `number` | `-` | Override tabIndex setter to set _parentTabIndex (for backwards compatibility). |
 
 ### Property Details
 
-#### shadowRootOptions
-
-
-
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
-
-#### id
-
+#### _computedAriaSelected
 
+Computed aria-selected: prefers parent-managed, falls back to own property
 
-- Type: `string`
+- Type: `'true' \| 'false' \| undefined`
 - Default: `-`
 
-#### for
-
+#### active
 
+**Deprecated**: Use `aria-selected="true"` instead
 
-- Type: `string`
-- Default: `-`
 
-#### tabIndex
 
-Override tabIndex setter to set _parentTabIndex (for backwards compatibility).
+- Type: `boolean`
+- Default: `false`
 
-- Type: `number`
-- Default: `-`
+#### ariaSelected
 
-#### _computedAriaSelected
 
-Computed aria-selected: prefers parent-managed, falls back to own property
 
-- Type: `'true' | 'false' | undefined`
+- Type: `'true' \| 'false'`
 - Default: `-`
 
-#### ariaSelected
+#### for
 
 
 
-- Type: `'true' | 'false'`
+- Type: `string`
 - Default: `-`
 
-#### active
+#### id
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string`
+- Default: `-`
 
 #### over
 
@@ -87,18 +73,18 @@ Computed aria-selected: prefers parent-managed, falls back to own property
 - Type: `boolean`
 - Default: `false`
 
-#### _parentTabIndex
-
+#### shadowRootOptions
 
 
-- Type: `unknown`
-- Default: `-`
 
-#### _parentAriaSelected
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
+#### tabIndex
 
+Override tabIndex setter to set _parentTabIndex (for backwards compatibility).
 
-- Type: `unknown`
+- Type: `number`
 - Default: `-`
 
 ### Types

package/dist/docs/tab-panel/api.md

@@ -4,9 +4,7 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| active | `boolean` | `-` | - |
-| _parentActive | `unknown` | `-` | - |
-| _parentAriaLabelledBy | `unknown` | `-` | - |
+| active | `boolean` | `-` | Whether this panel is active (visible). |
 
 ### Property Details
 
@@ -18,20 +16,6 @@ Set by parent w-tabs via the _parentActive property.
 - Type: `boolean`
 - Default: `-`
 
-#### _parentActive
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### _parentAriaLabelledBy
-
-
-
-- Type: `unknown`
-- Default: `-`
-
 ### Types
 
 No types documented.

package/dist/docs/tab-panel/tab-panel.md

@@ -19,9 +19,7 @@ Each tab panel should have a name that matches a corresponding tab.
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| active | `boolean` | `-` | - |
-| _parentActive | `unknown` | `-` | - |
-| _parentAriaLabelledBy | `unknown` | `-` | - |
+| active | `boolean` | `-` | Whether this panel is active (visible). |
 
 ### Property Details
 
@@ -33,20 +31,6 @@ Set by parent w-tabs via the _parentActive property.
 - Type: `boolean`
 - Default: `-`
 
-#### _parentActive
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### _parentAriaLabelledBy
-
-
-
-- Type: `unknown`
-- Default: `-`
-
 ### Types
 
 No types documented.

package/dist/docs/tabs/api.md

@@ -5,8 +5,8 @@
 | Name | Type | Default | Summary |
 |-|-|-|-|
 | active | `string` | `-` | - |
-| tabs | `unknown` | `-` | - |
 | activeTab | `unknown` | `-` | - |
+| tabs | `unknown` | `-` | - |
 
 ### Property Details
 
@@ -17,14 +17,14 @@
 - Type: `string`
 - Default: `-`
 
-#### tabs
+#### activeTab
 
 
 
 - Type: `unknown`
 - Default: `-`
 
-#### activeTab
+#### tabs
 
 
 

package/dist/docs/tabs/tabs.md

@@ -19,8 +19,8 @@ Tabs are used to organize content by grouping similar information on the same pa
 | Name | Type | Default | Summary |
 |-|-|-|-|
 | active | `string` | `-` | - |
-| tabs | `unknown` | `-` | - |
 | activeTab | `unknown` | `-` | - |
+| tabs | `unknown` | `-` | - |
 
 ### Property Details
 
@@ -31,14 +31,14 @@ Tabs are used to organize content by grouping similar information on the same pa
 - Type: `string`
 - Default: `-`
 
-#### tabs
+#### activeTab
 
 
 
 - Type: `unknown`
 - Default: `-`
 
-#### activeTab
+#### tabs
 
 
 

package/dist/docs/textarea/accessibility.md

@@ -1 +1,6 @@
 ## Accessibility
+
+If a visible label isn't specified, an `aria-label` must be provided to the text field for accessibility. If the field is labeled by a separate element, an `aria-labelledby` property must be provided using the `id` of the labeling element instead.
+
+- Always provide a visible label (do not rely on `placeholder` alone).
+- Do not rely on color alone for interaction feedback (e.g. error states).

package/dist/docs/textarea/api.md

@@ -4,92 +4,100 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
-| disabled | `boolean` | `false` | - |
-| invalid | `boolean` | `false` | - |
-| label | `string` | `-` | - |
-| helpText | `string` | `-` | - |
-| maxRows | `number` | `-` | - |
-| minRows | `number` | `-` | - |
-| name | `string` | `-` | - |
-| placeholder | `string` | `-` | - |
-| readOnly | `boolean` | `false` | - |
-| readonly | `boolean` | `false` | - |
-| required | `boolean` | `false` | - |
-| value | `string` | `-` | - |
-| optional | `boolean` | `false` | - |
-| minHeight | `unknown` | `-` | - |
-| maxHeight | `unknown` | `-` | - |
-| validationMessage | `string` | `-` | - |
-| validity | `ValidityState` | `-` | - |
+| disabled | `boolean` | `false` | Makes the element not focusable and hides it from form submits |
+| helpText | `string` | `-` | Description shown below the input field |
+| invalid | `boolean` | `false` | Mark the form field as invalid. |
+| label | `string` | `-` | Either a `label` or an `aria-label` must be provided. |
+| maxRows | `number` | `-` | Sets the maximum number of text rows before the content starts scrolling. |
+| minRows | `number` | `-` | Sets the minimum number of text rows the textarea should display |
+| 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 |
+| optional | `boolean` | `false` | Show an icon behind the label indicating the field is optional |
+| placeholder | `string` | `-` | Shown in the textarea when it doesn't have a value |
+| readOnly | `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 |
+| validationMessage | `string` | `-` | Returns the validation message if the textarea is invalid, otherwise an empty string |
+| validity | `ValidityState` | `-` | Returns the validity state of the textarea |
+| value | `string` | `-` | Lets you set the current value |
 
 ### Property Details
 
-#### shadowRootOptions
+#### disabled
 
+Keep in mind that using disabled in its current form is an anti-pattern.
 
+There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+Please consider more informative alternatives before choosing to use disabled on an element.
 
-#### disabled
+- Type: `boolean`
+- Default: `false`
 
+#### helpText
 
+Use in combination with `invalid` to show as a validation error message,
+or on its own to show a help text.
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string`
+- Default: `-`
 
 #### invalid
 
+Mark the form field as invalid.
 
+Make sure to also set a `help-text` to help users fix the validation problem.
 
 - Type: `boolean`
 - Default: `false`
 
 #### label
 
-
-
-- Type: `string`
-- Default: `-`
-
-#### helpText
-
-
+Either a `label` or an `aria-label` must be provided.
 
 - Type: `string`
 - Default: `-`
 
 #### maxRows
 
-
+Sets the maximum number of text rows before the content starts scrolling.
 
 - Type: `number`
 - Default: `-`
 
 #### minRows
 
-
+Sets the minimum number of text rows the textarea should display
 
 - Type: `number`
 - Default: `-`
 
 #### name
 
-
+The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form
 
 - Type: `string`
 - Default: `-`
 
+#### optional
+
+Show an icon behind the label indicating the field is optional
+
+- Type: `boolean`
+- Default: `false`
+
 #### placeholder
 
+Set a text that is shown in the textarea when it doesn't have a value.
 
+Placeholder text should not be used as a substitute for labeling the element with a visible label.
 
 - Type: `string`
 - Default: `-`
 
 #### readOnly
 
+**Deprecated**: Use the native `readonly` attribute instead
+
 
 
 - Type: `boolean`
@@ -97,46 +105,18 @@
 
 #### readonly
 
-
+Whether the input can be selected but not changed by the user
 
 - Type: `boolean`
 - Default: `false`
 
 #### required
 
-
+Whether user input is required on the input before form submission
 
 - Type: `boolean`
 - Default: `false`
 
-#### value
-
-
-
-- Type: `string`
-- Default: `-`
-
-#### optional
-
-
-
-- Type: `boolean`
-- Default: `false`
-
-#### minHeight
-
-
-
-- Type: `unknown`
-- Default: `-`
-
-#### maxHeight
-
-
-
-- Type: `unknown`
-- Default: `-`
-
 #### validationMessage
 
 Returns the validation message if the textarea is invalid, otherwise an empty string
@@ -151,6 +131,13 @@ Returns the validity state of the textarea
 - Type: `ValidityState`
 - Default: `-`
 
+#### value
+
+Lets you set the current value
+
+- Type: `string`
+- Default: `-`
+
 ### Types
 
 No types documented.

package/dist/docs/textarea/examples.md

@@ -1 +1,82 @@
 ## Examples
+
+<elements-example>
+
+```html
+<w-textarea label="Description"></w-textarea>
+```
+
+</elements-example>
+
+### Placeholder
+
+Text hint that appears when the textarea is empty. Placeholder text should not be used as a substitute for a visible label.
+
+<elements-example>
+
+```html
+<w-textarea
+    label="Description"
+    placeholder="Give as much detail as you can"
+></w-textarea>
+```
+
+</elements-example>
+
+### Height
+
+You can control the height of the input field by setting either `minimum-rows` or `maximum-rows`
+
+<elements-example>
+    
+```html
+<w-textarea label="Description" minimum-rows="3"></w-textarea>
+```
+
+</elements-example>
+
+With `maximum-rows` the content will start scrolling when it passes the limit. Note that the field stops being resizable. Setting `minimum-rows` is redundant when you set `maximum-rows`.
+
+<elements-example>
+
+```html
+<w-textarea label="Description" maximum-rows="3" value="Line 1
+Line 2
+Line 3
+Line 4
+Line 5"></w-textarea>
+```
+
+</elements-example>
+
+### Disabled
+
+Consider using more informative alternatives before choosing to use disabled, as some users may not understand why an element is disabled.
+
+<elements-example>
+
+```html
+<w-textarea
+    label="Description" 
+    value="This form field is ignored"
+    disabled
+></w-textarea>
+```
+
+</elements-example>
+
+### Read only 
+
+Makes the textarea content immutable while remaining focusable. The contents can still be copied.
+
+<elements-example>
+
+```html
+<w-textarea
+    label="Description"
+    value="This content is read only"
+    readonly
+></w-textarea>
+```
+
+</elements-example>