diff --git a/docs/components/button.md b/docs/components/button.md index bf0e77b633..ebb3cd58e0 100644 --- a/docs/components/button.md +++ b/docs/components/button.md @@ -704,7 +704,7 @@ Token | Default value ## API -### MdElevatedButton +### MdElevatedButton <md-elevated-button> #### Properties @@ -714,17 +714,17 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. `href` | `href` | `string` | `''` | The URL that the link button points to. -`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options
include `_blank` to open in a new tab. -`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the
inline start.

_Note:_ Link buttons cannot have trailing icons. +`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. +`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. +`form` | | `HTMLFormElement` | `undefined` | -### MdFilledButton +### MdFilledButton <md-filled-button> #### Properties @@ -734,17 +734,17 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. `href` | `href` | `string` | `''` | The URL that the link button points to. -`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options
include `_blank` to open in a new tab. -`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the
inline start.

_Note:_ Link buttons cannot have trailing icons. +`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. +`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. +`form` | | `HTMLFormElement` | `undefined` | -### MdFilledTonalButton +### MdFilledTonalButton <md-filled-tonal-button> #### Properties @@ -754,17 +754,17 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. `href` | `href` | `string` | `''` | The URL that the link button points to. -`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options
include `_blank` to open in a new tab. -`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the
inline start.

_Note:_ Link buttons cannot have trailing icons. +`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. +`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. +`form` | | `HTMLFormElement` | `undefined` | -### MdOutlinedButton +### MdOutlinedButton <md-outlined-button> #### Properties @@ -774,17 +774,17 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. `href` | `href` | `string` | `''` | The URL that the link button points to. -`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options
include `_blank` to open in a new tab. -`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the
inline start.

_Note:_ Link buttons cannot have trailing icons. +`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. +`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. +`form` | | `HTMLFormElement` | `undefined` | -### MdTextButton +### MdTextButton <md-text-button> #### Properties @@ -794,13 +794,13 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. `href` | `href` | `string` | `''` | The URL that the link button points to. -`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options
include `_blank` to open in a new tab. -`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the
inline start.

_Note:_ Link buttons cannot have trailing icons. +`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. +`trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. +`form` | | `HTMLFormElement` | `undefined` | diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md index 4e30ebde6b..4544b6e4a5 100644 --- a/docs/components/checkbox.md +++ b/docs/components/checkbox.md @@ -165,7 +165,7 @@ Token | Default value ## API -### MdCheckbox +### MdCheckbox <md-checkbox> #### Properties @@ -175,15 +175,15 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `checked` | `checked` | `boolean` | `false` | Whether or not the checkbox is selected. `disabled` | `disabled` | `boolean` | `false` | Whether or not the checkbox is disabled. -`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not the checkbox is indeterminate.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes -`required` | `required` | `boolean` | `false` | When true, require the checkbox to be selected when participating in
form submission.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation -`value` | `value` | `string` | `'on'` | The value of the checkbox that is submitted with a form when selected.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#value -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. -`validity` | | `ValidityState` | `undefined` | Returns a ValidityState object that represents the validity states of the
checkbox.

Note that checkboxes will only set `valueMissing` if `required` and not
checked.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation -`validationMessage` | | `string` | `undefined` | Returns the native validation error message.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation#constraint_validation_process -`willValidate` | | `boolean` | `undefined` | Returns whether an element will successfully validate based on forms
validation rules and constraints.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation#constraint_validation_process +`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not the checkbox is indeterminate.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes +`required` | `required` | `boolean` | `false` | When true, require the checkbox to be selected when participating in form submission.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation +`value` | `value` | `string` | `'on'` | The value of the checkbox that is submitted with a form when selected.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#value +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | +`validity` | | `ValidityState` | `undefined` | +`validationMessage` | | `string` | `undefined` | +`willValidate` | | `boolean` | `undefined` | @@ -193,9 +193,9 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`checkValidity` | _None_ | `boolean` | Checks the checkbox's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity -`reportValidity` | _None_ | `boolean` | Checks the checkbox's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

The `validationMessage` is reported to the user by the browser. Use
`setCustomValidity()` to customize the `validationMessage`.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity -`setCustomValidity` | `error` | `void` | Sets the checkbox's native validation error message. This is used to
customize `validationMessage`.

When the error is not an empty string, the checkbox is considered invalid
and `validity.customError` will be true.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity +`checkValidity` | _None_ | `boolean` | Checks the checkbox's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity +`reportValidity` | _None_ | `boolean` | Checks the checkbox's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
The `validationMessage` is reported to the user by the browser. Use `setCustomValidity()` to customize the `validationMessage`.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity +`setCustomValidity` | `error` | `void` | Sets the checkbox's native validation error message. This is used to customize `validationMessage`.
When the error is not an empty string, the checkbox is considered invalid and `validity.customError` will be true.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity diff --git a/docs/components/chip.md b/docs/components/chip.md index 631c56dd06..618167dce0 100644 --- a/docs/components/chip.md +++ b/docs/components/chip.md @@ -486,7 +486,7 @@ Token | Default value ## API -### MdChipSet +### MdChipSet <md-chip-set> #### Properties @@ -498,7 +498,7 @@ Property | Attribute | Type | Default | Description -### MdAssistChip +### MdAssistChip <md-assist-chip> #### Properties @@ -509,13 +509,13 @@ Property | Attribute | Type | Default | Description `elevated` | `elevated` | `boolean` | `false` | `href` | `href` | `string` | `''` | `target` | `target` | `string` | `''` | -`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.

Disabled chips are not focusable, unless `always-focusable` is set. -`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.

Add this when a chip needs increased visibility when disabled. See
https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls
for more guidance on when this is needed. +`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.
Disabled chips are not focusable, unless `always-focusable` is set. +`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed. `label` | `label` | `string` | `''` | The label of the chip. -### MdFilterChip +### MdFilterChip <md-filter-chip> #### Properties @@ -526,15 +526,15 @@ Property | Attribute | Type | Default | Description `elevated` | `elevated` | `boolean` | `false` | `removable` | `removable` | `boolean` | `false` | `selected` | `selected` | `boolean` | `false` | -`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.

Disabled chips are not focusable, unless `always-focusable` is set. -`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.

Add this when a chip needs increased visibility when disabled. See
https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls
for more guidance on when this is needed. +`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.
Disabled chips are not focusable, unless `always-focusable` is set. +`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed. `label` | `label` | `string` | `''` | The label of the chip. `handleTrailingActionFocus` | | `() => void` | `undefined` | `ariaLabelRemove` | | `string` | `undefined` | -### MdInputChip +### MdInputChip <md-input-chip> #### Properties @@ -547,15 +547,15 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | `removeOnly` | `remove-only` | `boolean` | `false` | `selected` | `selected` | `boolean` | `false` | -`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.

Disabled chips are not focusable, unless `always-focusable` is set. -`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.

Add this when a chip needs increased visibility when disabled. See
https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls
for more guidance on when this is needed. +`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.
Disabled chips are not focusable, unless `always-focusable` is set. +`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed. `label` | `label` | `string` | `''` | The label of the chip. `handleTrailingActionFocus` | | `() => void` | `undefined` | `ariaLabelRemove` | | `string` | `undefined` | -### MdSuggestionChip +### MdSuggestionChip <md-suggestion-chip> #### Properties @@ -566,8 +566,8 @@ Property | Attribute | Type | Default | Description `elevated` | `elevated` | `boolean` | `false` | `href` | `href` | `string` | `''` | `target` | `target` | `string` | `''` | -`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.

Disabled chips are not focusable, unless `always-focusable` is set. -`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.

Add this when a chip needs increased visibility when disabled. See
https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls
for more guidance on when this is needed. +`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.
Disabled chips are not focusable, unless `always-focusable` is set. +`alwaysFocusable` | `always-focusable` | `boolean` | `false` | When true, allow disabled chips to be focused with arrow keys.
Add this when a chip needs increased visibility when disabled. See https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls for more guidance on when this is needed. `label` | `label` | `string` | `''` | The label of the chip. diff --git a/docs/components/dialog.md b/docs/components/dialog.md index 5c47dfdc18..3fd252eadf 100644 --- a/docs/components/dialog.md +++ b/docs/components/dialog.md @@ -244,7 +244,7 @@ Token | Default value ## API -### MdDialog +### MdDialog <md-dialog> #### Properties @@ -252,11 +252,11 @@ Token | Default value Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- -`returnValue` | | `string` | `''` | Gets or sets the dialog's return value, usually to indicate which button
a user pressed to close it.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/returnValue -`type` | `type` | `string` | `undefined` | The type of dialog for accessibility. Set this to `alert` to announce a
dialog as an alert dialog. -`open` | `open` | `boolean` | `undefined` | Opens the dialog when set to `true` and closes it when set to `false`. -`getOpenAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the opening animation for a dialog. Set to a new function to customize
the animation. -`getCloseAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the closing animation for a dialog. Set to a new function to customize
the animation. +`returnValue` | | `string` | `''` | Gets or sets the dialog's return value, usually to indicate which button a user pressed to close it.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/returnValue +`type` | `type` | `string` | `undefined` | The type of dialog for accessibility. Set this to `alert` to announce a dialog as an alert dialog. +`open` | `open` | `boolean` | `undefined` | +`getOpenAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the opening animation for a dialog. Set to a new function to customize the animation. +`getCloseAnimation` | | `() => DialogAnimation` | `function { ... }` | Gets the closing animation for a dialog. Set to a new function to customize the animation. @@ -266,8 +266,8 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`show` | _None_ | `Promise` | Opens the dialog and fires a cancelable `open` event. After a dialog's
animation, an `opened` event is fired.

Add an `autocomplete` attribute to a child of the dialog that should
receive focus after opening. -`close` | `returnValue` | `Promise` | Closes the dialog and fires a cancelable `close` event. After a dialog's
animation, a `closed` event is fired. +`show` | _None_ | `Promise` | Opens the dialog and fires a cancelable `open` event. After a dialog's animation, an `opened` event is fired.
Add an `autocomplete` attribute to a child of the dialog that should receive focus after opening. +`close` | `returnValue` | `Promise` | Closes the dialog and fires a cancelable `close` event. After a dialog's animation, a `closed` event is fired. @@ -275,13 +275,13 @@ Method | Parameters | Returns | Description -Event | Type | Description ---- | --- | --- -`open` | `undefined` | Dispatched when the dialog is opening before any animations. -`opened` | `undefined` | Dispatched when the dialog has opened after any animations. -`close` | `undefined` | Dispatched when the dialog is closing before any animations. -`closed` | `undefined` | Dispatched when the dialog has closed after any animations. -`cancel` | `undefined` | Dispatched when the dialog has been canceled by clicking on the
scrim or pressing Escape. +Event | Description +--- | --- +`open` | Dispatched when the dialog is opening before any animations. +`opened` | Dispatched when the dialog has opened after any animations. +`close` | Dispatched when the dialog is closing before any animations. +`closed` | Dispatched when the dialog has closed after any animations. +`cancel` | Dispatched when the dialog has been canceled by clicking on the scrim or pressing Escape. diff --git a/docs/components/divider.md b/docs/components/divider.md index 147a889c84..a35c4524f4 100644 --- a/docs/components/divider.md +++ b/docs/components/divider.md @@ -123,7 +123,7 @@ Token | Default value ## API -### MdDivider +### MdDivider <md-divider> #### Properties diff --git a/docs/components/fab.md b/docs/components/fab.md index 1ea5c25063..0843d2ffa7 100644 --- a/docs/components/fab.md +++ b/docs/components/fab.md @@ -478,7 +478,7 @@ Add with a different theme applied](images/fab/theming-branded.webp) ## API -### MdFab +### MdFab <md-fab> #### Properties @@ -487,7 +487,7 @@ Add with a different theme applied](images/fab/theming-branded.webp) Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `variant` | `variant` | `string` | `'surface'` | The FAB color variant to render. -`size` | `size` | `string` | `'medium'` | The size of the FAB.

NOTE: Branded FABs cannot be sized to `small`, and Extended FABs do not
have different sizes. +`size` | `size` | `string` | `'medium'` | The size of the FAB.
NOTE: Branded FABs cannot be sized to `small`, and Extended FABs do not have different sizes. `label` | `label` | `string` | `''` | The text to display on the FAB. `lowered` | `lowered` | `boolean` | `false` | Lowers the FAB's elevation. @@ -503,7 +503,7 @@ Method | Parameters | Returns | Description -### MdBrandedFab +### MdBrandedFab <md-branded-fab> #### Properties @@ -512,10 +512,9 @@ Method | Parameters | Returns | Description Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `variant` | `variant` | `string` | `'surface'` | The FAB color variant to render. -`size` | `size` | `string` | `'medium'` | The size of the FAB.

NOTE: Branded FABs cannot be sized to `small`, and Extended FABs do not
have different sizes. +`size` | `size` | `string` | `'medium'` | The size of the FAB.
NOTE: Branded FABs cannot be sized to `small`, and Extended FABs do not have different sizes. `label` | `label` | `string` | `''` | The text to display on the FAB. `lowered` | `lowered` | `boolean` | `false` | Lowers the FAB's elevation. -`variant` | | `string` | `undefined` | Branded FABs have no variants @@ -526,7 +525,6 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- `getRenderClasses` | _None_ | `{ primary: boolean; secondary: boolean; tertiary: boolean; small: boolean; lowered: boolean; large: boolean; extended: boolean; }` | -`getRenderClasses` | _None_ | `{ primary: boolean; secondary: boolean; tertiary: boolean; lowered: boolean; small: boolean; large: boolean; extended: boolean; }` | diff --git a/docs/components/focus-ring.md b/docs/components/focus-ring.md index 7f502424ed..b7c0a95fa3 100644 --- a/docs/components/focus-ring.md +++ b/docs/components/focus-ring.md @@ -136,7 +136,7 @@ md-focus-ring { ## API -### MdFocusRing +### MdFocusRing <md-focus-ring> #### Properties diff --git a/docs/components/icon-button.md b/docs/components/icon-button.md index 055ceabec6..0b1bdc7356 100644 --- a/docs/components/icon-button.md +++ b/docs/components/icon-button.md @@ -430,7 +430,7 @@ Token | Default value ## API -### MdIconButton +### MdIconButton <md-icon-button> #### Properties @@ -443,17 +443,17 @@ Property | Attribute | Type | Default | Description `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. `target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute. `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. -`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected
states -`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true,
displays the selected icon, or the default icon If no `slot="selected"`
icon is provided. +`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states +`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | -### MdFilledIconButton +### MdFilledIconButton <md-filled-icon-button> #### Properties @@ -466,17 +466,17 @@ Property | Attribute | Type | Default | Description `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. `target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute. `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. -`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected
states -`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true,
displays the selected icon, or the default icon If no `slot="selected"`
icon is provided. +`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states +`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | -### MdFilledTonalIconButton +### MdFilledTonalIconButton <md-filled-tonal-icon-button> #### Properties @@ -489,17 +489,17 @@ Property | Attribute | Type | Default | Description `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. `target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute. `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. -`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected
states -`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true,
displays the selected icon, or the default icon If no `slot="selected"`
icon is provided. +`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states +`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | -### MdOutlinedIconButton +### MdOutlinedIconButton <md-outlined-icon-button> #### Properties @@ -512,13 +512,13 @@ Property | Attribute | Type | Default | Description `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. `target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute. `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. -`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected
states -`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true,
displays the selected icon, or the default icon If no `slot="selected"`
icon is provided. +`toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states +`selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. `type` | `type` | `string` | `'submit'` | `value` | `value` | `string` | `''` | `name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | diff --git a/docs/components/list.md b/docs/components/list.md index 165c74588f..d03403d5e8 100644 --- a/docs/components/list.md +++ b/docs/components/list.md @@ -548,7 +548,7 @@ Token | Default value ## API -### MdList +### MdList <md-list> #### Properties @@ -556,7 +556,7 @@ Token | Default value Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- -`items` | | `ListItem[]` | `undefined` | An array of activatable and disableable list items. Queries every assigned
element that has the `md-list-item` attribute.

_NOTE:_ This is a shallow, flattened query via
`HTMLSlotElement.queryAssignedElements` and thus will _only_ include direct
children / directly slotted elements. +`items` | | `ListItem[]` | `undefined` | An array of activatable and disableable list items. Queries every assigned element that has the `md-list-item` attribute.
_NOTE:_ This is a shallow, flattened query via `HTMLSlotElement.queryAssignedElements` and thus will _only_ include direct children / directly slotted elements. @@ -566,12 +566,12 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`activateNextItem` | _None_ | `ListItem` | Activates the next item in the list. If at the end of the list, the first
item will be activated. -`activatePreviousItem` | _None_ | `ListItem` | Activates the previous item in the list. If at the start of the list, the
last item will be activated. +`activateNextItem` | _None_ | `ListItem` | Activates the next item in the list. If at the end of the list, the first item will be activated. +`activatePreviousItem` | _None_ | `ListItem` | Activates the previous item in the list. If at the start of the list, the last item will be activated. -### MdListItem +### MdListItem <md-list-item> #### Properties @@ -579,16 +579,15 @@ Method | Parameters | Returns | Description Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- -`noninteractive` | `noninteractive` | `boolean` | `false` | Removes the hover and click ripples from the item when true. +`interactive` | `interactive` | `boolean` | `false` | Enables focusing the list item, and adds hover and click ripples when set to true. By default `interactive` is false. `headline` | `headline` | `string` | `''` | The primary, headline text of the list item. -`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set
`multiLineSupportingText` to `true` to support multiple lines in the
supporting text. +`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set `multiLineSupportingText` to `true` to support multiple lines in the supporting text. `multiLineSupportingText` | `multi-line-supporting-text` | `boolean` | `false` | Modifies `supportingText` to support multiple lines. -`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements
slotted into the `end` slot. +`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements slotted into the `end` slot. `disabled` | `disabled` | `boolean` | `false` | Disables the item and makes it non-selectable and non-interactive. -`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This
property will be ignored if `href` is set since the underlying element will
be a native anchor tag. +`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This property will be ignored if `href` is set since the underlying element will be a native anchor tag. `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. -`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is
set. -`tabIndex` | `tabindex` | `number` | `0` | +`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is set. @@ -598,7 +597,7 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`getRenderClasses` | _None_ | `{ noninteractive: boolean; 'with-one-line': boolean; 'with-two-line': boolean; 'with-three-line': boolean; disabled: boolean; }` | +`getRenderClasses` | _None_ | `{ interactive: boolean; 'with-one-line': boolean; 'with-two-line': boolean; 'with-three-line': boolean; disabled: boolean; }` | `renderRipple` | _None_ | `unique symbol \| TemplateResult` | `renderFocusRing` | _None_ | `unique symbol \| TemplateResult` | `onFocus` | _None_ | `void` | diff --git a/docs/components/menu.md b/docs/components/menu.md index 0433fcbe55..1f2484f4cd 100644 --- a/docs/components/menu.md +++ b/docs/components/menu.md @@ -352,7 +352,7 @@ a sharp 0px border radius.](images/menu/theming.webp) ## API -### MdMenu +### MdMenu <md-menu> #### Properties @@ -360,25 +360,25 @@ a sharp 0px border radius.](images/menu/theming.webp) Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- -`anchor` | `anchor` | `string` | `''` | The ID of the element in the same root node in which the menu should align
to. Overrides setting `anchorElement = elementReference`.

__NOTE__: anchor or anchorElement must either be an HTMLElement or resolve
to an HTMLElement in order for menu to open. -`fixed` | `fixed` | `boolean` | `false` | Makes the element use `position:fixed` instead of `position:absolute`. In
most cases, the menu should position itself above most other
`position:absolute` or `position:fixed` elements when placed inside of
them. e.g. using a menu inside of an `md-dialog`.

__NOTE__: Fixed menus will not scroll with the page and will be fixed to
the window instead. +`anchor` | `anchor` | `string` | `''` | The ID of the element in the same root node in which the menu should align to. Overrides setting `anchorElement = elementReference`.
__NOTE__: anchor or anchorElement must either be an HTMLElement or resolve to an HTMLElement in order for menu to open. +`fixed` | `fixed` | `boolean` | `false` | Makes the element use `position:fixed` instead of `position:absolute`. In most cases, the menu should position itself above most other `position:absolute` or `position:fixed` elements when placed inside of them. e.g. using a menu inside of an `md-dialog`.
__NOTE__: Fixed menus will not scroll with the page and will be fixed to the window instead. `quick` | `quick` | `boolean` | `false` | Skips the opening and closing animations. -`hasOverflow` | `has-overflow` | `boolean` | `false` | Displays overflow content like a submenu.

__NOTE__: This may cause adverse effects if you set
`md-menu {max-height:...}`
and have items overflowing items in the "y" direction. -`open` | `open` | `boolean` | `false` | Opens the menu and makes it visible. Alternative to the `.show()` and
`.close()` methods -`xOffset` | `x-offset` | `number` | `0` | Offsets the menu's inline alignment from the anchor by the given number in
pixels. This value is direction aware and will follow the LTR / RTL
direction.

e.g. LTR: positive -> right, negative -> left
RTL: positive -> left, negative -> right -`yOffset` | `y-offset` | `number` | `0` | Offsets the menu's block alignment from the anchor by the given number in
pixels.

e.g. positive -> down, negative -> up +`hasOverflow` | `has-overflow` | `boolean` | `false` | Displays overflow content like a submenu.
__NOTE__: This may cause adverse effects if you set `md-menu {max-height:...}` and have items overflowing items in the "y" direction. +`open` | `open` | `boolean` | `false` | Opens the menu and makes it visible. Alternative to the `.show()` and `.close()` methods +`xOffset` | `x-offset` | `number` | `0` | Offsets the menu's inline alignment from the anchor by the given number in pixels. This value is direction aware and will follow the LTR / RTL direction.
e.g. LTR: positive -> right, negative -> left RTL: positive -> left, negative -> right +`yOffset` | `y-offset` | `number` | `0` | Offsets the menu's block alignment from the anchor by the given number in pixels.
e.g. positive -> down, negative -> up `listTabIndex` | `list-tabindex` | `number` | `-1` | The tabindex of the underlying list element. `type` | `type` | `string` | `'menu'` | The role of the underlying list element. -`typeaheadDelay` | `typeahead-delay` | `number` | `200` | The max time between the keystrokes of the typeahead menu behavior before
it clears the typeahead buffer. -`anchorCorner` | `anchor-corner` | `string` | `Corner.END_START` | The corner of the anchor which to align the menu in the standard logical
property style of - e.g. `'end-start'`.

NOTE: This value may not be respected by the menu positioning algorithm
if the menu would render outisde the viewport. -`menuCorner` | `menu-corner` | `string` | `Corner.START_START` | The corner of the menu which to align the anchor in the standard logical
property style of - e.g. `'start-start'`.

NOTE: This value may not be respected by the menu positioning algorithm
if the menu would render outisde the viewport. -`stayOpenOnOutsideClick` | `stay-open-on-outside-click` | `boolean` | `false` | Keeps the user clicks outside the menu.

NOTE: clicking outside may still cause focusout to close the menu so see
`stayOpenOnFocusout`. -`stayOpenOnFocusout` | `stay-open-on-focusout` | `boolean` | `false` | Keeps the menu open when focus leaves the menu's composed subtree.

NOTE: Focusout behavior will stop propagation of the focusout event. Set
this property to true to opt-out of menu's focuout handling altogether. -`skipRestoreFocus` | `skip-restore-focus` | `boolean` | `false` | After closing, does not restore focus to the last focused element before
the menu was opened. -`defaultFocus` | `default-focus` | `string` | `FocusState.FIRST_ITEM` | The element that should be focused by default once opened.

NOTE: When setting default focus to 'LIST_ROOT', remember to change
`list-tabindex` to `0` when necessary. +`typeaheadDelay` | `typeahead-delay` | `number` | `200` | The max time between the keystrokes of the typeahead menu behavior before it clears the typeahead buffer. +`anchorCorner` | `anchor-corner` | `string` | `Corner.END_START` | The corner of the anchor which to align the menu in the standard logical property style of - e.g. `'end-start'`.
NOTE: This value may not be respected by the menu positioning algorithm if the menu would render outisde the viewport. +`menuCorner` | `menu-corner` | `string` | `Corner.START_START` | The corner of the menu which to align the anchor in the standard logical property style of - e.g. `'start-start'`.
NOTE: This value may not be respected by the menu positioning algorithm if the menu would render outisde the viewport. +`stayOpenOnOutsideClick` | `stay-open-on-outside-click` | `boolean` | `false` | Keeps the user clicks outside the menu.
NOTE: clicking outside may still cause focusout to close the menu so see `stayOpenOnFocusout`. +`stayOpenOnFocusout` | `stay-open-on-focusout` | `boolean` | `false` | Keeps the menu open when focus leaves the menu's composed subtree.
NOTE: Focusout behavior will stop propagation of the focusout event. Set this property to true to opt-out of menu's focuout handling altogether. +`skipRestoreFocus` | `skip-restore-focus` | `boolean` | `false` | After closing, does not restore focus to the last focused element before the menu was opened. +`defaultFocus` | `default-focus` | `string` | `FocusState.FIRST_ITEM` | The element that should be focused by default once opened.
NOTE: When setting default focus to 'LIST_ROOT', remember to change `list-tabindex` to `0` when necessary. `typeaheadController` | | `TypeaheadController` | `function { ... }` | Handles typeahead navigation through the menu. -`anchorElement` | | `HTMLElement & Partial` | `undefined` | The element which the menu should align to. If `anchor` is set to a
non-empty idref string, then `anchorEl` will resolve to the element with
the given id in the same root node. Otherwise, `null`. -`items` | | `MenuItem[]` | `undefined` | The menu items associated with this menu. The items must be `MenuItem`s and
have both the `md-menu-item` and `md-list-item` attributes. +`anchorElement` | | `HTMLElement & Partial` | `undefined` | +`items` | | `MenuItem[]` | `undefined` | @@ -390,8 +390,8 @@ Method | Parameters | Returns | Description --- | --- | --- | --- `close` | _None_ | `void` | `show` | _None_ | `void` | -`activateNextItem` | _None_ | `MenuItem` | Activates the next item in the menu. If at the end of the menu, the first
item will be activated. -`activatePreviousItem` | _None_ | `MenuItem` | Activates the previous item in the menu. If at the start of the menu, the
last item will be activated. +`activateNextItem` | _None_ | `MenuItem` | Activates the next item in the menu. If at the end of the menu, the first item will be activated. +`activatePreviousItem` | _None_ | `MenuItem` | Activates the previous item in the menu. If at the start of the menu, the last item will be activated. @@ -399,16 +399,16 @@ Method | Parameters | Returns | Description -Event | Type | Description ---- | --- | --- -`opening` | `undefined` | Fired before the opening animation begins -`opened` | `undefined` | Fired once the menu is open, after any animations -`closing` | `undefined` | Fired before the closing animation begins -`closed` | `undefined` | Fired once the menu is closed, after any animations +Event | Description +--- | --- +`opening` | Fired before the opening animation begins +`opened` | Fired once the menu is open, after any animations +`closing` | Fired before the closing animation begins +`closed` | Fired once the menu is closed, after any animations -### MdMenuItem +### MdMenuItem <md-menu-item> #### Properties @@ -418,15 +418,13 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `keepOpen` | `keep-open` | `boolean` | `false` | Keeps the menu open if clicked or keyboard selected. `headline` | `headline` | `string` | `''` | The primary, headline text of the list item. -`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set
`multiLineSupportingText` to `true` to support multiple lines in the
supporting text. +`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set `multiLineSupportingText` to `true` to support multiple lines in the supporting text. `multiLineSupportingText` | `multi-line-supporting-text` | `boolean` | `false` | Modifies `supportingText` to support multiple lines. -`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements
slotted into the `end` slot. +`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements slotted into the `end` slot. `disabled` | `disabled` | `boolean` | `false` | Disables the item and makes it non-selectable and non-interactive. -`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This
property will be ignored if `href` is set since the underlying element will
be a native anchor tag. +`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This property will be ignored if `href` is set since the underlying element will be a native anchor tag. `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. -`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is
set. -`tabIndex` | `tabindex` | `number` | `0` | -`type` | | `string` | `'menuitem'` | +`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is set. @@ -434,13 +432,13 @@ Property | Attribute | Type | Default | Description -Event | Type | Description ---- | --- | --- -`close-menu` | `CloseMenuEvent` | +Event | Description +--- | --- +`close-menu` | -### MdSubMenuItem +### MdSubMenuItem <md-sub-menu-item> #### Properties @@ -455,15 +453,13 @@ Property | Attribute | Type | Default | Description `selected` | `selected` | `boolean` | `false` | Sets the item in the selected visual state when a submenu is opened. `keepOpen` | `keep-open` | `boolean` | `false` | Keeps the menu open if clicked or keyboard selected. `headline` | `headline` | `string` | `''` | The primary, headline text of the list item. -`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set
`multiLineSupportingText` to `true` to support multiple lines in the
supporting text. +`supportingText` | `supporting-text` | `string` | `''` | The one-line supporting text below the headline. Set `multiLineSupportingText` to `true` to support multiple lines in the supporting text. `multiLineSupportingText` | `multi-line-supporting-text` | `boolean` | `false` | Modifies `supportingText` to support multiple lines. -`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements
slotted into the `end` slot. +`trailingSupportingText` | `trailing-supporting-text` | `string` | `''` | The supporting text placed at the end of the item. Overridden by elements slotted into the `end` slot. `disabled` | `disabled` | `boolean` | `false` | Disables the item and makes it non-selectable and non-interactive. -`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This
property will be ignored if `href` is set since the underlying element will
be a native anchor tag. +`type` | `type` | `string` | `'listitem'` | Sets the role of the list item. Set to 'nothing' to clear the role. This property will be ignored if `href` is set since the underlying element will be a native anchor tag. `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. -`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is
set. -`tabIndex` | `tabindex` | `number` | `0` | -`type` | | `string` | `'menuitem'` | +`target` | `target` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `target` attribute when `href` is set. @@ -482,13 +478,13 @@ Method | Parameters | Returns | Description -Event | Type | Description ---- | --- | --- -`deactivate-items` | `undefined` | Requests the parent menu to deselect other items when
a submenu opens -`request-activation` | `undefined` | Requests the parent make the element focusable and
focuses the item. -`deactivate-typeahead` | `undefined` | Requests the parent menu to deactivate the
typeahead functionality when a submenu opens -`activate-typeahead` | `undefined` | Requests the parent menu to activate the typeahead
functionality when a submenu closes -`close-menu` | `CloseMenuEvent` | +Event | Description +--- | --- +`deactivate-items` | Requests the parent menu to deselect other items when a submenu opens +`request-activation` | Requests the parent make the element focusable and focuses the item. +`deactivate-typeahead` | Requests the parent menu to deactivate the typeahead functionality when a submenu opens +`activate-typeahead` | Requests the parent menu to activate the typeahead functionality when a submenu closes +`close-menu` | diff --git a/docs/components/progress.md b/docs/components/progress.md index 30e0f77485..129ee26d44 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -380,7 +380,7 @@ Token | Default value ## API -### MdLinearProgress +### MdLinearProgress <md-linear-progress> #### Properties @@ -391,12 +391,12 @@ Property | Attribute | Type | Default | Description `buffer` | `buffer` | `number` | `1` | Buffer amount to display, a fraction between 0 and 1. `value` | `value` | `number` | `0` | Progress to display, a fraction between 0 and `max`. `max` | `max` | `number` | `1` | Maximum progress to display, defaults to 1. -`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not to display indeterminate progress, which gives no indication
to how long an activity will take. +`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not to display indeterminate progress, which gives no indication to how long an activity will take. `fourColor` | `four-color` | `boolean` | `false` | Whether or not to render indeterminate mode using 4 colors instead of one. -### MdCircularProgress +### MdCircularProgress <md-circular-progress> #### Properties @@ -406,7 +406,7 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `value` | `value` | `number` | `0` | Progress to display, a fraction between 0 and `max`. `max` | `max` | `number` | `1` | Maximum progress to display, defaults to 1. -`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not to display indeterminate progress, which gives no indication
to how long an activity will take. +`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not to display indeterminate progress, which gives no indication to how long an activity will take. `fourColor` | `four-color` | `boolean` | `false` | Whether or not to render indeterminate mode using 4 colors instead of one. diff --git a/docs/components/radio.md b/docs/components/radio.md index 637fc7a201..7ac5704091 100644 --- a/docs/components/radio.md +++ b/docs/components/radio.md @@ -211,7 +211,7 @@ Token | Default value ## API -### MdRadio +### MdRadio <md-radio> #### Properties @@ -221,10 +221,10 @@ Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Whether or not the radio is disabled. `value` | `value` | `string` | `'on'` | The element value to use in form submission when checked. -`checked` | `checked` | `boolean` | `undefined` | Whether or not the radio is selected. -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`checked` | `checked` | `boolean` | `undefined` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | diff --git a/docs/components/ripple.md b/docs/components/ripple.md index c82c525e7f..7419656548 100644 --- a/docs/components/ripple.md +++ b/docs/components/ripple.md @@ -266,7 +266,7 @@ Token | Default value ## API -### MdRipple +### MdRipple <md-ripple> #### Properties diff --git a/docs/components/slider.md b/docs/components/slider.md index 866d6d22e3..67a55709ee 100644 --- a/docs/components/slider.md +++ b/docs/components/slider.md @@ -161,7 +161,7 @@ Token | Default value ## API -### MdSlider +### MdSlider <md-slider> #### Properties @@ -175,22 +175,22 @@ Property | Attribute | Type | Default | Description `value` | `value` | `number` | `undefined` | The slider value displayed when range is false. `valueStart` | `value-start` | `number` | `undefined` | The slider start value displayed when range is true. `valueEnd` | `value-end` | `number` | `undefined` | The slider end value displayed when range is true. -`valueLabel` | `value-label` | `string` | `''` | An optional label for the slider's value displayed when range is
false; if not set, the label is the value itself. -`valueLabelStart` | `value-label-start` | `string` | `''` | An optional label for the slider's start value displayed when
range is true; if not set, the label is the valueStart itself. -`valueLabelEnd` | `value-label-end` | `string` | `''` | An optional label for the slider's end value displayed when
range is true; if not set, the label is the valueEnd itself. -`ariaLabelStart` | `aria-label-start` | `string` | `''` | Aria label for the slider's start handle displayed when
range is true. -`ariaValueTextStart` | `aria-valuetext-start` | `string` | `''` | Aria value text for the slider's start value displayed when
range is true. -`ariaLabelEnd` | `aria-label-end` | `string` | `''` | Aria label for the slider's end handle displayed when
range is true. -`ariaValueTextEnd` | `aria-valuetext-end` | `string` | `''` | Aria value text for the slider's end value displayed when
range is true. +`valueLabel` | `value-label` | `string` | `''` | An optional label for the slider's value displayed when range is false; if not set, the label is the value itself. +`valueLabelStart` | `value-label-start` | `string` | `''` | An optional label for the slider's start value displayed when range is true; if not set, the label is the valueStart itself. +`valueLabelEnd` | `value-label-end` | `string` | `''` | An optional label for the slider's end value displayed when range is true; if not set, the label is the valueEnd itself. +`ariaLabelStart` | `aria-label-start` | `string` | `''` | Aria label for the slider's start handle displayed when range is true. +`ariaValueTextStart` | `aria-valuetext-start` | `string` | `''` | Aria value text for the slider's start value displayed when range is true. +`ariaLabelEnd` | `aria-label-end` | `string` | `''` | Aria label for the slider's end handle displayed when range is true. +`ariaValueTextEnd` | `aria-valuetext-end` | `string` | `''` | Aria value text for the slider's end value displayed when range is true. `step` | `step` | `number` | `1` | The step between values. `ticks` | `ticks` | `boolean` | `false` | Whether or not to show tick marks. `labeled` | `labeled` | `boolean` | `false` | Whether or not to show a value label when activated. -`range` | `range` | `boolean` | `false` | Whether or not to show a value range. When false, the slider displays
a slideable handle for the value property; when true, it displays
slideable handles for the valueStart and valueEnd properties. -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`nameStart` | | `string` | `undefined` | The HTML name to use in form submission for a range slider's starting
value. Use `name` instead if both the start and end values should use the
same name. -`nameEnd` | | `string` | `undefined` | The HTML name to use in form submission for a range slider's ending value.
Use `name` instead if both the start and end values should use the same
name. -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. +`range` | `range` | `boolean` | `false` | Whether or not to show a value range. When false, the slider displays a slideable handle for the value property; when true, it displays slideable handles for the valueStart and valueEnd properties. +`name` | | `string` | `undefined` | +`nameStart` | | `string` | `undefined` | +`nameEnd` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | diff --git a/docs/components/switch.md b/docs/components/switch.md index 1526281d62..b0ff77ce4f 100644 --- a/docs/components/switch.md +++ b/docs/components/switch.md @@ -233,7 +233,7 @@ Token | Default value ## API -### MdSwitch +### MdSwitch <md-switch> #### Properties @@ -242,17 +242,17 @@ Token | Default value Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | Disables the switch and makes it non-interactive. -`selected` | `selected` | `boolean` | `false` | Puts the switch in the selected state and sets the form submission value to
the `value` property. +`selected` | `selected` | `boolean` | `false` | Puts the switch in the selected state and sets the form submission value to the `value` property. `icons` | `icons` | `boolean` | `false` | Shows both the selected and deselected icons. -`showOnlySelectedIcon` | `show-only-selected-icon` | `boolean` | `false` | Shows only the selected icon, and not the deselected icon. If `true`,
overrides the behavior of the `icons` property. -`required` | `required` | `boolean` | `false` | When true, require the switch to be selected when participating in
form submission.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation -`value` | `value` | `string` | `'on'` | The value associated with this switch on form submission. `null` is
submitted when `selected` is `false`. -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. -`validity` | | `ValidityState` | `undefined` | Returns a ValidityState object that represents the validity states of the
switch.

Note that switches will only set `valueMissing` if `required` and not
selected.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation -`validationMessage` | | `string` | `undefined` | Returns the native validation error message.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation#constraint_validation_process -`willValidate` | | `boolean` | `undefined` | Returns whether an element will successfully validate based on forms
validation rules and constraints.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation#constraint_validation_process +`showOnlySelectedIcon` | `show-only-selected-icon` | `boolean` | `false` | Shows only the selected icon, and not the deselected icon. If `true`, overrides the behavior of the `icons` property. +`required` | `required` | `boolean` | `false` | When true, require the switch to be selected when participating in form submission.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation +`value` | `value` | `string` | `'on'` | The value associated with this switch on form submission. `null` is submitted when `selected` is `false`. +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | +`validity` | | `ValidityState` | `undefined` | +`validationMessage` | | `string` | `undefined` | +`willValidate` | | `boolean` | `undefined` | @@ -262,9 +262,9 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`checkValidity` | _None_ | `boolean` | Checks the switch's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity -`reportValidity` | _None_ | `boolean` | Checks the switch's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

The `validationMessage` is reported to the user by the browser. Use
`setCustomValidity()` to customize the `validationMessage`.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity -`setCustomValidity` | `error` | `void` | Sets the switch's native validation error message. This is used to
customize `validationMessage`.

When the error is not an empty string, the switch is considered invalid
and `validity.customError` will be true.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity +`checkValidity` | _None_ | `boolean` | Checks the switch's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity +`reportValidity` | _None_ | `boolean` | Checks the switch's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
The `validationMessage` is reported to the user by the browser. Use `setCustomValidity()` to customize the `validationMessage`.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity +`setCustomValidity` | `error` | `void` | Sets the switch's native validation error message. This is used to customize `validationMessage`.
When the error is not an empty string, the switch is considered invalid and `validity.customError` will be true.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity @@ -272,10 +272,10 @@ Method | Parameters | Returns | Description -Event | Type | Description ---- | --- | --- -`input` | `InputEvent` | Fired whenever `selected` changes due to user
interaction (bubbles and composed). -`change` | `Event` | Fired whenever `selected` changes due to user
interaction (bubbles). +Event | Description +--- | --- +`input` | Fired whenever `selected` changes due to user interaction (bubbles and composed). +`change` | Fired whenever `selected` changes due to user interaction (bubbles). diff --git a/docs/components/tabs.md b/docs/components/tabs.md index 64c3d7e619..b3a0c3c262 100644 --- a/docs/components/tabs.md +++ b/docs/components/tabs.md @@ -375,7 +375,7 @@ Token | Default value ## API -### MdTabs +### MdTabs <md-tabs> #### Properties @@ -384,9 +384,9 @@ Token | Default value Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `autoActivate` | `auto-activate` | `boolean` | `false` | Whether or not to automatically select a tab when it is focused. -`tabs` | | `Tab[]` | `undefined` | The tabs of this tab bar. -`activeTab` | | `Tab` | `undefined` | The currently selected tab, `null` only when there are no tab children. -`activeTabIndex` | | `number` | `undefined` | The index of the currently selected tab. +`tabs` | | `Tab[]` | `undefined` | +`activeTab` | | `Tab` | `undefined` | +`activeTabIndex` | | `number` | `undefined` | @@ -396,7 +396,7 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`scrollToTab` | `tabToScrollTo` | `Promise` | Scrolls the toolbar, if overflowing, to the active tab, or the provided
tab. +`scrollToTab` | `tabToScrollTo` | `Promise` | Scrolls the toolbar, if overflowing, to the active tab, or the provided tab. @@ -404,13 +404,13 @@ Method | Parameters | Returns | Description -Event | Type | Description ---- | --- | --- -`change` | `undefined` | Fired when the selected tab changes. The target's selected or
selectedItem and previousSelected or previousSelectedItem provide information
about the selection change. The change event is fired when a user interaction
like a space/enter key or click cause a selection change. The tab selection
based on these actions can be cancelled by calling preventDefault on the
triggering `keydown` or `click` event. +Event | Description +--- | --- +`change` | Fired when the selected tab changes. The target's selected or selectedItem and previousSelected or previousSelectedItem provide information about the selection change. The change event is fired when a user interaction like a space/enter key or click cause a selection change. The tab selection based on these actions can be cancelled by calling preventDefault on the triggering `keydown` or `click` event. -### MdPrimaryTab +### MdPrimaryTab <md-primary-tab> #### Properties @@ -422,21 +422,11 @@ Property | Attribute | Type | Default | Description `active` | `active` | `boolean` | `false` | Whether or not the tab is selected. `hasIcon` | `has-icon` | `boolean` | `false` | In SSR, set this to true when an icon is present. `iconOnly` | `icon-only` | `boolean` | `false` | In SSR, set this to true when there is no label and only an icon. -`selected` | `selected` | `boolean` | `undefined` | TODO(b/293476210): remove after migrating +`selected` | `selected` | `boolean` | `undefined` | -#### Methods - - - -Method | Parameters | Returns | Description ---- | --- | --- | --- -`[ANIMATE_INDICATOR]` | `previousTab` | `void` | - - - -### MdSecondaryTab +### MdSecondaryTab <md-secondary-tab> #### Properties @@ -447,17 +437,7 @@ Property | Attribute | Type | Default | Description `active` | `active` | `boolean` | `false` | Whether or not the tab is selected. `hasIcon` | `has-icon` | `boolean` | `false` | In SSR, set this to true when an icon is present. `iconOnly` | `icon-only` | `boolean` | `false` | In SSR, set this to true when there is no label and only an icon. -`selected` | `selected` | `boolean` | `undefined` | TODO(b/293476210): remove after migrating - - - -#### Methods - - - -Method | Parameters | Returns | Description ---- | --- | --- | --- -`[ANIMATE_INDICATOR]` | `previousTab` | `void` | +`selected` | `selected` | `boolean` | `undefined` | diff --git a/docs/components/text-field.md b/docs/components/text-field.md index c3bacc21db..0b1470620d 100644 --- a/docs/components/text-field.md +++ b/docs/components/text-field.md @@ -480,7 +480,7 @@ Token | Default value ## API -### MdFilledTextField +### MdFilledTextField <md-filled-text-field> #### Properties @@ -489,8 +489,8 @@ Token | Default value Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | -`error` | `error` | `boolean` | `false` | Gets or sets whether or not the text field is in a visually invalid state.

This error state overrides the error state controlled by
`reportValidity()`. -`errorText` | `error-text` | `string` | `''` | The error message that replaces supporting text when `error` is true. If
`errorText` is an empty string, then the supporting text will continue to
show.

This error message overrides the error message displayed by
`reportValidity()`. +`error` | `error` | `boolean` | `false` | Gets or sets whether or not the text field is in a visually invalid state.
This error state overrides the error state controlled by `reportValidity()`. +`errorText` | `error-text` | `string` | `''` | The error message that replaces supporting text when `error` is true. If `errorText` is an empty string, then the supporting text will continue to show.
This error message overrides the error message displayed by `reportValidity()`. `label` | `label` | `string` | `''` | `required` | `required` | `boolean` | `false` | `value` | `value` | `string` | `''` | The current value of the text field. It is always a string. @@ -498,31 +498,31 @@ Property | Attribute | Type | Default | Description `suffixText` | `suffix-text` | `string` | `''` | An optional suffix to display after the input value. `hasLeadingIcon` | `has-leading-icon` | `boolean` | `false` | Whether or not the text field has a leading icon. Used for SSR. `hasTrailingIcon` | `has-trailing-icon` | `boolean` | `false` | Whether or not the text field has a trailing icon. Used for SSR. -`supportingText` | `supporting-text` | `string` | `''` | Conveys additional information below the text field, such as how it should
be used. -`textDirection` | `text-direction` | `string` | `''` | Override the input text CSS `direction`. Useful for RTL languages that use
LTR notation for fractions. -`rows` | `rows` | `number` | `2` | The number of rows to display for a `type="textarea"` text field.
Defaults to 2. +`supportingText` | `supporting-text` | `string` | `''` | Conveys additional information below the text field, such as how it should be used. +`textDirection` | `text-direction` | `string` | `''` | Override the input text CSS `direction`. Useful for RTL languages that use LTR notation for fractions. +`rows` | `rows` | `number` | `2` | The number of rows to display for a `type="textarea"` text field. Defaults to 2. `inputMode` | `inputmode` | `string` | `''` | -`max` | `max` | `string` | `''` | Defines the greatest value in the range of permitted values.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max -`maxLength` | `maxlength` | `number` | `-1` | The maximum number of characters a user can enter into the text field. Set
to -1 for none.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength -`min` | `min` | `string` | `''` | Defines the most negative value in the range of permitted values.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min -`minLength` | `minlength` | `number` | `-1` | The minimum number of characters a user can enter into the text field. Set
to -1 for none.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength -`pattern` | `pattern` | `string` | `''` | A regular expression that the text field's value must match to pass
constraint validation.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern +`max` | `max` | `string` | `''` | Defines the greatest value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max +`maxLength` | `maxlength` | `number` | `-1` | The maximum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength +`min` | `min` | `string` | `''` | Defines the most negative value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min +`minLength` | `minlength` | `number` | `-1` | The minimum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength +`pattern` | `pattern` | `string` | `''` | A regular expression that the text field's value must match to pass constraint validation.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern `placeholder` | `placeholder` | `string` | `''` | -`readOnly` | `readonly` | `boolean` | `false` | Indicates whether or not a user should be able to edit the text field's
value.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly -`step` | `step` | `string` | `''` | Returns or sets the element's step attribute, which works with min and max
to limit the increments at which a numeric or date-time value can be set.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step -`type` | `type` | `string` | `'text'` | The `` type to use, defaults to "text". The type greatly changes how
the text field behaves.

Text fields support a limited number of `` types:

- text
- textarea
- email
- number
- password
- search
- tel
- url

See
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types
for more details on each input type. -`autocomplete` | `autocomplete` | `string` | `''` | Describes what, if any, type of autocomplete functionality the input
should provide.

https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`selectionDirection` | | `string` | `undefined` | Gets or sets the direction in which selection occurred. -`selectionEnd` | | `number` | `undefined` | Gets or sets the end position or offset of a text selection. -`selectionStart` | | `number` | `undefined` | Gets or sets the starting position or offset of a text selection. -`validationMessage` | | `string` | `undefined` | Returns the text field's validation error message.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation -`validity` | | `ValidityState` | `undefined` | Returns a `ValidityState` object that represents the validity states of the
text field.

https://developer.mozilla.org/en-US/docs/Web/API/ValidityState -`valueAsNumber` | | `number` | `undefined` | The text field's value as a number. -`valueAsDate` | | `Date` | `undefined` | The text field's value as a Date. -`willValidate` | | `boolean` | `undefined` | Returns whether an element will successfully validate based on forms
validation rules and constraints.

https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/willValidate +`readOnly` | `readonly` | `boolean` | `false` | Indicates whether or not a user should be able to edit the text field's value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly +`step` | `step` | `string` | `''` | Returns or sets the element's step attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step +`type` | `type` | `string` | `'text'` | The `` type to use, defaults to "text". The type greatly changes how the text field behaves.
Text fields support a limited number of `` types:
- text - textarea - email - number - password - search - tel - url
See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types for more details on each input type. +`autocomplete` | `autocomplete` | `string` | `''` | Describes what, if any, type of autocomplete functionality the input should provide.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | +`name` | | `string` | `undefined` | +`selectionDirection` | | `string` | `undefined` | +`selectionEnd` | | `number` | `undefined` | +`selectionStart` | | `number` | `undefined` | +`validationMessage` | | `string` | `undefined` | +`validity` | | `ValidityState` | `undefined` | +`valueAsNumber` | | `number` | `undefined` | +`valueAsDate` | | `Date` | `undefined` | +`willValidate` | | `boolean` | `undefined` | @@ -532,19 +532,19 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`checkValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity -`reportValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

This method will display or clear an error text message equal to the text
field's `validationMessage`, unless the invalid event is canceled.

Use `setCustomValidity()` to customize the `validationMessage`.

This method can also be used to re-announce error messages to screen
readers.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity -`select` | _None_ | `void` | Selects all the text in the text field.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select -`setCustomValidity` | `error` | `void` | Sets a custom validation error message for the text field. Use this for
custom error message.

When the error is not an empty string, the text field is considered invalid
and `validity.customError` will be true.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity +`checkValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity +`reportValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
This method will display or clear an error text message equal to the text field's `validationMessage`, unless the invalid event is canceled.
Use `setCustomValidity()` to customize the `validationMessage`.
This method can also be used to re-announce error messages to screen readers.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity +`select` | _None_ | `void` | Selects all the text in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select +`setCustomValidity` | `error` | `void` | Sets a custom validation error message for the text field. Use this for custom error message.
When the error is not an empty string, the text field is considered invalid and `validity.customError` will be true.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity `setRangeText` | `args` | `void` | -`setSelectionRange` | `start`, `end`, `direction` | `void` | Sets the start and end positions of a selection in the text field.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange -`stepDown` | `stepDecrement` | `void` | Decrements the value of a numeric type text field by `step` or `n` `step`
number of times.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown -`stepUp` | `stepIncrement` | `void` | Increments the value of a numeric type text field by `step` or `n` `step`
number of times.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp +`setSelectionRange` | `start`, `end`, `direction` | `void` | Sets the start and end positions of a selection in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange +`stepDown` | `stepDecrement` | `void` | Decrements the value of a numeric type text field by `step` or `n` `step` number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown +`stepUp` | `stepIncrement` | `void` | Increments the value of a numeric type text field by `step` or `n` `step` number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp `reset` | _None_ | `void` | Reset the text field to its default value. -### MdOutlinedTextField +### MdOutlinedTextField <md-outlined-text-field> #### Properties @@ -553,8 +553,8 @@ Method | Parameters | Returns | Description Property | Attribute | Type | Default | Description --- | --- | --- | --- | --- `disabled` | `disabled` | `boolean` | `false` | -`error` | `error` | `boolean` | `false` | Gets or sets whether or not the text field is in a visually invalid state.

This error state overrides the error state controlled by
`reportValidity()`. -`errorText` | `error-text` | `string` | `''` | The error message that replaces supporting text when `error` is true. If
`errorText` is an empty string, then the supporting text will continue to
show.

This error message overrides the error message displayed by
`reportValidity()`. +`error` | `error` | `boolean` | `false` | Gets or sets whether or not the text field is in a visually invalid state.
This error state overrides the error state controlled by `reportValidity()`. +`errorText` | `error-text` | `string` | `''` | The error message that replaces supporting text when `error` is true. If `errorText` is an empty string, then the supporting text will continue to show.
This error message overrides the error message displayed by `reportValidity()`. `label` | `label` | `string` | `''` | `required` | `required` | `boolean` | `false` | `value` | `value` | `string` | `''` | The current value of the text field. It is always a string. @@ -562,31 +562,31 @@ Property | Attribute | Type | Default | Description `suffixText` | `suffix-text` | `string` | `''` | An optional suffix to display after the input value. `hasLeadingIcon` | `has-leading-icon` | `boolean` | `false` | Whether or not the text field has a leading icon. Used for SSR. `hasTrailingIcon` | `has-trailing-icon` | `boolean` | `false` | Whether or not the text field has a trailing icon. Used for SSR. -`supportingText` | `supporting-text` | `string` | `''` | Conveys additional information below the text field, such as how it should
be used. -`textDirection` | `text-direction` | `string` | `''` | Override the input text CSS `direction`. Useful for RTL languages that use
LTR notation for fractions. -`rows` | `rows` | `number` | `2` | The number of rows to display for a `type="textarea"` text field.
Defaults to 2. +`supportingText` | `supporting-text` | `string` | `''` | Conveys additional information below the text field, such as how it should be used. +`textDirection` | `text-direction` | `string` | `''` | Override the input text CSS `direction`. Useful for RTL languages that use LTR notation for fractions. +`rows` | `rows` | `number` | `2` | The number of rows to display for a `type="textarea"` text field. Defaults to 2. `inputMode` | `inputmode` | `string` | `''` | -`max` | `max` | `string` | `''` | Defines the greatest value in the range of permitted values.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max -`maxLength` | `maxlength` | `number` | `-1` | The maximum number of characters a user can enter into the text field. Set
to -1 for none.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength -`min` | `min` | `string` | `''` | Defines the most negative value in the range of permitted values.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min -`minLength` | `minlength` | `number` | `-1` | The minimum number of characters a user can enter into the text field. Set
to -1 for none.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength -`pattern` | `pattern` | `string` | `''` | A regular expression that the text field's value must match to pass
constraint validation.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern +`max` | `max` | `string` | `''` | Defines the greatest value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max +`maxLength` | `maxlength` | `number` | `-1` | The maximum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength +`min` | `min` | `string` | `''` | Defines the most negative value in the range of permitted values.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min +`minLength` | `minlength` | `number` | `-1` | The minimum number of characters a user can enter into the text field. Set to -1 for none.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength +`pattern` | `pattern` | `string` | `''` | A regular expression that the text field's value must match to pass constraint validation.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern `placeholder` | `placeholder` | `string` | `''` | -`readOnly` | `readonly` | `boolean` | `false` | Indicates whether or not a user should be able to edit the text field's
value.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly -`step` | `step` | `string` | `''` | Returns or sets the element's step attribute, which works with min and max
to limit the increments at which a numeric or date-time value can be set.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step -`type` | `type` | `string` | `'text'` | The `` type to use, defaults to "text". The type greatly changes how
the text field behaves.

Text fields support a limited number of `` types:

- text
- textarea
- email
- number
- password
- search
- tel
- url

See
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types
for more details on each input type. -`autocomplete` | `autocomplete` | `string` | `''` | Describes what, if any, type of autocomplete functionality the input
should provide.

https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete -`form` | | `HTMLFormElement` | `undefined` | The associated form element with which this element's value will submit. -`labels` | | `NodeList` | `undefined` | The labels this element is associated with. -`name` | | `string` | `undefined` | The HTML name to use in form submission. -`selectionDirection` | | `string` | `undefined` | Gets or sets the direction in which selection occurred. -`selectionEnd` | | `number` | `undefined` | Gets or sets the end position or offset of a text selection. -`selectionStart` | | `number` | `undefined` | Gets or sets the starting position or offset of a text selection. -`validationMessage` | | `string` | `undefined` | Returns the text field's validation error message.

https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation -`validity` | | `ValidityState` | `undefined` | Returns a `ValidityState` object that represents the validity states of the
text field.

https://developer.mozilla.org/en-US/docs/Web/API/ValidityState -`valueAsNumber` | | `number` | `undefined` | The text field's value as a number. -`valueAsDate` | | `Date` | `undefined` | The text field's value as a Date. -`willValidate` | | `boolean` | `undefined` | Returns whether an element will successfully validate based on forms
validation rules and constraints.

https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/willValidate +`readOnly` | `readonly` | `boolean` | `false` | Indicates whether or not a user should be able to edit the text field's value.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly +`step` | `step` | `string` | `''` | Returns or sets the element's step attribute, which works with min and max to limit the increments at which a numeric or date-time value can be set.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#step +`type` | `type` | `string` | `'text'` | The `` type to use, defaults to "text". The type greatly changes how the text field behaves.
Text fields support a limited number of `` types:
- text - textarea - email - number - password - search - tel - url
See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types for more details on each input type. +`autocomplete` | `autocomplete` | `string` | `''` | Describes what, if any, type of autocomplete functionality the input should provide.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | +`name` | | `string` | `undefined` | +`selectionDirection` | | `string` | `undefined` | +`selectionEnd` | | `number` | `undefined` | +`selectionStart` | | `number` | `undefined` | +`validationMessage` | | `string` | `undefined` | +`validity` | | `ValidityState` | `undefined` | +`valueAsNumber` | | `number` | `undefined` | +`valueAsDate` | | `Date` | `undefined` | +`willValidate` | | `boolean` | `undefined` | @@ -596,14 +596,14 @@ Property | Attribute | Type | Default | Description Method | Parameters | Returns | Description --- | --- | --- | --- -`checkValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity -`reportValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the
element is valid.

If invalid, this method will dispatch the `invalid` event.

This method will display or clear an error text message equal to the text
field's `validationMessage`, unless the invalid event is canceled.

Use `setCustomValidity()` to customize the `validationMessage`.

This method can also be used to re-announce error messages to screen
readers.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity -`select` | _None_ | `void` | Selects all the text in the text field.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select -`setCustomValidity` | `error` | `void` | Sets a custom validation error message for the text field. Use this for
custom error message.

When the error is not an empty string, the text field is considered invalid
and `validity.customError` will be true.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity +`checkValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity +`reportValidity` | _None_ | `boolean` | Checks the text field's native validation and returns whether or not the element is valid.
If invalid, this method will dispatch the `invalid` event.
This method will display or clear an error text message equal to the text field's `validationMessage`, unless the invalid event is canceled.
Use `setCustomValidity()` to customize the `validationMessage`.
This method can also be used to re-announce error messages to screen readers.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity +`select` | _None_ | `void` | Selects all the text in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select +`setCustomValidity` | `error` | `void` | Sets a custom validation error message for the text field. Use this for custom error message.
When the error is not an empty string, the text field is considered invalid and `validity.customError` will be true.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity `setRangeText` | `args` | `void` | -`setSelectionRange` | `start`, `end`, `direction` | `void` | Sets the start and end positions of a selection in the text field.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange -`stepDown` | `stepDecrement` | `void` | Decrements the value of a numeric type text field by `step` or `n` `step`
number of times.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown -`stepUp` | `stepIncrement` | `void` | Increments the value of a numeric type text field by `step` or `n` `step`
number of times.

https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp +`setSelectionRange` | `start`, `end`, `direction` | `void` | Sets the start and end positions of a selection in the text field.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange +`stepDown` | `stepDecrement` | `void` | Decrements the value of a numeric type text field by `step` or `n` `step` number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepDown +`stepUp` | `stepIncrement` | `void` | Increments the value of a numeric type text field by `step` or `n` `step` number of times.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/stepUp `reset` | _None_ | `void` | Reset the text field to its default value.