Skip to content

Commit 37e6876

Browse files
lit-robotlit-robot
committed
docs: update API docs
1 parent e16e2f6 commit 37e6876

File tree

2 files changed

+9
-49
lines changed

2 files changed

+9
-49
lines changed

‎docs/components/button.md‎

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -734,17 +734,13 @@ Token | Default value
734734

735735
| Property | Attribute | Type | Default | Description |
736736
| --- | --- | --- | --- | --- |
737-
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
738737
| `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).<br>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. |
739738
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
740739
| `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). |
741740
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
742741
| `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. |
743742
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
744-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
745-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
746-
| `name` | | `string` | `undefined` | |
747-
| `form` | | `HTMLFormElement` | `undefined` | |
743+
| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. |
748744

749745
<!-- mdformat on(autogenerated might break rendering in catalog) -->
750746

@@ -756,17 +752,13 @@ Token | Default value
756752

757753
| Property | Attribute | Type | Default | Description |
758754
| --- | --- | --- | --- | --- |
759-
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
760755
| `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).<br>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. |
761756
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
762757
| `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). |
763758
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
764759
| `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. |
765760
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
766-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
767-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
768-
| `name` | | `string` | `undefined` | |
769-
| `form` | | `HTMLFormElement` | `undefined` | |
761+
| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. |
770762

771763
<!-- mdformat on(autogenerated might break rendering in catalog) -->
772764

@@ -778,17 +770,13 @@ Token | Default value
778770

779771
| Property | Attribute | Type | Default | Description |
780772
| --- | --- | --- | --- | --- |
781-
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
782773
| `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).<br>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. |
783774
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
784775
| `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). |
785776
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
786777
| `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. |
787778
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
788-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
789-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
790-
| `name` | | `string` | `undefined` | |
791-
| `form` | | `HTMLFormElement` | `undefined` | |
779+
| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. |
792780

793781
<!-- mdformat on(autogenerated might break rendering in catalog) -->
794782

@@ -800,17 +788,13 @@ Token | Default value
800788

801789
| Property | Attribute | Type | Default | Description |
802790
| --- | --- | --- | --- | --- |
803-
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
804791
| `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).<br>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. |
805792
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
806793
| `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). |
807794
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
808795
| `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. |
809796
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
810-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
811-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
812-
| `name` | | `string` | `undefined` | |
813-
| `form` | | `HTMLFormElement` | `undefined` | |
797+
| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. |
814798

815799
<!-- mdformat on(autogenerated might break rendering in catalog) -->
816800

@@ -822,17 +806,13 @@ Token | Default value
822806

823807
| Property | Attribute | Type | Default | Description |
824808
| --- | --- | --- | --- | --- |
825-
| `disabled` | `disabled` | `boolean` | `false` | Whether or not the button is disabled. |
826809
| `softDisabled` | `soft-disabled` | `boolean` | `false` | Whether or not the button is "soft-disabled" (disabled but still focusable).<br>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. |
827810
| `href` | `href` | `string` | `''` | The URL that the link button points to. |
828811
| `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). |
829812
| `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. |
830813
| `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. |
831814
| `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. |
832-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
833-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
834-
| `name` | | `string` | `undefined` | |
835-
| `form` | | `HTMLFormElement` | `undefined` | |
815+
| `disabled` | | `boolean` | `undefined` | Whether or not the button is disabled. |
836816

837817
<!-- mdformat on(autogenerated might break rendering in catalog) -->
838818

‎docs/components/icon-button.md‎

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,6 @@ Token | Default value
465465

466466
| Property | Attribute | Type | Default | Description |
467467
| --- | --- | --- | --- | --- |
468-
| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. |
469468
| `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).<br>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. |
470469
| `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. |
471470
| `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. |
@@ -474,11 +473,7 @@ Token | Default value
474473
| `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. |
475474
| `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states |
476475
| `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. |
477-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
478-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
479-
| `name` | | `string` | `undefined` | |
480-
| `form` | | `HTMLFormElement` | `undefined` | |
481-
| `labels` | | `NodeList` | `undefined` | |
476+
| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. |
482477

483478
<!-- mdformat on(autogenerated might break rendering in catalog) -->
484479

@@ -501,7 +496,6 @@ Token | Default value
501496

502497
| Property | Attribute | Type | Default | Description |
503498
| --- | --- | --- | --- | --- |
504-
| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. |
505499
| `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).<br>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. |
506500
| `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. |
507501
| `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. |
@@ -510,11 +504,7 @@ Token | Default value
510504
| `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. |
511505
| `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states |
512506
| `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. |
513-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
514-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
515-
| `name` | | `string` | `undefined` | |
516-
| `form` | | `HTMLFormElement` | `undefined` | |
517-
| `labels` | | `NodeList` | `undefined` | |
507+
| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. |
518508

519509
<!-- mdformat on(autogenerated might break rendering in catalog) -->
520510

@@ -537,7 +527,6 @@ Token | Default value
537527

538528
| Property | Attribute | Type | Default | Description |
539529
| --- | --- | --- | --- | --- |
540-
| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. |
541530
| `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).<br>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. |
542531
| `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. |
543532
| `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. |
@@ -546,11 +535,7 @@ Token | Default value
546535
| `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. |
547536
| `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states |
548537
| `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. |
549-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
550-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
551-
| `name` | | `string` | `undefined` | |
552-
| `form` | | `HTMLFormElement` | `undefined` | |
553-
| `labels` | | `NodeList` | `undefined` | |
538+
| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. |
554539

555540
<!-- mdformat on(autogenerated might break rendering in catalog) -->
556541

@@ -573,7 +558,6 @@ Token | Default value
573558

574559
| Property | Attribute | Type | Default | Description |
575560
| --- | --- | --- | --- | --- |
576-
| `disabled` | `disabled` | `boolean` | `false` | Disables the icon button and makes it non-interactive. |
577561
| `softDisabled` | `soft-disabled` | `boolean` | `false` | "Soft-disables" the icon button (disabled but still focusable).<br>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. |
578562
| `flipIconInRtl` | `flip-icon-in-rtl` | `boolean` | `false` | Flips the icon if it is in an RTL context at startup. |
579563
| `href` | `href` | `string` | `''` | Sets the underlying `HTMLAnchorElement`'s `href` resource attribute. |
@@ -582,11 +566,7 @@ Token | Default value
582566
| `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. |
583567
| `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states |
584568
| `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. |
585-
| `type` | `type` | `string` | `'submit'` | The default behavior of the button. May be "button", "reset", or "submit" (default). |
586-
| `value` | `value` | `string` | `''` | The value added to a form with the button's name when the button submits a form. |
587-
| `name` | | `string` | `undefined` | |
588-
| `form` | | `HTMLFormElement` | `undefined` | |
589-
| `labels` | | `NodeList` | `undefined` | |
569+
| `disabled` | | `boolean` | `undefined` | Disables the icon button and makes it non-interactive. |
590570

591571
<!-- mdformat on(autogenerated might break rendering in catalog) -->
592572

0 commit comments

Comments
 (0)