@warp-ds/elements 2.9.0-next.4 → 2.9.0-next.6

package/dist/docs/combobox/api.md

@@ -4,129 +4,129 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| options | `ComboboxOption[]` | `[]` | - |
-| label | `string | undefined` | `''` | - |
-| placeholder | `string | undefined` | `''` | - |
-| value | `string` | `''` | - |
-| openOnFocus | `boolean` | `false` | - |
-| selectOnBlur | `boolean` | `true` | - |
-| matchTextSegments | `boolean` | `false` | - |
-| disableStaticFiltering | `boolean` | `false` | - |
-| invalid | `boolean` | `false` | - |
-| helpText | `string | undefined` | `''` | - |
-| disabled | `boolean` | `false` | - |
-| required | `boolean` | `false` | - |
-| optional | `boolean` | `false` | - |
-| name | `string | undefined` | `''` | - |
-| autocomplete | `string | undefined` | `'off'` | - |
+| autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
+| disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
+| disabled | `boolean` | `false` | Whether the element is disabled |
+| helpText | `string \| undefined` | `''` | The content to display as the help text |
+| invalid | `boolean` | `false` | Renders the input field in an invalid state |
+| label | `string \| undefined` | `''` | Label above input |
+| matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
+| name | `string \| undefined` | `''` | Name attribute for form submission |
+| openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
+| optional | `boolean` | `false` | Whether to show optional text |
+| options | `ComboboxOption[]` | `[]` | The available options to select from |
+| placeholder | `string \| undefined` | `''` | Input placeholder |
+| required | `boolean` | `false` | Whether the element is required |
+| selectOnBlur | `boolean` | `true` | Select active option on blur |
+| value | `string` | `''` | The input value |
 
 ### Property Details
 
-#### options
-
-
-
-- Type: `ComboboxOption[]`
-- Default: `[]`
-
-#### label
+#### autocomplete
 
+Autocomplete attribute for the input field
 
+- Type: `string \| undefined`
+- Default: `'off'`
 
-- Type: `string | undefined`
-- Default: `''`
+#### disableStaticFiltering
 
-#### placeholder
+Disable client-side static filtering
 
+- Type: `boolean`
+- Default: `false`
 
+#### disabled
 
-- Type: `string | undefined`
-- Default: `''`
+Whether the element is disabled
 
-#### value
+- Type: `boolean`
+- Default: `false`
 
+#### helpText
 
+The content to display as the help text
 
-- Type: `string`
+- Type: `string \| undefined`
 - Default: `''`
 
-#### openOnFocus
-
+#### invalid
 
+Renders the input field in an invalid state
 
 - Type: `boolean`
 - Default: `false`
 
-#### selectOnBlur
-
+#### label
 
+Label above input
 
-- Type: `boolean`
-- Default: `true`
+- Type: `string \| undefined`
+- Default: `''`
 
 #### matchTextSegments
 
-
+Whether the matching text segments in the options should be highlighted
 
 - Type: `boolean`
 - Default: `false`
 
-#### disableStaticFiltering
+#### name
 
+Name attribute for form submission
 
+- Type: `string \| undefined`
+- Default: `''`
+
+#### openOnFocus
+
+Whether the popover opens when focus is on the text field
 
 - Type: `boolean`
 - Default: `false`
 
-#### invalid
-
+#### optional
 
+Whether to show optional text
 
 - Type: `boolean`
 - Default: `false`
 
-#### helpText
-
-
+#### options
 
-- Type: `string | undefined`
-- Default: `''`
+The available options to select from
 
-#### disabled
+- Type: `ComboboxOption[]`
+- Default: `[]`
 
+#### placeholder
 
+Input placeholder
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string \| undefined`
+- Default: `''`
 
 #### required
 
-
+Whether the element is required
 
 - Type: `boolean`
 - Default: `false`
 
-#### optional
-
+#### selectOnBlur
 
+Select active option on blur
 
 - Type: `boolean`
-- Default: `false`
-
-#### name
+- Default: `true`
 
+#### value
 
+The input value
 
-- Type: `string | undefined`
+- Type: `string`
 - Default: `''`
 
-#### autocomplete
-
-
-
-- Type: `string | undefined`
-- Default: `'off'`
-
 ### Types
 
 No types documented.

package/dist/docs/combobox/combobox.md

@@ -18,129 +18,129 @@ A combobox element for text input with selectable options.
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| options | `ComboboxOption[]` | `[]` | - |
-| label | `string | undefined` | `''` | - |
-| placeholder | `string | undefined` | `''` | - |
-| value | `string` | `''` | - |
-| openOnFocus | `boolean` | `false` | - |
-| selectOnBlur | `boolean` | `true` | - |
-| matchTextSegments | `boolean` | `false` | - |
-| disableStaticFiltering | `boolean` | `false` | - |
-| invalid | `boolean` | `false` | - |
-| helpText | `string | undefined` | `''` | - |
-| disabled | `boolean` | `false` | - |
-| required | `boolean` | `false` | - |
-| optional | `boolean` | `false` | - |
-| name | `string | undefined` | `''` | - |
-| autocomplete | `string | undefined` | `'off'` | - |
+| autocomplete | `string \| undefined` | `'off'` | Autocomplete attribute for the input field |
+| disableStaticFiltering | `boolean` | `false` | Disable client-side static filtering |
+| disabled | `boolean` | `false` | Whether the element is disabled |
+| helpText | `string \| undefined` | `''` | The content to display as the help text |
+| invalid | `boolean` | `false` | Renders the input field in an invalid state |
+| label | `string \| undefined` | `''` | Label above input |
+| matchTextSegments | `boolean` | `false` | Whether the matching text segments in the options should be highlighted |
+| name | `string \| undefined` | `''` | Name attribute for form submission |
+| openOnFocus | `boolean` | `false` | Whether the popover opens when focus is on the text field |
+| optional | `boolean` | `false` | Whether to show optional text |
+| options | `ComboboxOption[]` | `[]` | The available options to select from |
+| placeholder | `string \| undefined` | `''` | Input placeholder |
+| required | `boolean` | `false` | Whether the element is required |
+| selectOnBlur | `boolean` | `true` | Select active option on blur |
+| value | `string` | `''` | The input value |
 
 ### Property Details
 
-#### options
-
-
-
-- Type: `ComboboxOption[]`
-- Default: `[]`
-
-#### label
+#### autocomplete
 
+Autocomplete attribute for the input field
 
+- Type: `string \| undefined`
+- Default: `'off'`
 
-- Type: `string | undefined`
-- Default: `''`
+#### disableStaticFiltering
 
-#### placeholder
+Disable client-side static filtering
 
+- Type: `boolean`
+- Default: `false`
 
+#### disabled
 
-- Type: `string | undefined`
-- Default: `''`
+Whether the element is disabled
 
-#### value
+- Type: `boolean`
+- Default: `false`
 
+#### helpText
 
+The content to display as the help text
 
-- Type: `string`
+- Type: `string \| undefined`
 - Default: `''`
 
-#### openOnFocus
-
+#### invalid
 
+Renders the input field in an invalid state
 
 - Type: `boolean`
 - Default: `false`
 
-#### selectOnBlur
-
+#### label
 
+Label above input
 
-- Type: `boolean`
-- Default: `true`
+- Type: `string \| undefined`
+- Default: `''`
 
 #### matchTextSegments
 
-
+Whether the matching text segments in the options should be highlighted
 
 - Type: `boolean`
 - Default: `false`
 
-#### disableStaticFiltering
+#### name
 
+Name attribute for form submission
 
+- Type: `string \| undefined`
+- Default: `''`
+
+#### openOnFocus
+
+Whether the popover opens when focus is on the text field
 
 - Type: `boolean`
 - Default: `false`
 
-#### invalid
-
+#### optional
 
+Whether to show optional text
 
 - Type: `boolean`
 - Default: `false`
 
-#### helpText
-
-
+#### options
 
-- Type: `string | undefined`
-- Default: `''`
+The available options to select from
 
-#### disabled
+- Type: `ComboboxOption[]`
+- Default: `[]`
 
+#### placeholder
 
+Input placeholder
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string \| undefined`
+- Default: `''`
 
 #### required
 
-
+Whether the element is required
 
 - Type: `boolean`
 - Default: `false`
 
-#### optional
-
+#### selectOnBlur
 
+Select active option on blur
 
 - Type: `boolean`
-- Default: `false`
-
-#### name
+- Default: `true`
 
+#### value
 
+The input value
 
-- Type: `string | undefined`
+- Type: `string`
 - Default: `''`
 
-#### autocomplete
-
-
-
-- Type: `string | undefined`
-- Default: `'off'`
-
 ### Types
 
 No types documented.

package/dist/docs/datepicker/api.md

@@ -4,99 +4,105 @@
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| calendar | `HTMLDivElement` | `-` | - |
+| dayFormat | `string` | `'PPPP'` | Decides the format of the day in the calendar as read to screen readers. |
+| headerFormat | `string` | `'MMMM yyyy'` | Decides the format of the date as shown in the calendar header. |
+| input | `HTMLInputElement` | `-` | - |
+| isCalendarOpen | `boolean` | `false` | - |
+| isDayDisabled | `(day: Date) => boolean` | `-` | Lets you control if a date in the calendar should be disabled. |
 | label | `string` | `-` | - |
-| lang | `string` | `-` | - |
+| lang | `string` | `-` | Takes precedence over the `<html>` lang attribute. |
+| month | `unknown` | `-` | - |
 | name | `string` | `-` | - |
-| value | `string` | `-` | - |
-| headerFormat | `string` | `'MMMM yyyy'` | - |
-| weekdayFormat | `string` | `'EEEEEE'` | - |
-| isDayDisabled | `(day: Date) => boolean` | `-` | - |
-| dayFormat | `string` | `'PPPP'` | - |
-| isCalendarOpen | `boolean` | `false` | - |
 | navigationDate | `Date` | `-` | - |
-| selectedDate | `Date | null` | `-` | - |
-| month | `unknown` | `-` | - |
-| weeks | `unknown` | `-` | - |
-| calendar | `HTMLDivElement` | `-` | - |
-| input | `HTMLInputElement` | `-` | - |
+| previousMonthButton | `HTMLButtonElement` | `-` | This is the first focusable element, needed for the modal focus trap. |
+| selectedCell | `HTMLTableCellElement` | `-` | - |
+| selectedDate | `Date \| null` | `-` | - |
+| shadowRootOptions | `object` | `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }` | - |
+| todayCell | `HTMLTableCellElement` | `-` | - |
 | toggleButton | `HTMLButtonElement` | `-` | - |
+| value | `string` | `-` | - |
+| weekdayFormat | `string` | `'EEEEEE'` | Decides the format of the weekday as shown above the grid of dates in the calendar. |
+| weeks | `unknown` | `-` | - |
 | wrapper | `HTMLDivElement` | `-` | - |
-| previousMonthButton | `HTMLButtonElement` | `-` | - |
-| todayCell | `HTMLTableCellElement` | `-` | - |
-| selectedCell | `HTMLTableCellElement` | `-` | - |
 
 ### Property Details
 
-#### shadowRootOptions
+#### calendar
 
 
 
-- Type: `object`
-- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
+- Type: `HTMLDivElement`
+- Default: `-`
 
-#### label
+#### dayFormat
 
+Decides the format of the day in the calendar as read to screen readers.
 
+The syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).
 
 - Type: `string`
-- Default: `-`
+- Default: `'PPPP'`
 
-#### lang
+#### headerFormat
 
+Decides the format of the date as shown in the calendar header.
 
+The syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).
 
 - Type: `string`
-- Default: `-`
+- Default: `'MMMM yyyy'`
 
-#### name
+#### input
 
 
 
-- Type: `string`
+- Type: `HTMLInputElement`
 - Default: `-`
 
-#### value
+#### isCalendarOpen
 
 
 
-- Type: `string`
-- Default: `-`
+- Type: `boolean`
+- Default: `false`
 
-#### headerFormat
+#### isDayDisabled
 
+Lets you control if a date in the calendar should be disabled.
 
+This needs to be set on the element instance in JavaScript, not as an HTML attribute.
 
-- Type: `string`
-- Default: `'MMMM yyyy'`
+- Type: `(day: Date) => boolean`
+- Default: `-`
 
-#### weekdayFormat
+#### label
 
 
 
 - Type: `string`
-- Default: `'EEEEEE'`
-
-#### isDayDisabled
+- Default: `-`
 
+#### lang
 
+Takes precedence over the `<html>` lang attribute.
 
-- Type: `(day: Date) => boolean`
+- Type: `string`
 - Default: `-`
 
-#### dayFormat
+#### month
 
 
 
-- Type: `string`
-- Default: `'PPPP'`
+- Type: `unknown`
+- Default: `-`
 
-#### isCalendarOpen
+#### name
 
 
 
-- Type: `boolean`
-- Default: `false`
+- Type: `string`
+- Default: `-`
 
 #### navigationDate
 
@@ -105,39 +111,43 @@
 - Type: `Date`
 - Default: `-`
 
-#### selectedDate
+#### previousMonthButton
 
+This is the first focusable element, needed for the modal focus trap.
 
+Don't cache this and other `@query` fields from inside the calendar modal.
+They work the first time, but once the calendar is closed and reopened
+the query will point to an element that doesn't exist anymore.
 
-- Type: `Date | null`
+- Type: `HTMLButtonElement`
 - Default: `-`
 
-#### month
+#### selectedCell
 
 
 
-- Type: `unknown`
+- Type: `HTMLTableCellElement`
 - Default: `-`
 
-#### weeks
+#### selectedDate
 
 
 
-- Type: `unknown`
+- Type: `Date \| null`
 - Default: `-`
 
-#### calendar
+#### shadowRootOptions
 
 
 
-- Type: `HTMLDivElement`
-- Default: `-`
+- Type: `object`
+- Default: `{ ...LitElement.shadowRootOptions, delegatesFocus: true, }`
 
-#### input
+#### todayCell
 
 
 
-- Type: `HTMLInputElement`
+- Type: `HTMLTableCellElement`
 - Default: `-`
 
 #### toggleButton
@@ -147,36 +157,34 @@
 - Type: `HTMLButtonElement`
 - Default: `-`
 
-#### wrapper
+#### value
 
 
 
-- Type: `HTMLDivElement`
+- Type: `string`
 - Default: `-`
 
-#### previousMonthButton
+#### weekdayFormat
 
-This is the first focusable element, needed for the modal focus trap.
+Decides the format of the weekday as shown above the grid of dates in the calendar.
 
-Don't cache this and other `@query` fields from inside the calendar modal.
-They work the first time, but once the calendar is closed and reopened
-the query will point to an element that doesn't exist anymore.
+The syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).
 
-- Type: `HTMLButtonElement`
-- Default: `-`
+- Type: `string`
+- Default: `'EEEEEE'`
 
-#### todayCell
+#### weeks
 
 
 
-- Type: `HTMLTableCellElement`
+- Type: `unknown`
 - Default: `-`
 
-#### selectedCell
+#### wrapper
 
 
 
-- Type: `HTMLTableCellElement`
+- Type: `HTMLDivElement`
 - Default: `-`
 
 ### Types