@warp-ds/elements 2.10.0-next.10 → 2.10.0-next.12

package/dist/docs/textfield/textfield.md

@@ -191,28 +191,28 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 
 | Name | Type | Default | Summary |
 |-|-|-|-|
-| autocomplete | `string \| 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. |
+| 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` | `-` | Function to format value when the input field |
-| help-text | `string` | `-` | Description shown below the input field |
+| formatter (JS only) | `((value: string) => string) \| undefined` | `-` | Function to format value when the input field |
+| help-text | `string \| undefined` | `-` | 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. |
-| max | `number` | `-` | Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength). |
-| max-length | `number` | `-` | **Deprecated**: Use the native `maxlength` attribute |
-| maxlength | `number` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed. |
-| min | `number` | `-` | Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength). |
-| min-length | `number` | `-` | **Deprecated**: Use the native `minlength` attribute |
-| minlength | `number` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required. |
-| 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. |
-| pattern | `string` | `-` | 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` | `-` | Shown in the textfield when it doesn't have a value |
+| label | `string \| undefined` | `-` | Either a `label` or an `aria-label` must be provided. |
+| max | `number \| undefined` | `-` | Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength). |
+| max-length | `number \| undefined` | `-` | **Deprecated**: Use the native `maxlength` attribute |
+| maxlength | `number \| undefined` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed. |
+| min | `number \| undefined` | `-` | Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength). |
+| min-length | `number \| undefined` | `-` | **Deprecated**: Use the native `minlength` attribute |
+| minlength | `number \| undefined` | `-` | For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required. |
+| 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 |
 | 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. |
-| size | `string` | `-` | 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` | `-` | Forces `number` inputs to be a whole number of `step` |
-| type | `string` | `-` | The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types). |
-| value | `string` | `-` | Lets you set the current value. |
+| 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` |
+| 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. |
 
 ### Property Details
 
@@ -220,7 +220,7 @@ Unless otherwise noted all properties are HTML attributes (as opposed to JavaScr
 
 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.
 
-- Type: `string | undefined`
+- Type: `HTMLInputElement["autocomplete"] | undefined`
 - Default: `-`
 
 #### disabled
@@ -241,7 +241,7 @@ Function to format value when the input field.
 Only active when the input field does not have focus,
 similar to the accessible input [masking example from Filament Group](https://filamentgroup.github.io/politespace/demo/demo.html).
 
-- Type: `(value: string) => string`
+- Type: `((value: string) => string) | undefined`
 - Default: `-`
 
 #### help-text
@@ -249,7 +249,7 @@ similar to the accessible input [masking example from Filament Group](https://fi
 Use in combination with `invalid` to show as a validation error message,
 or on its own to show a help text.
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`
 
 #### invalid
@@ -263,14 +263,14 @@ Mark the form field as invalid. Make sure to also set a `help-text` to help user
 
 Either a `label` or an `aria-label` must be provided.
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`
 
 #### max
 
 Use with `type="number"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### max-length
@@ -279,21 +279,21 @@ Use with `type="number"` to set the [maximum allowed value](https://developer.mo
 
 
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### maxlength
 
 For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### min
 
 Use with `type="number"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### min-length
@@ -302,28 +302,28 @@ Use with `type="number"` to set the [minimum allowed value](https://developer.mo
 
 
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### minlength
 
 For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.
 
-- Type: `number`
+- Type: `number | undefined`
 - 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`
+- Type: `string | undefined`
 - Default: `-`
 
 #### pattern
 
 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)
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`
 
 #### placeholder
@@ -332,7 +332,7 @@ Set a text that is shown in the textfield 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`
+- Type: `string | undefined`
 - Default: `-`
 
 #### read-only
@@ -362,7 +362,7 @@ Whether user input is required on the input before form submission.
 
 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.
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`
 
 #### step
@@ -372,20 +372,20 @@ When used with `number` this attribute forces inputs to be a whole number of `st
 For example with a `step="5"` only values that divide evenly on 5 are allowed.
 Using arrow up and down in the input field increments and decrements by 5.
 
-- Type: `number`
+- Type: `number | undefined`
 - Default: `-`
 
 #### type
 
 The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`
 
 #### value
 
 Lets you set the current value.
 
-- Type: `string`
+- Type: `string | undefined`
 - Default: `-`