@warp-ds/elements 2.9.2-next.1 → 2.10.0-next.10

package/dist/docs/card/usage.md

@@ -1 +1,77 @@
 ## Usage
+
+Card is a layout component for visually grouping related content as one item.
+
+Use `w-card` for listings, summaries, recommendations, or selectable choices where the grouped content should feel like a single object. The component does not add padding, headings, spacing between children, or semantic structure. Those must be provided by the content inside the card.
+
+### Basic Card
+
+```html
+<w-card>
+  <div style="padding: 16px;">
+    <h3>Apartment in Oslo</h3>
+    <p>Bright 3-room apartment with balcony.</p>
+  </div>
+</w-card>
+```
+
+### Visual Treatments
+
+The default card uses an elevated surface. Use `flat` when the card should sit more quietly in the layout.
+
+```html
+<w-card>
+  <div style="padding: 16px;">
+    <h3>Elevated card</h3>
+    <p>Use this for cards that need more visual separation.</p>
+  </div>
+</w-card>
+
+<w-card flat>
+  <div style="padding: 16px;">
+    <h3>Flat card</h3>
+    <p>Use this for dense layouts or cards inside another surface.</p>
+  </div>
+</w-card>
+```
+
+### Selected Cards
+
+Use `selected` when a card represents a selected item or choice.
+
+```html
+<w-card selected>
+  <div style="padding: 16px;">
+    <h3>Standard delivery</h3>
+    <p>Delivered in 2-4 business days.</p>
+  </div>
+</w-card>
+```
+
+The `selected` property only controls the card's visual state. Update it from your application state when the selection changes.
+
+### Clickable Cards
+
+Use `clickable` when the whole card should behave as one interactive choice. The card becomes keyboard focusable, and Enter or Space triggers a click on the card.
+
+```html
+<w-card clickable>
+  <div style="padding: 16px;">
+    <h3>Pick up nearby</h3>
+    <p>Collect the item from a pickup point.</p>
+  </div>
+</w-card>
+```
+
+Listen for the card's click event and update `selected` yourself.
+
+```html
+<w-card clickable selected>
+  <div style="padding: 16px;">
+    <h3>Home delivery</h3>
+    <p>Delivered to your door.</p>
+  </div>
+</w-card>
+```
+
+Do not use `clickable` when the card contains separate links, buttons, form controls, or other interactive elements. In those cases, keep the card non-clickable and make the specific control interactive instead.

package/dist/docs/checkbox/api.md

@@ -0,0 +1,128 @@
+### `<w-checkbox>` API
+
+#### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| _computedInvalid (JS only) | `boolean` | `-` | Computed invalid state: combines own invalid with group invalid |
+| checked | `boolean` | `false` | Whether the checkbox is checked. |
+| disabled | `boolean` | `false` | Whether the checkbox is disabled. |
+| indeterminate | `boolean` | `false` | Whether the checkbox is visually indeterminate. |
+| input (JS only) | `HTMLInputElement \| null` | `-` | - |
+| invalid | `boolean` | `false` | Whether the checkbox is visually invalid. |
+| name | `string \| undefined` | `-` | The name of the checkbox. |
+| required | `boolean` | `false` | Whether the checkbox must be checked before form submission. |
+| shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true }` | - |
+| validationMessage (JS only) | `string` | `-` | Returns the validation message if the checkbox is invalid, otherwise an empty string |
+| validity (JS only) | `ValidityState` | `-` | Returns the validity state of the checkbox |
+| value | `string \| null` | `null` | The value submitted when the checkbox is checked. |
+
+#### Property Details
+
+##### _computedInvalid (JS only)
+
+Computed invalid state: combines own invalid with group invalid
+
+- Type: `boolean`
+- Default: `-`
+
+##### checked
+
+Whether the checkbox is checked.
+
+Checked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.
+
+- Type: `boolean`
+- Default: `false`
+
+##### disabled
+
+Whether the checkbox is disabled.
+
+Disabled checkboxes cannot be focused, changed, or submitted with form data.
+
+- Type: `boolean`
+- Default: `false`
+
+##### indeterminate
+
+Whether the checkbox is visually indeterminate.
+
+Use this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.
+
+- Type: `boolean`
+- Default: `false`
+
+##### input (JS only)
+
+
+
+- Type: `HTMLInputElement | null`
+- Default: `-`
+
+##### invalid
+
+Whether the checkbox is visually invalid.
+
+Use this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.
+
+- Type: `boolean`
+- Default: `false`
+
+##### name
+
+The name of the checkbox.
+
+When the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.
+
+- Type: `string | undefined`
+- Default: `-`
+
+##### required
+
+Whether the checkbox must be checked before form submission.
+
+A required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.
+
+- Type: `boolean`
+- Default: `false`
+
+##### shadowRootOptions (JS only)
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true }`
+
+##### validationMessage (JS only)
+
+Returns the validation message if the checkbox is invalid, otherwise an empty string
+
+- Type: `string`
+- Default: `-`
+
+##### validity (JS only)
+
+Returns the validity state of the checkbox
+
+- Type: `ValidityState`
+- Default: `-`
+
+##### value
+
+The value submitted when the checkbox is checked.
+
+If no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.
+
+- Type: `string | null`
+- Default: `null`
+
+#### Events
+
+##### change
+
+
+
+- Type: `Event`
+
+

package/dist/docs/checkbox/checkbox.md

@@ -0,0 +1,134 @@
+# Checkbox (w-checkbox)
+
+## Description
+
+Checkbox lets users select one or more options. Use it for independent yes/no choices, multi-select lists, and terms or consent confirmations.
+
+### `<w-checkbox>` API
+
+#### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| _computedInvalid (JS only) | `boolean` | `-` | Computed invalid state: combines own invalid with group invalid |
+| checked | `boolean` | `false` | Whether the checkbox is checked. |
+| disabled | `boolean` | `false` | Whether the checkbox is disabled. |
+| indeterminate | `boolean` | `false` | Whether the checkbox is visually indeterminate. |
+| input (JS only) | `HTMLInputElement \| null` | `-` | - |
+| invalid | `boolean` | `false` | Whether the checkbox is visually invalid. |
+| name | `string \| undefined` | `-` | The name of the checkbox. |
+| required | `boolean` | `false` | Whether the checkbox must be checked before form submission. |
+| shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true }` | - |
+| validationMessage (JS only) | `string` | `-` | Returns the validation message if the checkbox is invalid, otherwise an empty string |
+| validity (JS only) | `ValidityState` | `-` | Returns the validity state of the checkbox |
+| value | `string \| null` | `null` | The value submitted when the checkbox is checked. |
+
+#### Property Details
+
+##### _computedInvalid (JS only)
+
+Computed invalid state: combines own invalid with group invalid
+
+- Type: `boolean`
+- Default: `-`
+
+##### checked
+
+Whether the checkbox is checked.
+
+Checked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.
+
+- Type: `boolean`
+- Default: `false`
+
+##### disabled
+
+Whether the checkbox is disabled.
+
+Disabled checkboxes cannot be focused, changed, or submitted with form data.
+
+- Type: `boolean`
+- Default: `false`
+
+##### indeterminate
+
+Whether the checkbox is visually indeterminate.
+
+Use this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.
+
+- Type: `boolean`
+- Default: `false`
+
+##### input (JS only)
+
+
+
+- Type: `HTMLInputElement | null`
+- Default: `-`
+
+##### invalid
+
+Whether the checkbox is visually invalid.
+
+Use this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.
+
+- Type: `boolean`
+- Default: `false`
+
+##### name
+
+The name of the checkbox.
+
+When the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.
+
+- Type: `string | undefined`
+- Default: `-`
+
+##### required
+
+Whether the checkbox must be checked before form submission.
+
+A required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.
+
+- Type: `boolean`
+- Default: `false`
+
+##### shadowRootOptions (JS only)
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true }`
+
+##### validationMessage (JS only)
+
+Returns the validation message if the checkbox is invalid, otherwise an empty string
+
+- Type: `string`
+- Default: `-`
+
+##### validity (JS only)
+
+Returns the validity state of the checkbox
+
+- Type: `ValidityState`
+- Default: `-`
+
+##### value
+
+The value submitted when the checkbox is checked.
+
+If no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.
+
+- Type: `string | null`
+- Default: `null`
+
+#### Events
+
+##### change
+
+
+
+- Type: `Event`
+
+

package/dist/docs/checkbox-group/accessibility.md

@@ -0,0 +1,71 @@
+## Accessibility
+
+Checkbox group renders the child checkboxes inside an element with `role="group"`. The group label is connected to the group, and help text is connected when provided.
+
+### Provide A Group Label
+
+Use `label` to describe the shared question or topic.
+
+```html
+<w-checkbox-group label="Interests" name="interests">
+  <w-checkbox value="housing">Housing</w-checkbox>
+  <w-checkbox value="jobs">Jobs</w-checkbox>
+  <w-checkbox value="travel">Travel</w-checkbox>
+</w-checkbox-group>
+```
+
+The group label should not duplicate every option label. It should explain what the options are about.
+
+### Use Help Text For Extra Context
+
+Use `help-text` for instructions, constraints, or validation feedback.
+
+```html
+<w-checkbox-group label="Interests" help-text="Select all that apply" name="interests">
+  <w-checkbox value="housing">Housing</w-checkbox>
+  <w-checkbox value="jobs">Jobs</w-checkbox>
+  <w-checkbox value="travel">Travel</w-checkbox>
+</w-checkbox-group>
+```
+
+Keep help text short and actionable.
+
+### Required Groups
+
+Use `required` on the group when at least one option must be selected.
+
+```html
+<w-checkbox-group label="Preferences" required help-text="Choose at least one" name="preferences">
+  <w-checkbox value="email">Email</w-checkbox>
+  <w-checkbox value="sms">SMS</w-checkbox>
+</w-checkbox-group>
+```
+
+Do not put `required` on each child checkbox for a "choose at least one" requirement. That would mean every option must be selected.
+
+### Validation Feedback
+
+Do not rely on invalid styling alone. Provide clear help text that explains what the user needs to do.
+
+```html
+<w-checkbox-group label="Preferences" invalid help-text="Select at least one option" name="preferences">
+  <w-checkbox value="email">Email</w-checkbox>
+  <w-checkbox value="sms">SMS</w-checkbox>
+</w-checkbox-group>
+```
+
+When the group is invalid, the invalid state is also shared with child checkboxes for consistent styling and accessibility state.
+
+### Checkbox Labels
+
+Each child checkbox still needs its own clear label.
+
+```html
+<w-checkbox-group label="Contact preferences" name="contact">
+  <w-checkbox value="email">Email</w-checkbox>
+  <w-checkbox value="sms">SMS</w-checkbox>
+  <w-checkbox value="push">Push notifications</w-checkbox>
+</w-checkbox-group>
+```
+
+Avoid option labels that only make sense visually, such as "Yes" or "This one", unless the group label gives enough context.

package/dist/docs/checkbox-group/api.md

@@ -0,0 +1,79 @@
+## `<w-checkbox-group>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
+
+### Properties
+
+| Name | Type | Default | Summary |
+|-|-|-|-|
+| help-text | `string` | `-` | Help text displayed below the checkbox group. |
+| invalid | `boolean` | `false` | Whether the checkbox group is visually invalid. |
+| label | `string` | `-` | The group label displayed above the checkboxes. |
+| name | `string` | `-` | The name applied to child checkboxes when they do not provide one. |
+| optional | `boolean` | `false` | Whether to show optional text next to the label. |
+| required | `boolean` | `false` | Whether at least one checkbox in the group must be selected. |
+| shadowRootOptions (JS only) | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+
+### Property Details
+
+#### help-text
+
+Help text displayed below the checkbox group.
+
+Use this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.
+
+- Type: `string`
+- Default: `-`
+
+#### invalid
+
+Whether the checkbox group is visually invalid.
+
+Use this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.
+
+- Type: `boolean`
+- Default: `false`
+
+#### label
+
+The group label displayed above the checkboxes.
+
+Use this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.
+
+- Type: `string`
+- Default: `-`
+
+#### name
+
+The name applied to child checkboxes when they do not provide one.
+
+Use this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.
+
+- Type: `string`
+- Default: `-`
+
+#### optional
+
+Whether to show optional text next to the label.
+
+Use this to indicate that selecting an option from the group is not required.
+
+- Type: `boolean`
+- Default: `false`
+
+#### required
+
+Whether at least one checkbox in the group must be selected.
+
+Required validation is managed by the group. The individual checkboxes provide the submitted form values.
+
+- Type: `boolean`
+- Default: `false`
+
+#### shadowRootOptions (JS only)
+
+
+
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+