@warp-ds/elements 2.9.1-next.2 → 2.9.1-next.4

package/dist/docs/pagination/api.md

@@ -1,24 +1,26 @@
-## API Documentation
+## `<w-pagination>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| baseUrl | `string` | `-` | - |
-| currentPageNumber | `number` | `-` | - |
+| base-url | `string` | `-` | - |
+| current-page | `number` | `-` | - |
 | pages | `number` | `-` | - |
-| visiblePages | `number` | `-` | - |
+| visible-pages | `number` | `-` | - |
 
 ### Property Details
 
-#### baseUrl
+#### base-url
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### currentPageNumber
+#### current-page
 
 
 
@@ -32,13 +34,19 @@
 - Type: `number`
 - Default: `-`
 
-#### visiblePages
+#### visible-pages
 
 
 
 - Type: `number`
 - Default: `-`
 
-### Types
+### Events
+
+#### page-click
+
+Triggered when a link button in the pagination is clicked. Contains the page number in `string` form.
+
+- Type: `CustomEvent`
+
 
-No types documented.

package/dist/docs/pagination/pagination.md

@@ -12,27 +12,29 @@ Pagination allows users to navigate through multiple pages of content by providi
 
 ## Examples
 
-## API Documentation
+## `<w-pagination>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| baseUrl | `string` | `-` | - |
-| currentPageNumber | `number` | `-` | - |
+| base-url | `string` | `-` | - |
+| current-page | `number` | `-` | - |
 | pages | `number` | `-` | - |
-| visiblePages | `number` | `-` | - |
+| visible-pages | `number` | `-` | - |
 
 ### Property Details
 
-#### baseUrl
+#### base-url
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### currentPageNumber
+#### current-page
 
 
 
@@ -46,13 +48,19 @@ Pagination allows users to navigate through multiple pages of content by providi
 - Type: `number`
 - Default: `-`
 
-#### visiblePages
+#### visible-pages
 
 
 
 - Type: `number`
 - Default: `-`
 
-### Types
+### Events
+
+#### page-click
+
+Triggered when a link button in the pagination is clicked. Contains the page number in `string` form.
+
+- Type: `CustomEvent`
+
 
-No types documented.

package/dist/docs/pill/api.md

@@ -1,35 +1,37 @@
-## API Documentation
+## `<w-pill>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| canClose | `boolean` | `false` | - |
-| closeAriaLabel | `string` | `-` | - |
-| closeSrLabel | `string` | `-` | **Deprecated**: Used "close-arial-label" instead. |
-| openAriaLabel | `string` | `-` | - |
-| openFilterSrText | `unknown` | `-` | - |
-| openSrLabel | `string` | `-` | **Deprecated**: Used "open-arial-label" instead. |
-| removeFilterSrText | `unknown` | `-` | - |
+| can-close | `boolean` | `false` | - |
+| close-aria-label | `string` | `-` | - |
+| close-sr-label | `string` | `-` | **Deprecated**: Used "close-arial-label" instead. |
+| open-aria-label | `string` | `-` | - |
+| openFilterSrText (JS only) | `unknown` | `-` | - |
+| open-sr-label | `string` | `-` | **Deprecated**: Used "open-arial-label" instead. |
+| removeFilterSrText (JS only) | `unknown` | `-` | - |
 | suggestion | `boolean` | `false` | - |
 
 ### Property Details
 
-#### canClose
+#### can-close
 
 
 
 - Type: `boolean`
 - Default: `false`
 
-#### closeAriaLabel
+#### close-aria-label
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### closeSrLabel
+#### close-sr-label
 
 **Deprecated**: Used "close-arial-label" instead.
 
@@ -38,21 +40,21 @@
 - Type: `string`
 - Default: `-`
 
-#### openAriaLabel
+#### open-aria-label
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### openFilterSrText
+#### openFilterSrText (JS only)
 
 
 
 - Type: `unknown`
 - Default: `-`
 
-#### openSrLabel
+#### open-sr-label
 
 **Deprecated**: Used "open-arial-label" instead.
 
@@ -61,7 +63,7 @@
 - Type: `string`
 - Default: `-`
 
-#### removeFilterSrText
+#### removeFilterSrText (JS only)
 
 
 
@@ -75,6 +77,17 @@
 - Type: `boolean`
 - Default: `false`
 
-### Types
+### Events
+
+#### w-pill-click
+
+
+
+- Type: `CustomEvent`
+#### w-pill-close
+
+
+
+- Type: `CustomEvent`
+
 
-No types documented.

package/dist/docs/pill/pill.md

@@ -12,38 +12,40 @@ Pill is a type of button that is often used as a filter, but can also be used as
 
 ## Examples
 
-## API Documentation
+## `<w-pill>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| canClose | `boolean` | `false` | - |
-| closeAriaLabel | `string` | `-` | - |
-| closeSrLabel | `string` | `-` | **Deprecated**: Used "close-arial-label" instead. |
-| openAriaLabel | `string` | `-` | - |
-| openFilterSrText | `unknown` | `-` | - |
-| openSrLabel | `string` | `-` | **Deprecated**: Used "open-arial-label" instead. |
-| removeFilterSrText | `unknown` | `-` | - |
+| can-close | `boolean` | `false` | - |
+| close-aria-label | `string` | `-` | - |
+| close-sr-label | `string` | `-` | **Deprecated**: Used "close-arial-label" instead. |
+| open-aria-label | `string` | `-` | - |
+| openFilterSrText (JS only) | `unknown` | `-` | - |
+| open-sr-label | `string` | `-` | **Deprecated**: Used "open-arial-label" instead. |
+| removeFilterSrText (JS only) | `unknown` | `-` | - |
 | suggestion | `boolean` | `false` | - |
 
 ### Property Details
 
-#### canClose
+#### can-close
 
 
 
 - Type: `boolean`
 - Default: `false`
 
-#### closeAriaLabel
+#### close-aria-label
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### closeSrLabel
+#### close-sr-label
 
 **Deprecated**: Used "close-arial-label" instead.
 
@@ -52,21 +54,21 @@ Pill is a type of button that is often used as a filter, but can also be used as
 - Type: `string`
 - Default: `-`
 
-#### openAriaLabel
+#### open-aria-label
 
 
 
 - Type: `string`
 - Default: `-`
 
-#### openFilterSrText
+#### openFilterSrText (JS only)
 
 
 
 - Type: `unknown`
 - Default: `-`
 
-#### openSrLabel
+#### open-sr-label
 
 **Deprecated**: Used "open-arial-label" instead.
 
@@ -75,7 +77,7 @@ Pill is a type of button that is often used as a filter, but can also be used as
 - Type: `string`
 - Default: `-`
 
-#### removeFilterSrText
+#### removeFilterSrText (JS only)
 
 
 
@@ -89,6 +91,17 @@ Pill is a type of button that is often used as a filter, but can also be used as
 - Type: `boolean`
 - Default: `false`
 
-### Types
+### Events
+
+#### w-pill-click
+
+
+
+- Type: `CustomEvent`
+#### w-pill-close
+
+
+
+- Type: `CustomEvent`
+
 
-No types documented.

package/dist/docs/select/api.md

@@ -1,20 +1,22 @@
-## API Documentation
+## `<w-select>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
 | always | `boolean` | `false` | Whether to always show a hint.. **Deprecated**: Use `help-text` instead and only set it if you want to display the help text. |
-| autoFocus | `boolean` | `false` | Whether the element should receive focus on render.. **Deprecated**: Use the native `autofocus` attribute instead. |
+| auto-focus | `boolean` | `false` | Whether the element should receive focus on render.. **Deprecated**: Use the native `autofocus` attribute instead. |
 | autofocus | `boolean` | `false` | Whether the element should receive focus on render |
 | disabled | `boolean` | `false` | Renders the field in a disabled state. |
-| helpText | `string` | `-` | The content displayed as the help text. Paired with `invalid` to show the text as a validation error. |
+| help-text | `string` | `-` | The content displayed as the help text. Paired with `invalid` to show the text as a validation error. |
 | hint | `string` | `-` | The content displayed as the help text.. **Deprecated**: Use `help-text` instead. |
 | invalid | `boolean` | `false` | Renders the field in an invalid state. Paired with `help-text` to provide feedback about the error. |
 | label | `string` | `-` | The content to disply as the label |
 | name | `string` | `-` | - |
 | optional | `boolean` | `false` | Whether to show optional text |
-| readOnly | `boolean` | `false` | Renders the field in a readonly state.. **Deprecated**: Use the native readonly attribute instead. |
+| read-only | `boolean` | `false` | Renders the field in a readonly state.. **Deprecated**: Use the native readonly attribute instead. |
 | readonly | `boolean` | `false` | Renders the field in a readonly state. |
 | value | `string` | `-` | - |
 
@@ -29,7 +31,7 @@ Whether to always show a hint.
 - Type: `boolean`
 - Default: `false`
 
-#### autoFocus
+#### auto-focus
 
 **Deprecated**: Use the native `autofocus` attribute instead.
 
@@ -52,7 +54,7 @@ Renders the field in a disabled state.
 - Type: `boolean`
 - Default: `false`
 
-#### helpText
+#### help-text
 
 The content displayed as the help text. Paired with `invalid` to show the text as a validation error.
 
@@ -96,7 +98,7 @@ Whether to show optional text
 - Type: `boolean`
 - Default: `false`
 
-#### readOnly
+#### read-only
 
 **Deprecated**: Use the native readonly attribute instead.
 
@@ -119,6 +121,12 @@ Renders the field in a readonly state.
 - Type: `string`
 - Default: `-`
 
-### Types
+### Events
+
+#### change
+
+
+
+- Type: `CustomEvent`
+
 
-No types documented.

package/dist/docs/select/select.md

@@ -12,23 +12,25 @@ A dropdown component for selecting a single value.
 
 ## Examples
 
-## API Documentation
+## `<w-select>` API
+
+Unless otherwise noted all properties are HTML attributes (as opposed to JavaScript object properties).
 
 ### Properties
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
 | always | `boolean` | `false` | Whether to always show a hint.. **Deprecated**: Use `help-text` instead and only set it if you want to display the help text. |
-| autoFocus | `boolean` | `false` | Whether the element should receive focus on render.. **Deprecated**: Use the native `autofocus` attribute instead. |
+| auto-focus | `boolean` | `false` | Whether the element should receive focus on render.. **Deprecated**: Use the native `autofocus` attribute instead. |
 | autofocus | `boolean` | `false` | Whether the element should receive focus on render |
 | disabled | `boolean` | `false` | Renders the field in a disabled state. |
-| helpText | `string` | `-` | The content displayed as the help text. Paired with `invalid` to show the text as a validation error. |
+| help-text | `string` | `-` | The content displayed as the help text. Paired with `invalid` to show the text as a validation error. |
 | hint | `string` | `-` | The content displayed as the help text.. **Deprecated**: Use `help-text` instead. |
 | invalid | `boolean` | `false` | Renders the field in an invalid state. Paired with `help-text` to provide feedback about the error. |
 | label | `string` | `-` | The content to disply as the label |
 | name | `string` | `-` | - |
 | optional | `boolean` | `false` | Whether to show optional text |
-| readOnly | `boolean` | `false` | Renders the field in a readonly state.. **Deprecated**: Use the native readonly attribute instead. |
+| read-only | `boolean` | `false` | Renders the field in a readonly state.. **Deprecated**: Use the native readonly attribute instead. |
 | readonly | `boolean` | `false` | Renders the field in a readonly state. |
 | value | `string` | `-` | - |
 
@@ -43,7 +45,7 @@ Whether to always show a hint.
 - Type: `boolean`
 - Default: `false`
 
-#### autoFocus
+#### auto-focus
 
 **Deprecated**: Use the native `autofocus` attribute instead.
 
@@ -66,7 +68,7 @@ Renders the field in a disabled state.
 - Type: `boolean`
 - Default: `false`
 
-#### helpText
+#### help-text
 
 The content displayed as the help text. Paired with `invalid` to show the text as a validation error.
 
@@ -110,7 +112,7 @@ Whether to show optional text
 - Type: `boolean`
 - Default: `false`
 
-#### readOnly
+#### read-only
 
 **Deprecated**: Use the native readonly attribute instead.
 
@@ -133,6 +135,12 @@ Renders the field in a readonly state.
 - Type: `string`
 - Default: `-`
 
-### Types
+### Events
+
+#### change
+
+
+
+- Type: `CustomEvent`
+
 
-No types documented.