From 7ac8b7049c233205b74706c7bd6350aabf99488b Mon Sep 17 00:00:00 2001 From: lit-robot Date: Thu, 9 Apr 2026 22:17:28 +0000 Subject: [PATCH] docs: update API docs --- docs/components/button.md | 30 +++++------------------------- docs/components/icon-button.md | 28 ++++------------------------ 2 files changed, 9 insertions(+), 49 deletions(-) diff --git a/docs/components/button.md b/docs/components/button.md index 0975f19568..6f276e56cc 100644 --- a/docs/components/button.md +++ b/docs/components/button.md @@ -734,17 +734,13 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).
Use this when a button 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. | | `href` | `href` | `string` | `''` | The URL that the link button points to. | | `download` | `download` | `string` | `''` | The filename to use when downloading the linked resource. If not specified, the browser will determine a filename. This is only applicable when the button is used as a link (`href` is set). | | `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'` | The default behavior of the button. May be "button", "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` | | +| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. | @@ -756,17 +752,13 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).
Use this when a button 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. | | `href` | `href` | `string` | `''` | The URL that the link button points to. | | `download` | `download` | `string` | `''` | The filename to use when downloading the linked resource. If not specified, the browser will determine a filename. This is only applicable when the button is used as a link (`href` is set). | | `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'` | The default behavior of the button. May be "button", "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` | | +| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. | @@ -778,17 +770,13 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).
Use this when a button 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. | | `href` | `href` | `string` | `''` | The URL that the link button points to. | | `download` | `download` | `string` | `''` | The filename to use when downloading the linked resource. If not specified, the browser will determine a filename. This is only applicable when the button is used as a link (`href` is set). | | `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'` | The default behavior of the button. May be "button", "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` | | +| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. | @@ -800,17 +788,13 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).
Use this when a button 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. | | `href` | `href` | `string` | `''` | The URL that the link button points to. | | `download` | `download` | `string` | `''` | The filename to use when downloading the linked resource. If not specified, the browser will determine a filename. This is only applicable when the button is used as a link (`href` is set). | | `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'` | The default behavior of the button. May be "button", "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` | | +| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. | @@ -822,17 +806,13 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).
Use this when a button 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. | | `href` | `href` | `string` | `''` | The URL that the link button points to. | | `download` | `download` | `string` | `''` | The filename to use when downloading the linked resource. If not specified, the browser will determine a filename. This is only applicable when the button is used as a link (`href` is set). | | `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'` | The default behavior of the button. May be "button", "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` | | +| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. | diff --git a/docs/components/icon-button.md b/docs/components/icon-button.md index 4d8c4c204b..1628130afb 100644 --- a/docs/components/icon-button.md +++ b/docs/components/icon-button.md @@ -465,7 +465,6 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).
Use this when an icon button 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. | | `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. | | `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. | @@ -474,11 +473,7 @@ Token | Default value | `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. | -| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "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` | | -| `labels` | | `NodeList` | `undefined` | | +| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. | @@ -501,7 +496,6 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).
Use this when an icon button 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. | | `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. | | `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. | @@ -510,11 +504,7 @@ Token | Default value | `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. | -| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "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` | | -| `labels` | | `NodeList` | `undefined` | | +| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. | @@ -537,7 +527,6 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).
Use this when an icon button 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. | | `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. | | `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. | @@ -546,11 +535,7 @@ Token | Default value | `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. | -| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "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` | | -| `labels` | | `NodeList` | `undefined` | | +| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. | @@ -573,7 +558,6 @@ Token | Default value | Property | Attribute | Type | Default | Description | | --- | --- | --- | --- | --- | -| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. | | `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).
Use this when an icon button 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. | | `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. | | `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. | @@ -582,11 +566,7 @@ Token | Default value | `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. | -| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "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` | | -| `labels` | | `NodeList` | `undefined` | | +| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. |