docs: update analyzer and update docs

material-components · Jun 5, 2024 · 2c0fafd · 2c0fafd
1 parent aab5e69
commit 2c0fafd
Show file tree

Hide file tree

Showing 20 changed files with 759 additions and 608 deletions.
diff --git a/docs/components/button.md b/docs/components/button.md
@@ -710,17 +710,17 @@ Token                               | Default value
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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.<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` |
+| 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.<br>_Note:_ Link buttons cannot have trailing icons. |
+| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
+| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
+| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
+| `name` |  | `string` | `undefined` |  |
+| `form` |  | `HTMLFormElement` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
@@ -730,17 +730,17 @@ Property | Attribute | Type | Default | Description
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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.<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` |
+| 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.<br>_Note:_ Link buttons cannot have trailing icons. |
+| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
+| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
+| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
+| `name` |  | `string` | `undefined` |  |
+| `form` |  | `HTMLFormElement` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
@@ -750,17 +750,17 @@ Property | Attribute | Type | Default | Description
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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.<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` |
+| 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.<br>_Note:_ Link buttons cannot have trailing icons. |
+| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
+| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
+| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
+| `name` |  | `string` | `undefined` |  |
+| `form` |  | `HTMLFormElement` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
@@ -770,17 +770,17 @@ Property | Attribute | Type | Default | Description
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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.<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` |
+| 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.<br>_Note:_ Link buttons cannot have trailing icons. |
+| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
+| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
+| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
+| `name` |  | `string` | `undefined` |  |
+| `form` |  | `HTMLFormElement` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
@@ -790,17 +790,17 @@ Property | Attribute | Type | Default | Description
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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.<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` |
+| 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.<br>_Note:_ Link buttons cannot have trailing icons. |
+| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
+| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
+| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
+| `name` |  | `string` | `undefined` |  |
+| `form` |  | `HTMLFormElement` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 

diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md
@@ -168,37 +168,43 @@ Token                                    | Default value
 
 ## API
 
+
 ### MdCheckbox <code>&lt;md-checkbox&gt;</code>
 
 #### Properties
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-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>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` |
+| Property | Attribute | Type | Default | Description |
+| --- | --- | --- | --- | --- |
+| `checked` | `checked` | `boolean` | `false` | Whether or not the checkbox is selected. |
+| `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 |
+| `disabled` |  | `boolean` | `undefined` |  |
+| `name` |  | `string` | `undefined` |  |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->
 
 #### Methods
 
 <!-- mdformat off(autogenerated might break rendering in catalog) -->
 
-Method | Parameters | Returns | Description
---- | --- | --- | ---
-`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
+| Method | Parameters | Returns | Description |
+| --- | --- | --- | --- |
+| `formResetCallback` | _None_ | `void` |  |
+| `formStateRestoreCallback` | `state` | `void` |  |
+
+<!-- mdformat on(autogenerated might break rendering in catalog) -->
+
+#### Events
+
+<!-- mdformat off(autogenerated might break rendering in catalog) -->
+
+| Event | Type | [Bubbles](https://developer.mozilla.org/en-US/docs/Web/API/Event/bubbles) | [Composed](https://developer.mozilla.org/en-US/docs/Web/API/Event/composed) | Description |
+| --- | --- | --- | --- | --- |
+| `change` | `Event` | Yes | No | The native `change` event on [`<input>`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) |
+| `input` | `InputEvent` | Yes | Yes | The native `input` event on [`<input>`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event) |
 
 <!-- mdformat on(autogenerated might break rendering in catalog) -->