From 00388fa58d30cc3074437d58b126a2c866f72157 Mon Sep 17 00:00:00 2001 From: Joe Fehrman Date: Fri, 24 May 2024 09:37:38 -0400 Subject: [PATCH 1/5] feat: Updating onConfirmDisabled prop to be isConfirmDisabled. --- .../components/alert-dialog/src/AlertDialog.tsx | 14 ++++++++++++-- .../alert-dialog/src/AlertDialogFooter.tsx | 7 +++++-- .../alert-dialog/stories/index.stories.tsx | 2 +- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/packages/paste-core/components/alert-dialog/src/AlertDialog.tsx b/packages/paste-core/components/alert-dialog/src/AlertDialog.tsx index 741a93b25e..e8d0dcb71f 100644 --- a/packages/paste-core/components/alert-dialog/src/AlertDialog.tsx +++ b/packages/paste-core/components/alert-dialog/src/AlertDialog.tsx @@ -75,13 +75,22 @@ export interface AlertDialogProps extends HTMLPasteProps<"div"> { */ onDismissLabel: string; /** - * Disable the confirm button + * Disable the confirm button. Use isConfirmDisabled + * @deprecated This prop has been deprecated in favor of the `isConfirmDisabled` prop. * * @default false * @type {boolean} * @memberof AlertDialogProps */ onConfirmDisabled?: boolean; + /** + * Disable the confirm button + * + * @default false + * @type {boolean} + * @memberof AlertDialogProps + */ + isConfirmDisabled?: boolean; /** * Overrides the default element name to apply unique styles with the Customization Provider * @@ -105,6 +114,7 @@ export const AlertDialog = React.forwardRef( onDismiss, onDismissLabel, onConfirmDisabled, + isConfirmDisabled, ...props }, ref, @@ -143,7 +153,7 @@ export const AlertDialog = React.forwardRef( onDismissLabel={onDismissLabel} onConfirm={onConfirm} onConfirmLabel={onConfirmLabel} - onConfirmDisabled={onConfirmDisabled} + isConfirmDisabled={isConfirmDisabled || onConfirmDisabled} /> diff --git a/packages/paste-core/components/alert-dialog/src/AlertDialogFooter.tsx b/packages/paste-core/components/alert-dialog/src/AlertDialogFooter.tsx index 253ba95bf6..ef247f3cf9 100644 --- a/packages/paste-core/components/alert-dialog/src/AlertDialogFooter.tsx +++ b/packages/paste-core/components/alert-dialog/src/AlertDialogFooter.tsx @@ -11,6 +11,8 @@ export interface AlertDialogFooterProps extends HTMLPasteProps<"div">, Pick void; onDismissLabel: string; + isConfirmDisabled?: boolean; + /** @deprecated This prop has been deprecated in favor of the `isConfirmDisabled` prop. */ onConfirmDisabled?: boolean; } @@ -23,7 +25,8 @@ export const AlertDialogFooter = React.forwardRef {onDismissLabel} - diff --git a/packages/paste-core/components/alert-dialog/stories/index.stories.tsx b/packages/paste-core/components/alert-dialog/stories/index.stories.tsx index 1ebee777a8..4e3e47c1b4 100644 --- a/packages/paste-core/components/alert-dialog/stories/index.stories.tsx +++ b/packages/paste-core/components/alert-dialog/stories/index.stories.tsx @@ -129,7 +129,7 @@ export const DisabledButtonDestructiveAlertDialog = ({ dialogIsOpen = false }): onDismiss={handleDismiss} onDismissLabel="Cancel" destructive - onConfirmDisabled={isDisabled} + isConfirmDisabled={isDisabled} > You're about to delete “Toyota TCB Automobile (Gevelsberg)“ and all data associated with it. This regulatory bundle will be deleted immediately. You can't undo this action. From 984ce0fb715a4f8ed4fefd24af100e2907b38e2d Mon Sep 17 00:00:00 2001 From: Joe Fehrman Date: Fri, 24 May 2024 09:40:10 -0400 Subject: [PATCH 2/5] feat: Creating changeset. --- .changeset/flat-boats-boil.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/flat-boats-boil.md diff --git a/.changeset/flat-boats-boil.md b/.changeset/flat-boats-boil.md new file mode 100644 index 0000000000..03fd1f9b78 --- /dev/null +++ b/.changeset/flat-boats-boil.md @@ -0,0 +1,6 @@ +--- +"@twilio-paste/alert-dialog": patch +"@twilio-paste/core": patch +--- + +Changing the property name, onConfirmDisabled, in AlertDialog component. The property is called isConfirmDisabled. Non breaking change. From 16eb36bf727e04bdbe3c8ff0d022094f4dc84b2e Mon Sep 17 00:00:00 2001 From: Joe Fehrman Date: Fri, 24 May 2024 09:46:52 -0400 Subject: [PATCH 3/5] feat: Generating typedocs. --- .../account-switcher/type-docs.json | 11397 +------ .../components/alert-dialog/type-docs.json | 1583 +- .../components/alert/type-docs.json | 1594 +- .../components/anchor/type-docs.json | 1812 +- .../components/avatar/type-docs.json | 3226 +- .../components/badge/type-docs.json | 4857 +-- .../components/breadcrumb/type-docs.json | 3182 +- .../components/button-group/type-docs.json | 1576 +- .../components/button/type-docs.json | 1692 +- .../components/callout/type-docs.json | 8014 +---- .../paste-core/components/card/type-docs.json | 1625 +- .../components/chat-composer/type-docs.json | 2292 +- .../components/chat-log/type-docs.json | 20969 +------------ .../components/checkbox/type-docs.json | 5220 +--- .../components/code-block/type-docs.json | 9585 +----- .../components/combobox/type-docs.json | 8769 +----- .../components/data-grid/type-docs.json | 13053 +------- .../components/date-picker/type-docs.json | 1820 +- .../description-list/type-docs.json | 6340 +--- .../components/detail-text/type-docs.json | 1578 +- .../components/disclosure/type-docs.json | 3507 +-- .../components/display-heading/type-docs.json | 1572 +- .../display-pill-group/type-docs.json | 3235 +- .../editable-code-block/type-docs.json | 3302 +- .../components/file-picker/type-docs.json | 3479 +-- .../components/file-uploader/type-docs.json | 16350 +--------- .../components/form-pill-group/type-docs.json | 2245 +- .../paste-core/components/form/type-docs.json | 11206 +------ .../components/heading/type-docs.json | 1575 +- .../components/help-text/type-docs.json | 1578 +- .../in-page-navigation/type-docs.json | 3245 +- .../components/inline-code/type-docs.json | 1584 +- .../components/input/type-docs.json | 1796 +- .../components/label/type-docs.json | 3215 +- .../paste-core/components/list/type-docs.json | 6454 +--- .../paste-core/components/menu/type-docs.json | 17149 +--------- .../components/meter/type-docs.json | 3221 +- .../minimizable-dialog/type-docs.json | 6813 +--- .../components/modal/type-docs.json | 9556 +----- .../components/page-header/type-docs.json | 17511 +---------- .../components/pagination/type-docs.json | 11404 +------ .../components/paragraph/type-docs.json | 1570 +- .../components/popover/type-docs.json | 5229 +--- .../product-switcher/type-docs.json | 5806 +--- .../components/progress-bar/type-docs.json | 3173 +- .../components/progress-steps/type-docs.json | 9592 +----- .../radio-button-group/type-docs.json | 3450 +- .../components/radio-group/type-docs.json | 3450 +- .../screen-reader-only/type-docs.json | 1570 +- .../components/select/type-docs.json | 4868 +-- .../components/separator/type-docs.json | 1574 +- .../components/side-modal/type-docs.json | 11517 +------ .../components/side-panel/type-docs.json | 12970 +------- .../components/sidebar/type-docs.json | 25992 +--------------- .../components/skeleton-loader/type-docs.json | 1679 +- .../components/slider/type-docs.json | 2 +- .../components/spinner/type-docs.json | 1600 +- .../components/status/type-docs.json | 13418 +------- .../components/summary-detail/type-docs.json | 1732 +- .../components/switch/type-docs.json | 3421 +- .../components/table/type-docs.json | 11384 +------ .../paste-core/components/tabs/type-docs.json | 6844 +--- .../components/textarea/type-docs.json | 1698 +- .../components/time-picker/type-docs.json | 1814 +- .../components/toast/type-docs.json | 3222 +- .../components/tooltip/type-docs.json | 309 +- .../components/topbar/type-docs.json | 3176 +- .../components/truncate/type-docs.json | 1571 +- .../components/user-dialog/type-docs.json | 10547 +------ .../components/visual-picker/type-docs.json | 6876 +--- .../paste-core/layout/flex/type-docs.json | 232 +- .../paste-core/layout/grid/type-docs.json | 3464 +- .../layout/media-object/type-docs.json | 4805 +-- .../paste-core/layout/stack/type-docs.json | 1586 +- .../paste-core/primitives/box/type-docs.json | 944 +- .../primitives/sibling-box/type-docs.json | 2926 +- .../paste-core/primitives/text/type-docs.json | 336 +- 77 files changed, 3572 insertions(+), 410956 deletions(-) diff --git a/packages/paste-core/components/account-switcher/type-docs.json b/packages/paste-core/components/account-switcher/type-docs.json index 6621159fbe..005c2e1e34 100644 --- a/packages/paste-core/components/account-switcher/type-docs.json +++ b/packages/paste-core/components/account-switcher/type-docs.json @@ -1,11383 +1,58 @@ { - "AccountSwitcherStateReturn": { - "animated": { - "type": "number | boolean", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "If `true`, `animating` will be set to `true` when `visible` is updated.\nIt'll wait for `stopAnimation` to be called or a CSS transition ends.\nIf `animated` is set to a `number`, `stopAnimation` will be called only\nafter the same number of milliseconds have passed." - }, - "animating": { - "type": "boolean", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Whether it's animating or not." - }, - "baseId": { - "type": "string", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "ID that will serve as a base for all the items IDs." - }, - "down": { - "type": "(unstable_allTheWay?: boolean | undefined) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the item below." - }, - "first": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the first item." - }, - "groups": { - "type": "Group[]", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Lists all the composite groups with their `id` and DOM `ref`. This state\nis automatically updated when `registerGroup` and `unregisterGroup` are\ncalled." - }, - "hide": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Changes the `visible` state to `false`" - }, - "items": { - "type": "Item[]", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Lists all the composite items with their `id`, DOM `ref`, `disabled` state\nand `groupId` if any. This state is automatically updated when\n`registerItem` and `unregisterItem` are called." - }, - "last": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the last item." - }, - "loop": { - "type": "boolean | Orientation", - "defaultValue": false, - "required": true, - "externalProp": true, - "description": "On one-dimensional composites:\n - `true` loops from the last item to the first item and vice-versa.\n - `horizontal` loops only if `orientation` is `horizontal` or not set.\n - `vertical` loops only if `orientation` is `vertical` or not set.\n - If `currentId` is initially set to `null`, the composite element will\nbe focused in between the last and first items.\n\nOn two-dimensional composites:\n - `true` loops from the last row/column item to the first item in the\nsame row/column and vice-versa. If it's the last item in the last row, it\nmoves to the first item in the first row and vice-versa.\n - `horizontal` loops only from the last row item to the first item in\nthe same row.\n - `vertical` loops only from the last column item to the first item in\nthe column row.\n - If `currentId` is initially set to `null`, vertical loop will have no\neffect as moving down from the last row or up from the first row will\nfocus the composite element.\n - If `wrap` matches the value of `loop`, it'll wrap between the last\nitem in the last row or column and the first item in the first row or\ncolumn and vice-versa." - }, - "modal": { - "type": "boolean", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Toggles Dialog's `modal` state.\n - Non-modal: `preventBodyScroll` doesn't work and focus is free.\n - Modal: `preventBodyScroll` is automatically enabled, focus is\ntrapped within the dialog and the dialog is rendered within a `Portal`\nby default." - }, - "move": { - "type": "(id: string | null) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to a given item ID." - }, - "next": { - "type": "(unstable_allTheWay?: boolean | undefined) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the next item." - }, - "place": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Change the `placement` state." - }, - "placement": { - "type": "Placement", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Actual `placement`." - }, - "previous": { - "type": "(unstable_allTheWay?: boolean | undefined) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the previous item." - }, - "registerGroup": { - "type": "(group: Group) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Registers a composite group." - }, - "registerItem": { - "type": "(item: Item) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Registers a composite item." - }, - "reset": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Resets to initial state." - }, - "rtl": { - "type": "boolean", - "defaultValue": false, - "required": true, - "externalProp": true, - "description": "Determines how `next` and `previous` functions will behave. If `rtl` is\nset to `true`, they will be inverted. This only affects the composite\nwidget behavior. You still need to set `dir=\"rtl\"` on HTML/CSS." - }, - "setAnimated": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `animated`." - }, - "setBaseId": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `baseId`." - }, - "setCurrentId": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `currentId`. This is different from `composite.move` as this only\nupdates the `currentId` state without moving focus. When the composite\nwidget gets focused by the user, the item referred by the `currentId`\nstate will get focus." - }, - "setLoop": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `loop`." - }, - "setModal": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `modal`." - }, - "setOrientation": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `orientation`." - }, - "setRTL": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `rtl`." - }, - "setShift": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `shift`." - }, - "setVisible": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `visible`." - }, - "setWrap": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `wrap`." - }, - "shift": { - "type": "boolean", - "defaultValue": false, - "required": true, - "externalProp": true, - "description": "**Has effect only on two-dimensional composites**. If enabled, moving up\nor down when there's no next item or the next item is disabled will shift\nto the item right before it." - }, - "show": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Changes the `visible` state to `true`" - }, - "sort": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sorts the `composite.items` based on the items position in the DOM. This\nis especially useful after modifying the composite items order in the DOM.\nMost of the time, though, you don't need to manually call this function as\nthe re-ordering happens automatically." - }, - "stopAnimation": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Stops animation. It's called automatically if there's a CSS transition." - }, - "toggle": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Toggles the `visible` state" - }, - "unregisterGroup": { - "type": "(id: string) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Unregisters a composite group." - }, - "unregisterItem": { - "type": "(id: string) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Unregisters a composite item." - }, - "unstable_arrowRef": { - "type": "RefObject", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "The arrow element." - }, - "unstable_arrowStyles": { - "type": "CSSProperties", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Arrow styles." - }, - "unstable_disclosureRef": { - "type": "MutableRefObject", - "defaultValue": null, - "required": true, - "externalProp": true - }, - "unstable_hasActiveWidget": { - "type": "boolean", - "defaultValue": false, - "required": true, - "externalProp": true - }, - "unstable_idCountRef": { - "type": "MutableRefObject", - "defaultValue": null, - "required": true, - "externalProp": true - }, - "unstable_includesBaseElement": { - "type": "boolean", - "defaultValue": false, - "required": true, - "externalProp": true - }, - "unstable_moves": { - "type": "number", - "defaultValue": "0", - "required": true, - "externalProp": true, - "description": "Stores the number of moves that have been performed by calling `move`,\n`next`, `previous`, `up`, `down`, `first` or `last`." - }, - "unstable_originalPlacement": { - "type": "Placement", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "`placement` passed to the hook." - }, - "unstable_popoverRef": { - "type": "RefObject", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "The popover element." - }, - "unstable_popoverStyles": { - "type": "CSSProperties", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Popover styles." - }, - "unstable_referenceRef": { - "type": "RefObject", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "The reference element." - }, - "unstable_setHasActiveWidget": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `hasActiveWidget`." - }, - "unstable_setIncludesBaseElement": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `includesBaseElement`." - }, - "unstable_setValue": { - "type": "(name: string, value?: any) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Updates checkboxes and radios values within the menu." - }, - "unstable_setVirtual": { - "type": "Dispatch>", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Sets `virtual`." - }, - "unstable_update": { - "type": "() => boolean", - "defaultValue": null, - "required": true, - "externalProp": true - }, - "unstable_values": { - "type": "Record", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Stores the values of radios and checkboxes within the menu." - }, - "unstable_virtual": { - "type": "boolean", - "defaultValue": false, - "required": true, - "externalProp": true, - "description": "If enabled, the composite element will act as an\n[aria-activedescendant](https://www.w3.org/TR/wai-aria-practices-1.1/#kbd_focus_activedescendant)\ncontainer instead of\n[roving tabindex](https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex).\nDOM focus will remain on the composite while its items receive virtual focus." - }, - "up": { - "type": "(unstable_allTheWay?: boolean | undefined) => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the item above." - }, - "visible": { - "type": "boolean", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Whether it's visible or not." - }, - "wrap": { - "type": "boolean | Orientation", - "defaultValue": false, - "required": true, - "externalProp": true, - "description": "**Has effect only on two-dimensional composites**. If enabled, moving to\nthe next item from the last one in a row or column will focus the first\nitem in the next row or column and vice-versa.\n - `true` wraps between rows and columns.\n - `horizontal` wraps only between rows.\n - `vertical` wraps only between columns.\n - If `loop` matches the value of `wrap`, it'll wrap between the last\nitem in the last row or column and the first item in the first row or\ncolumn and vice-versa." - }, - "currentId": { - "type": "string", - "defaultValue": "undefined", - "required": false, - "externalProp": true, - "description": "The current focused item `id`.\n - `undefined` will automatically focus the first enabled composite item.\n - `null` will focus the base composite element and users will be able to\nnavigate out of it using arrow keys.\n - If `currentId` is initially set to `null`, the base composite element\nitself will have focus and users will be able to navigate to it using\narrow keys." - }, - "orientation": { - "type": "Orientation", - "defaultValue": "undefined", + "AccountSwitcherStateReturn": {}, + "AccountSwitcherInitialState": {}, + "AccountSwitcherBadge": { + "element": { + "type": "any", + "defaultValue": "'ACCOUNT_SWITCHER_BADGE'", "required": false, - "externalProp": true, - "description": "Defines the orientation of the composite widget. If the composite has a\nsingle row or column (one-dimensional), the `orientation` value determines\nwhich arrow keys can be used to move focus:\n - `undefined`: all arrow keys work.\n - `horizontal`: only left and right arrow keys work.\n - `vertical`: only up and down arrow keys work.\n\nIt doesn't have any effect on two-dimensional composites." + "externalProp": false, + "description": "Overrides the default element name to apply unique styles with the Customization Provider" } }, - "AccountSwitcherInitialState": { - "animated": { - "type": "number | boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "If `true`, `animating` will be set to `true` when `visible` is updated.\nIt'll wait for `stopAnimation` to be called or a CSS transition ends.\nIf `animated` is set to a `number`, `stopAnimation` will be called only\nafter the same number of milliseconds have passed." - }, - "baseId": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "ID that will serve as a base for all the items IDs." - }, - "currentId": { - "type": "string", - "defaultValue": "undefined", - "required": false, - "externalProp": true, - "description": "The current focused item `id`.\n - `undefined` will automatically focus the first enabled composite item.\n - `null` will focus the base composite element and users will be able to\nnavigate out of it using arrow keys.\n - If `currentId` is initially set to `null`, the base composite element\nitself will have focus and users will be able to navigate to it using\narrow keys." - }, - "gutter": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Offset between the reference and the popover on the main axis. Should not be combined with `unstable_offset`." - }, - "loop": { - "type": "boolean | Orientation", - "defaultValue": false, - "required": false, - "externalProp": true, - "description": "On one-dimensional composites:\n - `true` loops from the last item to the first item and vice-versa.\n - `horizontal` loops only if `orientation` is `horizontal` or not set.\n - `vertical` loops only if `orientation` is `vertical` or not set.\n - If `currentId` is initially set to `null`, the composite element will\nbe focused in between the last and first items.\n\nOn two-dimensional composites:\n - `true` loops from the last row/column item to the first item in the\nsame row/column and vice-versa. If it's the last item in the last row, it\nmoves to the first item in the first row and vice-versa.\n - `horizontal` loops only from the last row item to the first item in\nthe same row.\n - `vertical` loops only from the last column item to the first item in\nthe column row.\n - If `currentId` is initially set to `null`, vertical loop will have no\neffect as moving down from the last row or up from the first row will\nfocus the composite element.\n - If `wrap` matches the value of `loop`, it'll wrap between the last\nitem in the last row or column and the first item in the first row or\ncolumn and vice-versa." - }, - "modal": { - "type": "boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Toggles Dialog's `modal` state.\n - Non-modal: `preventBodyScroll` doesn't work and focus is free.\n - Modal: `preventBodyScroll` is automatically enabled, focus is\ntrapped within the dialog and the dialog is rendered within a `Portal`\nby default." - }, - "orientation": { - "type": "Orientation", - "defaultValue": "undefined", - "required": false, - "externalProp": true, - "description": "Defines the orientation of the composite widget. If the composite has a\nsingle row or column (one-dimensional), the `orientation` value determines\nwhich arrow keys can be used to move focus:\n - `undefined`: all arrow keys work.\n - `horizontal`: only left and right arrow keys work.\n - `vertical`: only up and down arrow keys work.\n\nIt doesn't have any effect on two-dimensional composites." - }, - "placement": { - "type": "Placement", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Actual `placement`." - }, - "rtl": { - "type": "boolean", - "defaultValue": false, - "required": false, - "externalProp": true, - "description": "Determines how `next` and `previous` functions will behave. If `rtl` is\nset to `true`, they will be inverted. This only affects the composite\nwidget behavior. You still need to set `dir=\"rtl\"` on HTML/CSS." - }, - "shift": { - "type": "boolean", - "defaultValue": false, - "required": false, - "externalProp": true, - "description": "**Has effect only on two-dimensional composites**. If enabled, moving up\nor down when there's no next item or the next item is disabled will shift\nto the item right before it." - }, - "unstable_fixed": { - "type": "boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Whether or not the popover should have `position` set to `fixed`." - }, - "unstable_flip": { - "type": "boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Flip the popover's placement when it starts to overlap its reference\nelement." - }, - "unstable_includesBaseElement": { - "type": "boolean", - "defaultValue": false, - "required": false, - "externalProp": true - }, - "unstable_offset": { - "type": "[string | number, string | number]", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Offset between the reference and the popover: [main axis, alt axis]. Should not be combined with `gutter`." - }, - "unstable_preventOverflow": { - "type": "boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Prevents popover from being positioned outside the boundary." - }, - "unstable_values": { - "type": "Record", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Stores the values of radios and checkboxes within the menu." - }, - "unstable_virtual": { - "type": "boolean", - "defaultValue": false, - "required": false, - "externalProp": true, - "description": "If enabled, the composite element will act as an\n[aria-activedescendant](https://www.w3.org/TR/wai-aria-practices-1.1/#kbd_focus_activedescendant)\ncontainer instead of\n[roving tabindex](https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex).\nDOM focus will remain on the composite while its items receive virtual focus." - }, - "visible": { - "type": "boolean", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Whether it's visible or not." - }, - "wrap": { - "type": "boolean | Orientation", - "defaultValue": false, + "AccountSwitcher": { + "element": { + "type": "any", + "defaultValue": "'ACCOUNT_SWITCHER'", "required": false, - "externalProp": true, - "description": "**Has effect only on two-dimensional composites**. If enabled, moving to\nthe next item from the last one in a row or column will focus the first\nitem in the next row or column and vice-versa.\n - `true` wraps between rows and columns.\n - `horizontal` wraps only between rows.\n - `vertical` wraps only between columns.\n - If `loop` matches the value of `wrap`, it'll wrap between the last\nitem in the last row or column and the first item in the first row or\ncolumn and vice-versa." + "externalProp": false, + "description": "Overrides the default element name to apply unique styles with the Customization Provider" } }, - "AccountSwitcherBadge": { - "baseId": { - "type": "string", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "ID that will serve as a base for all the items IDs." - }, - "first": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the first item." - }, - "i18nButtonLabel": { - "type": "string", - "defaultValue": null, - "required": true, - "externalProp": false, - "description": "Accessible label for the button that opens the menu" - }, - "last": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Moves focus to the last item." - }, - "placement": { - "type": "Placement", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Actual `placement`." - }, - "show": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Changes the `visible` state to `true`" - }, - "toggle": { - "type": "() => void", - "defaultValue": null, - "required": true, - "externalProp": true, - "description": "Toggles the `visible` state" - }, - "about": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true - }, - "accessKey": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true - }, - "aria-activedescendant": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application." - }, - "aria-atomic": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute." - }, - "aria-autocomplete": { - "type": "\"list\" | \"none\" | \"inline\" | \"both\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be\npresented if they are made." - }, - "aria-busy": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user." - }, - "aria-checked": { - "type": "boolean | \"true\" | \"false\" | \"mixed\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the current \"checked\" state of checkboxes, radio buttons, and other widgets." - }, - "aria-colcount": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the total number of columns in a table, grid, or treegrid." - }, - "aria-colindex": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid." - }, - "aria-colspan": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid." - }, - "aria-controls": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the element (or elements) whose contents or presence are controlled by the current element." - }, - "aria-current": { - "type": "| boolean\n | \"time\"\n | \"true\"\n | \"false\"\n | \"page\"\n | \"step\"\n | \"location\"\n | \"date\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the element that represents the current item within a container or set of related elements." - }, - "aria-describedby": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the element (or elements) that describes the object." - }, - "aria-details": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the element that provides a detailed, extended description for the object." - }, - "aria-disabled": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable." - }, - "aria-dropeffect": { - "type": "\"move\" | \"link\" | \"none\" | \"copy\" | \"execute\" | \"popup\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates what functions can be performed when a dragged object is released on the drop target." - }, - "aria-errormessage": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the element that provides an error message for the object." - }, - "aria-expanded": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed." - }, - "aria-flowto": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,\nallows assistive technology to override the general default of reading in document source order." - }, - "aria-grabbed": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates an element's \"grabbed\" state in a drag-and-drop operation." - }, - "aria-haspopup": { - "type": "| boolean\n | \"dialog\"\n | \"menu\"\n | \"true\"\n | \"false\"\n | \"grid\"\n | \"listbox\"\n | \"tree\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element." - }, - "aria-hidden": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether the element is exposed to an accessibility API." - }, - "aria-invalid": { - "type": "boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the entered value does not conform to the format expected by the application." - }, - "aria-keyshortcuts": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element." - }, - "aria-label": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines a string value that labels the current element." - }, - "aria-labelledby": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies the element (or elements) that labels the current element." - }, - "aria-level": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the hierarchical level of an element within a structure." - }, - "aria-live": { - "type": "\"off\" | \"assertive\" | \"polite\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region." - }, - "aria-modal": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether an element is modal when displayed." - }, - "aria-multiline": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether a text box accepts multiple lines of input or only a single line." - }, - "aria-multiselectable": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates that the user may select more than one item from the current selectable descendants." - }, - "aria-orientation": { - "type": "\"horizontal\" | \"vertical\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous." - }, - "aria-owns": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship\nbetween DOM elements where the DOM hierarchy cannot be used to represent the relationship." - }, - "aria-placeholder": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.\nA hint could be a sample value or a brief description of the expected format." - }, - "aria-posinset": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM." - }, - "aria-pressed": { - "type": "boolean | \"true\" | \"false\" | \"mixed\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the current \"pressed\" state of toggle buttons." - }, - "aria-readonly": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates that the element is not editable, but is otherwise operable." - }, - "aria-relevant": { - "type": "| \"text\"\n | \"additions\"\n | \"additions removals\"\n | \"additions text\"\n | \"all\"\n | \"removals\"\n | \"removals additions\"\n | \"removals text\"\n | \"text additions\"\n | \"text removals\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified." - }, - "aria-required": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates that user input is required on the element before a form may be submitted." - }, - "aria-roledescription": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines a human-readable, author-localized description for the role of an element." - }, - "aria-rowcount": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the total number of rows in a table, grid, or treegrid." - }, - "aria-rowindex": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid." - }, - "aria-rowspan": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid." - }, - "aria-selected": { - "type": "Booleanish", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates the current \"selected\" state of various widgets." - }, - "aria-setsize": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM." - }, - "aria-sort": { - "type": "\"none\" | \"ascending\" | \"descending\" | \"other\"", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Indicates if items in a table or grid are sorted in ascending or descending order." - }, - "aria-valuemax": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the maximum allowed value for a range widget." - }, - "aria-valuemin": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the minimum allowed value for a range widget." - }, - "aria-valuenow": { - "type": "number", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the current value for a range widget." - }, - "aria-valuetext": { - "type": "string", - "defaultValue": null, - "required": false, - "externalProp": true, - "description": "Defines the human readable text alternative of aria-valuenow for a range widget." - }, - "as": { - "type": "keyof IntrinsicElements", - "defaultValue": "'button'", - "required": false, - "externalProp": false, - "description": "The HTML tag to replace the default ` -