Merge pull request #4956 from material-components:auto-update-docs

PiperOrigin-RevId: 566993280
material-components · Sep 20, 2023 · dc75fbc · dc75fbc
2 parents f576b60 + 621192b
commit dc75fbc
Show file tree

Hide file tree

Showing 17 changed files with 262 additions and 289 deletions.
diff --git a/docs/components/button.md b/docs/components/button.md
@@ -704,7 +704,7 @@ Token                               | Default value
 ## API
 
 
-### MdElevatedButton
+### MdElevatedButton &lt;md-elevated-button&gt;
 
 #### 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<br>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<br>inline start.<br><br>_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.<br>_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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdFilledButton
+### MdFilledButton &lt;md-filled-button&gt;
 
 #### 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<br>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<br>inline start.<br><br>_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.<br>_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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdFilledTonalButton
+### MdFilledTonalButton &lt;md-filled-tonal-button&gt;
 
 #### 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<br>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<br>inline start.<br><br>_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.<br>_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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdOutlinedButton
+### MdOutlinedButton &lt;md-outlined-button&gt;
 
 #### 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<br>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<br>inline start.<br><br>_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.<br>_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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdTextButton
+### MdTextButton &lt;md-text-button&gt;
 
 #### 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<br>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<br>inline start.<br><br>_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.<br>_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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 

diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md
@@ -165,7 +165,7 @@ Token                                    | Default value
 ## API
 
 
-### MdCheckbox
+### MdCheckbox &lt;md-checkbox&gt;
 
 #### 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.<br><br>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<br>form submission.<br><br>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.<br><br>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<br>checkbox.<br><br>Note that checkboxes will only set `valueMissing` if `required` and not<br>checked.<br><br>https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation
-`validationMessage` |  | `string` | `undefined` | Returns the native validation error message.<br><br>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<br>validation rules and constraints.<br><br>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.<br>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.<br>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.<br>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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
@@ -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<br>element is valid.<br><br>If invalid, this method will dispatch the `invalid` event.<br><br>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<br>element is valid.<br><br>If invalid, this method will dispatch the `invalid` event.<br><br>The `validationMessage` is reported to the user by the browser. Use<br>`setCustomValidity()` to customize the `validationMessage`.<br><br>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<br>customize `validationMessage`.<br><br>When the error is not an empty string, the checkbox is considered invalid<br>and `validity.customError` will be true.<br><br>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.<br>If invalid, this method will dispatch the `invalid` event.<br>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.<br>If invalid, this method will dispatch the `invalid` event.<br>The `validationMessage` is reported to the user by the browser. Use `setCustomValidity()` to customize the `validationMessage`.<br>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`.<br>When the error is not an empty string, the checkbox is considered invalid and `validity.customError` will be true.<br>https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 

diff --git a/docs/components/chip.md b/docs/components/chip.md
@@ -486,7 +486,7 @@ Token                                   | Default value
 ## API
 
 
-### MdChipSet
+### MdChipSet &lt;md-chip-set&gt;
 
 #### Properties
 
@@ -498,7 +498,7 @@ Property | Attribute | Type | Default | Description
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdAssistChip
+### MdAssistChip &lt;md-assist-chip&gt;
 
 #### 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.<br><br>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.<br><br>Add this when a chip needs increased visibility when disabled. See<br>https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls<br>for more guidance on when this is needed.
+`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.<br>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.<br>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.
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdFilterChip
+### MdFilterChip &lt;md-filter-chip&gt;
 
 #### 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.<br><br>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.<br><br>Add this when a chip needs increased visibility when disabled. See<br>https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls<br>for more guidance on when this is needed.
+`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.<br>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.<br>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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdInputChip
+### MdInputChip &lt;md-input-chip&gt;
 
 #### 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.<br><br>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.<br><br>Add this when a chip needs increased visibility when disabled. See<br>https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls<br>for more guidance on when this is needed.
+`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.<br>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.<br>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` | 
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
-### MdSuggestionChip
+### MdSuggestionChip &lt;md-suggestion-chip&gt;
 
 #### 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.<br><br>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.<br><br>Add this when a chip needs increased visibility when disabled. See<br>https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls<br>for more guidance on when this is needed.
+`disabled` | `disabled` | `boolean` | `false` | Whether or not the chip is disabled.<br>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.<br>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.
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->