Skip to content

Commit 2c0fafd

Browse files
e111077e111077
committed
docs: update analyzer and update docs
1 parent aab5e69 commit 2c0fafd

20 files changed

+759
-608
lines changed

‎docs/components/button.md

+55-55
Original file line numberDiff line numberDiff line change
@@ -710,17 +710,17 @@ Token | Default value
710710

711711
<!-- mdformat off(autogenerated might break rendering in catalog) -->
712712

713-
Property | Attribute | Type | Default | Description
714-
--- | --- | --- | --- | ---
715-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled.
716-
`href` | `href` | `string` | `''` | The URL that the link button points to.
717-
`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab.
718-
`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.
719-
`hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not.
720-
`type` | `type` | `string` | `'submit'` |
721-
`value` | `value` | `string` | `''` |
722-
`name` | | `string` | `undefined` |
723-
`form` | | `HTMLFormElement` | `undefined` |
713+
| Property | Attribute | Type | Default | Description |
714+
| --- | --- | --- | --- | --- |
715+
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
716+
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
717+
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
718+
| `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. |
719+
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
720+
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
721+
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
722+
| `name` | | `string` | `undefined` | |
723+
| `form` | | `HTMLFormElement` | `undefined` | |
724724

725725
<!-- mdformat on(autogenerated might break rendering in catalog) -->
726726

@@ -730,17 +730,17 @@ Property | Attribute | Type | Default | Description
730730

731731
<!-- mdformat off(autogenerated might break rendering in catalog) -->
732732

733-
Property | Attribute | Type | Default | Description
734-
--- | --- | --- | --- | ---
735-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled.
736-
`href` | `href` | `string` | `''` | The URL that the link button points to.
737-
`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab.
738-
`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.
739-
`hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not.
740-
`type` | `type` | `string` | `'submit'` |
741-
`value` | `value` | `string` | `''` |
742-
`name` | | `string` | `undefined` |
743-
`form` | | `HTMLFormElement` | `undefined` |
733+
| Property | Attribute | Type | Default | Description |
734+
| --- | --- | --- | --- | --- |
735+
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
736+
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
737+
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
738+
| `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. |
739+
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
740+
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
741+
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
742+
| `name` | | `string` | `undefined` | |
743+
| `form` | | `HTMLFormElement` | `undefined` | |
744744

745745
<!-- mdformat on(autogenerated might break rendering in catalog) -->
746746

@@ -750,17 +750,17 @@ Property | Attribute | Type | Default | Description
750750

751751
<!-- mdformat off(autogenerated might break rendering in catalog) -->
752752

753-
Property | Attribute | Type | Default | Description
754-
--- | --- | --- | --- | ---
755-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled.
756-
`href` | `href` | `string` | `''` | The URL that the link button points to.
757-
`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab.
758-
`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.
759-
`hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not.
760-
`type` | `type` | `string` | `'submit'` |
761-
`value` | `value` | `string` | `''` |
762-
`name` | | `string` | `undefined` |
763-
`form` | | `HTMLFormElement` | `undefined` |
753+
| Property | Attribute | Type | Default | Description |
754+
| --- | --- | --- | --- | --- |
755+
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
756+
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
757+
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
758+
| `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. |
759+
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
760+
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
761+
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
762+
| `name` | | `string` | `undefined` | |
763+
| `form` | | `HTMLFormElement` | `undefined` | |
764764

765765
<!-- mdformat on(autogenerated might break rendering in catalog) -->
766766

@@ -770,17 +770,17 @@ Property | Attribute | Type | Default | Description
770770

771771
<!-- mdformat off(autogenerated might break rendering in catalog) -->
772772

773-
Property | Attribute | Type | Default | Description
774-
--- | --- | --- | --- | ---
775-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled.
776-
`href` | `href` | `string` | `''` | The URL that the link button points to.
777-
`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab.
778-
`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.
779-
`hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not.
780-
`type` | `type` | `string` | `'submit'` |
781-
`value` | `value` | `string` | `''` |
782-
`name` | | `string` | `undefined` |
783-
`form` | | `HTMLFormElement` | `undefined` |
773+
| Property | Attribute | Type | Default | Description |
774+
| --- | --- | --- | --- | --- |
775+
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
776+
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
777+
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
778+
| `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. |
779+
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
780+
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
781+
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
782+
| `name` | | `string` | `undefined` | |
783+
| `form` | | `HTMLFormElement` | `undefined` | |
784784

785785
<!-- mdformat on(autogenerated might break rendering in catalog) -->
786786

@@ -790,17 +790,17 @@ Property | Attribute | Type | Default | Description
790790

791791
<!-- mdformat off(autogenerated might break rendering in catalog) -->
792792

793-
Property | Attribute | Type | Default | Description
794-
--- | --- | --- | --- | ---
795-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled.
796-
`href` | `href` | `string` | `''` | The URL that the link button points to.
797-
`target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab.
798-
`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.
799-
`hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not.
800-
`type` | `type` | `string` | `'submit'` |
801-
`value` | `value` | `string` | `''` |
802-
`name` | | `string` | `undefined` |
803-
`form` | | `HTMLFormElement` | `undefined` |
793+
| Property | Attribute | Type | Default | Description |
794+
| --- | --- | --- | --- | --- |
795+
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
796+
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
797+
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
798+
| `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. |
799+
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
800+
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "text", "reset", or "submit" (default). |
801+
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
802+
| `name` | | `string` | `undefined` | |
803+
| `form` | | `HTMLFormElement` | `undefined` | |
804804

805805
<!-- mdformat on(autogenerated might break rendering in catalog) -->
806806

‎docs/components/checkbox.md

+24-18
Original file line numberDiff line numberDiff line change
@@ -168,37 +168,43 @@ Token | Default value
168168

169169
## API
170170

171+
171172
### MdCheckbox <code>&lt;md-checkbox&gt;</code>
172173

173174
#### Properties
174175

175176
<!-- mdformat off(autogenerated might break rendering in catalog) -->
176177

177-
Property | Attribute | Type | Default | Description
178-
--- | --- | --- | --- | ---
179-
`checked` | `checked` | `boolean` | `false` | Whether or not the checkbox is selected.
180-
`disabled` | `disabled` | `boolean` | `false` | Whether or not the checkbox is disabled.
181-
`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
182-
`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
183-
`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
184-
`name` | | `string` | `undefined` |
185-
`form` | | `HTMLFormElement` | `undefined` |
186-
`labels` | | `NodeList` | `undefined` |
187-
`validity` | | `ValidityState` | `undefined` |
188-
`validationMessage` | | `string` | `undefined` |
189-
`willValidate` | | `boolean` | `undefined` |
178+
| Property | Attribute | Type | Default | Description |
179+
| --- | --- | --- | --- | --- |
180+
| `checked` | `checked` | `boolean` | `false` | Whether or not the checkbox is selected. |
181+
| `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 |
182+
| `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 |
183+
| `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 |
184+
| `disabled` | | `boolean` | `undefined` | |
185+
| `name` | | `string` | `undefined` | |
190186

191187
<!-- mdformat on(autogenerated might break rendering in catalog) -->
192188

193189
#### Methods
194190

195191
<!-- mdformat off(autogenerated might break rendering in catalog) -->
196192

197-
Method | Parameters | Returns | Description
198-
--- | --- | --- | ---
199-
`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
200-
`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
201-
`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
193+
| Method | Parameters | Returns | Description |
194+
| --- | --- | --- | --- |
195+
| `formResetCallback` | _None_ | `void` | |
196+
| `formStateRestoreCallback` | `state` | `void` | |
197+
198+
<!-- mdformat on(autogenerated might break rendering in catalog) -->
199+
200+
#### Events
201+
202+
<!-- mdformat off(autogenerated might break rendering in catalog) -->
203+
204+
| 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 |
205+
| --- | --- | --- | --- | --- |
206+
| `change` | `Event` | Yes | No | The native `change` event on [`<input>`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) |
207+
| `input` | `InputEvent` | Yes | Yes | The native `input` event on [`<input>`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event) |
202208

203209
<!-- mdformat on(autogenerated might break rendering in catalog) -->
204210

0 commit comments

Comments
 (0)