From bb893822d9f1fbea00ebe97a0cb463a4392e369f Mon Sep 17 00:00:00 2001
From: Nora Krantz <75342690+nkrantz@users.noreply.github.com>
Date: Wed, 22 May 2024 15:44:41 -0300
Subject: [PATCH] feat(side-panel): create package (#3827)
---
.changeset/olive-swans-think.md | 6 +
.changeset/seven-steaks-relate.md | 5 +
.codesandbox/ci.json | 1 +
.../paste-codemods/tools/.cache/mappings.json | 9 +
.../side-panel/__tests__/index.spec.tsx | 107 +
.../paste-core/components/side-panel/build.js | 3 +
.../components/side-panel/package.json | 75 +
.../components/side-panel/src/SidePanel.tsx | 123 +
.../side-panel/src/SidePanelBadgeButton.tsx | 43 +
.../side-panel/src/SidePanelBody.tsx | 59 +
.../side-panel/src/SidePanelButton.tsx | 29 +
.../side-panel/src/SidePanelContainer.tsx | 37 +
.../side-panel/src/SidePanelContext.tsx | 5 +
.../side-panel/src/SidePanelHeader.tsx | 78 +
.../side-panel/src/SidePanelHeaderActions.tsx | 26 +
.../src/SidePanelPushContentWrapper.tsx | 47 +
.../components/side-panel/src/index.tsx | 19 +
.../components/side-panel/src/types.ts | 152 +
.../components/MessagingInsightsContent.tsx | 163 +
.../components/SidePanelWithContent.tsx | 89 +
.../stories/components/SidebarWithContent.tsx | 46 +
.../side-panel/stories/index.stories.tsx | 223 +
.../components/side-panel/tsconfig.json | 12 +
.../components/side-panel/type-docs.json | 12926 ++++++++++++++++
packages/paste-core/core-bundle/.gitignore | 1 +
packages/paste-core/core-bundle/package.json | 1 +
packages/paste-core/core-bundle/src/index.tsx | 1 +
.../paste-core/core-bundle/src/side-panel.tsx | 1 +
yarn.lock | 53 +
29 files changed, 14340 insertions(+)
create mode 100644 .changeset/olive-swans-think.md
create mode 100644 .changeset/seven-steaks-relate.md
create mode 100644 packages/paste-core/components/side-panel/__tests__/index.spec.tsx
create mode 100644 packages/paste-core/components/side-panel/build.js
create mode 100644 packages/paste-core/components/side-panel/package.json
create mode 100644 packages/paste-core/components/side-panel/src/SidePanel.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelBadgeButton.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelBody.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelButton.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelContainer.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelContext.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelHeader.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelHeaderActions.tsx
create mode 100644 packages/paste-core/components/side-panel/src/SidePanelPushContentWrapper.tsx
create mode 100644 packages/paste-core/components/side-panel/src/index.tsx
create mode 100644 packages/paste-core/components/side-panel/src/types.ts
create mode 100644 packages/paste-core/components/side-panel/stories/components/MessagingInsightsContent.tsx
create mode 100644 packages/paste-core/components/side-panel/stories/components/SidePanelWithContent.tsx
create mode 100644 packages/paste-core/components/side-panel/stories/components/SidebarWithContent.tsx
create mode 100644 packages/paste-core/components/side-panel/stories/index.stories.tsx
create mode 100644 packages/paste-core/components/side-panel/tsconfig.json
create mode 100644 packages/paste-core/components/side-panel/type-docs.json
create mode 100644 packages/paste-core/core-bundle/src/side-panel.tsx
diff --git a/.changeset/olive-swans-think.md b/.changeset/olive-swans-think.md
new file mode 100644
index 0000000000..df10d9a3e6
--- /dev/null
+++ b/.changeset/olive-swans-think.md
@@ -0,0 +1,6 @@
+---
+"@twilio-paste/side-panel": major
+"@twilio-paste/core": minor
+---
+
+[Side Panel] add new Side Panel component. Side panel is a container that pushes the main page content when open.
diff --git a/.changeset/seven-steaks-relate.md b/.changeset/seven-steaks-relate.md
new file mode 100644
index 0000000000..8f180b6a81
--- /dev/null
+++ b/.changeset/seven-steaks-relate.md
@@ -0,0 +1,5 @@
+---
+"@twilio-paste/codemods": minor
+---
+
+[codemods] add new package: Side Panel
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
index 7c6c6bc585..60e2907c9f 100644
--- a/.codesandbox/ci.json
+++ b/.codesandbox/ci.json
@@ -83,6 +83,7 @@
"/packages/paste-core/components/separator",
"/packages/paste-core/primitives/sibling-box",
"/packages/paste-core/components/side-modal",
+ "/packages/paste-core/components/side-panel",
"/packages/paste-core/components/sidebar",
"/packages/paste-core/components/skeleton-loader",
"/packages/paste-core/components/slider",
diff --git a/packages/paste-codemods/tools/.cache/mappings.json b/packages/paste-codemods/tools/.cache/mappings.json
index 395930baac..4f44b5ffb3 100644
--- a/packages/paste-codemods/tools/.cache/mappings.json
+++ b/packages/paste-codemods/tools/.cache/mappings.json
@@ -225,6 +225,15 @@
"SideModalHeader": "@twilio-paste/core/side-modal",
"SideModalHeading": "@twilio-paste/core/side-modal",
"useSideModalState": "@twilio-paste/core/side-modal",
+ "SidePanel": "@twilio-paste/core/side-panel",
+ "SidePanelBadgeButton": "@twilio-paste/core/side-panel",
+ "SidePanelBody": "@twilio-paste/core/side-panel",
+ "SidePanelButton": "@twilio-paste/core/side-panel",
+ "SidePanelContainer": "@twilio-paste/core/side-panel",
+ "SidePanelContext": "@twilio-paste/core/side-panel",
+ "SidePanelHeader": "@twilio-paste/core/side-panel",
+ "SidePanelHeaderActions": "@twilio-paste/core/side-panel",
+ "SidePanelPushContentWrapper": "@twilio-paste/core/side-panel",
"Sidebar": "@twilio-paste/core/sidebar",
"SidebarBetaBadge": "@twilio-paste/core/sidebar",
"SidebarBody": "@twilio-paste/core/sidebar",
diff --git a/packages/paste-core/components/side-panel/__tests__/index.spec.tsx b/packages/paste-core/components/side-panel/__tests__/index.spec.tsx
new file mode 100644
index 0000000000..933f51c43f
--- /dev/null
+++ b/packages/paste-core/components/side-panel/__tests__/index.spec.tsx
@@ -0,0 +1,107 @@
+import { act, render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import { Button } from "@twilio-paste/button";
+import { Theme } from "@twilio-paste/theme";
+import * as React from "react";
+
+import {
+ SidePanel,
+ SidePanelBody,
+ SidePanelContainer,
+ SidePanelHeader,
+ SidePanelHeaderActions,
+ SidePanelPushContentWrapper,
+} from "../src";
+
+const MockSidePanel = ({ element = "SIDE_PANEL" }: { element?: string }): JSX.Element => {
+ const [isOpen, setIsOpen] = React.useState(true);
+ return (
+
+
+
+
+ Heading
+
+
+
+
+ Body
+
+
+ Page content
+
+
+
+ );
+};
+
+describe("SidePanel", () => {
+ beforeEach(() => {
+ render();
+ });
+ it("should render", () => {
+ expect(screen.getByRole("dialog")).toBeDefined();
+ });
+ it("should be removed from the DOM when isOpen=false", async () => {
+ const closeButton = screen
+ .getByRole("dialog")
+ .querySelector('[data-paste-element="SIDE_PANEL_HEADER_CLOSE_BUTTON"]');
+ if (closeButton) await userEvent.click(closeButton);
+ // r-t-l act() necessary for testing with react 17
+ await act(async () => {
+ await new Promise((resolve) => setTimeout(resolve, 1000));
+ });
+ expect(screen.queryByRole("dialog")).toBeNull(); // queryByRole returns null if no element is found whereas getByRole throws an error
+ });
+ it("should have an id", () => {
+ expect(screen.getByRole("dialog").getAttribute("id")).toEqual("side-panel-id");
+ });
+ it("should have an aria label", () => {
+ expect(screen.getByLabelText("my side panel")).toBeInTheDocument();
+ });
+});
+
+describe("Customization", () => {
+ it("should set default element values", () => {
+ render();
+ const sidePanelWrapper = screen.getByTestId("wrapper");
+ const sidePanel = screen.getByRole("dialog");
+ expect(sidePanelWrapper.querySelector('[data-paste-element="SIDE_PANEL_CONTAINER"]')).toBeInTheDocument();
+ expect(
+ sidePanelWrapper.querySelector('[data-paste-element="SIDE_PANEL_PUSH_CONTENT_WRAPPER"]'),
+ ).toBeInTheDocument();
+ expect(sidePanel.getAttribute("data-paste-element")).toEqual("SIDE_PANEL");
+ expect(sidePanel.querySelector('[data-paste-element="ANIMATED_SIDE_PANEL_WRAPPER"]')).toBeInTheDocument();
+ expect(sidePanel.querySelector('[data-paste-element="INNER_SIDE_PANEL"]')).toBeInTheDocument();
+ expect(screen.getByText("Heading").getAttribute("data-paste-element")).toBe("SIDE_PANEL_HEADER");
+ expect(screen.getByText("...").parentElement?.parentElement?.getAttribute("data-paste-element")).toBe(
+ "SIDE_PANEL_HEADER_ACTIONS",
+ );
+ expect(screen.getByText("Body").getAttribute("data-paste-element")).toBe("SIDE_PANEL_BODY");
+ expect(screen.getByText("Page content").getAttribute("data-paste-element")).toBe("SIDE_PANEL_PUSH_CONTENT_WRAPPER");
+ });
+
+ it("should set custom element values", () => {
+ render();
+ const sidePanelWrapper = screen.getByTestId("wrapper");
+ const sidePanel = screen.getByRole("dialog");
+ expect(sidePanelWrapper.querySelector('[data-paste-element="FTP_CONTAINER"]')).toBeInTheDocument();
+ expect(sidePanelWrapper.querySelector('[data-paste-element="FTP_PUSH_CONTENT_WRAPPER"]')).toBeInTheDocument();
+ expect(sidePanel.getAttribute("data-paste-element")).toEqual("FTP");
+ expect(sidePanel.querySelector('[data-paste-element="ANIMATED_FTP_WRAPPER"]')).toBeInTheDocument();
+ expect(sidePanel.querySelector('[data-paste-element="INNER_FTP"]')).toBeInTheDocument();
+ expect(screen.getByText("Heading").getAttribute("data-paste-element")).toBe("FTP_HEADER");
+ expect(screen.getByText("...").parentElement?.parentElement?.getAttribute("data-paste-element")).toBe(
+ "FTP_HEADER_ACTIONS",
+ );
+ expect(screen.getByText("Body").getAttribute("data-paste-element")).toBe("FTP_BODY");
+ expect(screen.getByText("Page content").getAttribute("data-paste-element")).toBe("FTP_PUSH_CONTENT_WRAPPER");
+ });
+});
diff --git a/packages/paste-core/components/side-panel/build.js b/packages/paste-core/components/side-panel/build.js
new file mode 100644
index 0000000000..27dd98f98e
--- /dev/null
+++ b/packages/paste-core/components/side-panel/build.js
@@ -0,0 +1,3 @@
+const { build } = require("../../../../tools/build/esbuild");
+
+build(require("./package.json"));
diff --git a/packages/paste-core/components/side-panel/package.json b/packages/paste-core/components/side-panel/package.json
new file mode 100644
index 0000000000..02d85b7645
--- /dev/null
+++ b/packages/paste-core/components/side-panel/package.json
@@ -0,0 +1,75 @@
+{
+ "name": "@twilio-paste/side-panel",
+ "version": "0.0.0",
+ "category": "layout",
+ "status": "production",
+ "description": "Side Panel is a container that pushes the main page content when open.",
+ "author": "Twilio Inc.",
+ "license": "MIT",
+ "main:dev": "src/index.tsx",
+ "main": "dist/index.js",
+ "module": "dist/index.es.js",
+ "types": "dist/index.d.ts",
+ "sideEffects": false,
+ "publishConfig": {
+ "access": "public"
+ },
+ "files": [
+ "dist"
+ ],
+ "scripts": {
+ "build": "yarn clean && NODE_ENV=production node build.js && tsc",
+ "build:js": "NODE_ENV=development node build.js",
+ "build:typedocs": "tsx ../../../../tools/build/generate-type-docs",
+ "clean": "rm -rf ./dist",
+ "tsc": "tsc"
+ },
+ "peerDependencies": {
+ "@twilio-paste/anchor": "^12.1.0",
+ "@twilio-paste/animation-library": "^2.0.0",
+ "@twilio-paste/badge": "^8.2.0",
+ "@twilio-paste/box": "^10.2.0",
+ "@twilio-paste/button": "^14.1.0",
+ "@twilio-paste/color-contrast-utils": "^5.0.0",
+ "@twilio-paste/customization": "^8.1.1",
+ "@twilio-paste/design-tokens": "^10.3.0",
+ "@twilio-paste/icons": "^12.4.0",
+ "@twilio-paste/spinner": "^14.1.2",
+ "@twilio-paste/stack": "^8.1.0",
+ "@twilio-paste/style-props": "^9.1.1",
+ "@twilio-paste/styling-library": "^3.0.0",
+ "@twilio-paste/theme": "^11.0.1",
+ "@twilio-paste/types": "^6.0.0",
+ "@twilio-paste/uid-library": "^2.0.0",
+ "@twilio-paste/utils": "^5.0.0",
+ "@types/react": "^16.8.6 || ^17.0.2 || ^18.0.27",
+ "@types/react-dom": "^16.8.6 || ^17.0.2 || ^18.0.10",
+ "react": "^16.8.6 || ^17.0.2 || ^18.0.0",
+ "react-dom": "^16.8.6 || ^17.0.2 || ^18.0.0"
+ },
+ "devDependencies": {
+ "@twilio-paste/anchor": "^12.1.0",
+ "@twilio-paste/animation-library": "^2.0.0",
+ "@twilio-paste/badge": "^8.2.0",
+ "@twilio-paste/box": "^10.2.0",
+ "@twilio-paste/button": "^14.1.0",
+ "@twilio-paste/color-contrast-utils": "^5.0.0",
+ "@twilio-paste/customization": "^8.1.1",
+ "@twilio-paste/design-tokens": "^10.3.0",
+ "@twilio-paste/icons": "^12.4.0",
+ "@twilio-paste/spinner": "^14.1.2",
+ "@twilio-paste/stack": "^8.1.0",
+ "@twilio-paste/style-props": "^9.1.1",
+ "@twilio-paste/styling-library": "^3.0.0",
+ "@twilio-paste/theme": "^11.0.1",
+ "@twilio-paste/types": "^6.0.0",
+ "@twilio-paste/uid-library": "^2.0.0",
+ "@twilio-paste/utils": "^5.0.0",
+ "@types/react": "^18.0.27",
+ "@types/react-dom": "^18.0.10",
+ "react": "^18.0.0",
+ "react-dom": "^18.0.0",
+ "tsx": "^4.0.0",
+ "typescript": "^4.9.4"
+ }
+}
diff --git a/packages/paste-core/components/side-panel/src/SidePanel.tsx b/packages/paste-core/components/side-panel/src/SidePanel.tsx
new file mode 100644
index 0000000000..6d33b5aed9
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanel.tsx
@@ -0,0 +1,123 @@
+import { animated, useTransition } from "@twilio-paste/animation-library";
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import type { BoxProps } from "@twilio-paste/box";
+import { useMergeRefs, useWindowSize } from "@twilio-paste/utils";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { SidePanelProps } from "./types";
+
+const StyledSidePanelWrapper = React.forwardRef((props, ref) => (
+
+));
+
+StyledSidePanelWrapper.displayName = "StyledSidePanelWrapper";
+const AnimatedStyledSidePanelWrapper = animated(StyledSidePanelWrapper);
+
+const config = {
+ mass: 0.3,
+ tension: 288,
+ friction: 20,
+};
+
+const transitionStyles = {
+ from: { opacity: 0, transform: "translateX(100%)" },
+ enter: { opacity: 1, transform: "translateX(0%)" },
+ leave: { opacity: 0, transform: "translateX(100%)" },
+ config,
+};
+
+const mobileTransitionStyles = {
+ from: { opacity: 0, transform: "translateY(100%)" },
+ enter: { opacity: 1, transform: "translateY(0%)" },
+ leave: { opacity: 0, transform: "translateY(100%)" },
+ config,
+};
+
+const SidePanel = React.forwardRef(
+ ({ element = "SIDE_PANEL", label, children, ...props }, ref) => {
+ const { sidePanelId, isOpen } = React.useContext(SidePanelContext);
+
+ const { breakpointIndex } = useWindowSize();
+
+ const transitions =
+ breakpointIndex === 0 ? useTransition(isOpen, mobileTransitionStyles) : useTransition(isOpen, transitionStyles);
+
+ const screenSize = window.innerHeight;
+
+ const sidePanelRef = React.useRef(null);
+ const mergedSidePanelRef = useMergeRefs(sidePanelRef, ref) as React.RefObject;
+
+ const [offsetY, setOffsetY] = React.useState(0);
+
+ // Get the offset of the side panel from the top of the viewport
+ React.useEffect(() => {
+ const boundingClientRect = sidePanelRef?.current?.getBoundingClientRect();
+ setOffsetY(boundingClientRect?.y || 0);
+ }, []);
+
+ return (
+ <>
+ {transitions(
+ (styles, item) =>
+ item && (
+
+
+
+ {children}
+
+
+
+ ),
+ )}
+ >
+ );
+ },
+);
+
+SidePanel.displayName = "SidePanel";
+
+export { SidePanel };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelBadgeButton.tsx b/packages/paste-core/components/side-panel/src/SidePanelBadgeButton.tsx
new file mode 100644
index 0000000000..bb1fcea308
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelBadgeButton.tsx
@@ -0,0 +1,43 @@
+import { Badge } from "@twilio-paste/badge";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { ButtonBadgeProps, SidePanelBadgeButtonProps } from "./types";
+
+const ButtonBadge = React.forwardRef(function ButtonBadge(
+ { children, ...props },
+ ref,
+) {
+ return (
+
+ {children}
+
+ );
+});
+
+ButtonBadge.displayName = "ButtonBadge";
+
+const SidePanelBadgeButton = React.forwardRef(
+ ({ children, element = "SIDE_PANEL_BADGE", ...sidePanelButtonProps }, ref) => {
+ const { i18nCloseSidePanelTitle, i18nOpenSidePanelTitle, isOpen, setIsOpen, sidePanelId } =
+ React.useContext(SidePanelContext);
+
+ return (
+ setIsOpen(!isOpen)}
+ aria-expanded={isOpen}
+ aria-controls={sidePanelId}
+ ref={ref}
+ >
+ {children}
+
+ );
+ },
+);
+
+SidePanelBadgeButton.displayName = "SidePanelBadgeButton";
+export { SidePanelBadgeButton };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelBody.tsx b/packages/paste-core/components/side-panel/src/SidePanelBody.tsx
new file mode 100644
index 0000000000..08003dc977
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelBody.tsx
@@ -0,0 +1,59 @@
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import { css, styled } from "@twilio-paste/styling-library";
+import type { ThemeShape } from "@twilio-paste/theme";
+import * as React from "react";
+
+import type { SidePanelBodyProps } from "./types";
+
+// This wrapper applies styles that customize the scrollbar and its track
+const SidePanelBodyWrapper = styled.div(({ theme }: { theme: ThemeShape }) => {
+ const { colorBackgroundBody, colorBackground, colorBackgroundStrong } = theme.backgroundColors;
+
+ return css({
+ // Scrollbar
+ "::-webkit-scrollbar": {
+ width: "6px",
+ },
+ // Track
+ "::-webkit-scrollbar-track": {
+ marginTop: "8px",
+ background: colorBackgroundBody,
+ borderRadius: "10px",
+ },
+ // Handle
+ "::-webkit-scrollbar-thumb": {
+ background: colorBackground,
+ borderRadius: "10px",
+ },
+ // Handle on hover
+ "::-webkit-scrollbar-thumb:hover": {
+ background: colorBackgroundStrong,
+ },
+ });
+});
+
+const SidePanelBody = React.forwardRef(
+ ({ element = "SIDE_PANEL_BODY", children, ...props }, ref) => {
+ return (
+
+ {children}
+
+ );
+ },
+);
+
+SidePanelBody.displayName = "SidePanelBody";
+
+export { SidePanelBody };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelButton.tsx b/packages/paste-core/components/side-panel/src/SidePanelButton.tsx
new file mode 100644
index 0000000000..73e9d5fc08
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelButton.tsx
@@ -0,0 +1,29 @@
+import { Button } from "@twilio-paste/button";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { SidePanelButtonProps } from "./types";
+
+const SidePanelButton = React.forwardRef(
+ ({ children, element = "SIDE_PANEL_BUTTON", ...sidePanelButtonProps }, ref) => {
+ const { i18nCloseSidePanelTitle, i18nOpenSidePanelTitle, isOpen, setIsOpen, sidePanelId } =
+ React.useContext(SidePanelContext);
+
+ return (
+
+ );
+ },
+);
+
+SidePanelButton.displayName = "SidePanelButton";
+export { SidePanelButton };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelContainer.tsx b/packages/paste-core/components/side-panel/src/SidePanelContainer.tsx
new file mode 100644
index 0000000000..bc52f17d3a
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelContainer.tsx
@@ -0,0 +1,37 @@
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import { useUID } from "@twilio-paste/uid-library";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { SidePanelContainerProps } from "./types";
+
+const SidePanelContainer = React.forwardRef(
+ (
+ {
+ element = "SIDE_PANEL_CONTAINER",
+ children,
+ sidePanelId,
+ isOpen,
+ setIsOpen,
+ i18nCloseSidePanelTitle = "close the side panel",
+ i18nOpenSidePanelTitle = "open the side panel",
+ ...props
+ },
+ ref,
+ ) => {
+ if (sidePanelId === undefined) sidePanelId = useUID();
+ return (
+
+
+ {children}
+
+
+ );
+ },
+);
+
+SidePanelContainer.displayName = "SidePanelContainer";
+
+export { SidePanelContainer };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelContext.tsx b/packages/paste-core/components/side-panel/src/SidePanelContext.tsx
new file mode 100644
index 0000000000..19b2a850f8
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelContext.tsx
@@ -0,0 +1,5 @@
+import * as React from "react";
+
+import type { SidePanelContextProps } from "./types";
+
+export const SidePanelContext = React.createContext({} as any);
diff --git a/packages/paste-core/components/side-panel/src/SidePanelHeader.tsx b/packages/paste-core/components/side-panel/src/SidePanelHeader.tsx
new file mode 100644
index 0000000000..1f19ed7bee
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelHeader.tsx
@@ -0,0 +1,78 @@
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import { Button } from "@twilio-paste/button";
+import { CloseIcon } from "@twilio-paste/icons/esm/CloseIcon";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { SidePanelHeaderProps } from "./types";
+
+type SidePanelCloseButtonProps = {
+ setIsOpen: React.Dispatch>;
+ i18nCloseSidePanelTitle: string;
+ sidePanelId: string;
+ isOpen: boolean;
+ element: string;
+};
+
+const SidePanelCloseButton: React.FC> = ({
+ setIsOpen,
+ i18nCloseSidePanelTitle,
+ sidePanelId,
+ isOpen,
+ element,
+}) => {
+ const internalButtonRef = React.useRef(null);
+
+ React.useEffect(() => {
+ internalButtonRef.current?.focus({ preventScroll: true });
+ }, []);
+
+ return (
+
+ );
+};
+SidePanelCloseButton.displayName = "SidePanelCloseButton";
+
+const SidePanelHeader = React.forwardRef(
+ ({ element = "SIDE_PANEL_HEADER", children, ...props }, ref) => {
+ const { sidePanelId, isOpen, setIsOpen, i18nCloseSidePanelTitle } = React.useContext(SidePanelContext);
+ return (
+
+ {children}
+
+
+ );
+ },
+);
+
+SidePanelHeader.displayName = "SidePanelHeader";
+
+export { SidePanelHeader };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelHeaderActions.tsx b/packages/paste-core/components/side-panel/src/SidePanelHeaderActions.tsx
new file mode 100644
index 0000000000..c6dd27202b
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelHeaderActions.tsx
@@ -0,0 +1,26 @@
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import * as React from "react";
+
+import type { SidePanelHeaderActionsProps } from "./types";
+
+const SidePanelHeaderActions = React.forwardRef(
+ ({ element = "SIDE_PANEL_HEADER_ACTIONS", children, ...props }, ref) => {
+ return (
+
+ {children}
+
+ );
+ },
+);
+
+SidePanelHeaderActions.displayName = "SidePanelHeaderActions";
+
+export { SidePanelHeaderActions };
diff --git a/packages/paste-core/components/side-panel/src/SidePanelPushContentWrapper.tsx b/packages/paste-core/components/side-panel/src/SidePanelPushContentWrapper.tsx
new file mode 100644
index 0000000000..a1d5da4220
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/SidePanelPushContentWrapper.tsx
@@ -0,0 +1,47 @@
+import { animated, useSpring } from "@twilio-paste/animation-library";
+import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
+import type { BoxProps } from "@twilio-paste/box";
+import { useTheme } from "@twilio-paste/theme";
+import { useWindowSize } from "@twilio-paste/utils";
+import * as React from "react";
+
+import { SidePanelContext } from "./SidePanelContext";
+import type { SidePanelPushContentWrapperProps } from "./types";
+
+const StyledContentWrapper = React.forwardRef((props, ref) => (
+
+));
+StyledContentWrapper.displayName = "StyledContentWrapper";
+const AnimatedStyledContentWrapper = animated(StyledContentWrapper);
+
+export const SidePanelPushContentWrapper = React.forwardRef(
+ ({ element = "SIDE_PANEL_PUSH_CONTENT_WRAPPER", children, ...props }, ref) => {
+ const { isOpen } = React.useContext(SidePanelContext);
+ const theme = useTheme();
+ const { breakpointIndex } = useWindowSize();
+
+ const styles = useSpring({
+ marginRight: isOpen ? theme.sizes.size40 : "0rem",
+ config: {
+ mass: 0.3,
+ tension: 288,
+ friction: 20,
+ },
+ });
+
+ return (
+
+ {children}
+
+ );
+ },
+);
+SidePanelPushContentWrapper.displayName = "SidePanelPushContentWrapper";
diff --git a/packages/paste-core/components/side-panel/src/index.tsx b/packages/paste-core/components/side-panel/src/index.tsx
new file mode 100644
index 0000000000..c9b4e3e9bc
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/index.tsx
@@ -0,0 +1,19 @@
+export { SidePanel } from "./SidePanel";
+export { SidePanelPushContentWrapper } from "./SidePanelPushContentWrapper";
+export { SidePanelHeader } from "./SidePanelHeader";
+export { SidePanelHeaderActions } from "./SidePanelHeaderActions";
+export { SidePanelBody } from "./SidePanelBody";
+export { SidePanelContainer } from "./SidePanelContainer";
+export { SidePanelButton } from "./SidePanelButton";
+export { SidePanelBadgeButton } from "./SidePanelBadgeButton";
+export type {
+ SidePanelButtonProps,
+ SidePanelBadgeButtonProps,
+ SidePanelProps,
+ SidePanelPushContentWrapperProps,
+ SidePanelHeaderProps,
+ SidePanelHeaderActionsProps,
+ SidePanelContainerProps,
+ SidePanelBodyProps,
+} from "./types";
+export { SidePanelContext } from "./SidePanelContext";
diff --git a/packages/paste-core/components/side-panel/src/types.ts b/packages/paste-core/components/side-panel/src/types.ts
new file mode 100644
index 0000000000..52051d91ca
--- /dev/null
+++ b/packages/paste-core/components/side-panel/src/types.ts
@@ -0,0 +1,152 @@
+import type { BadgeBaseProps, BadgeButtonProps } from "@twilio-paste/badge";
+import type { BoxProps } from "@twilio-paste/box";
+import type { ButtonProps } from "@twilio-paste/button";
+import type { HTMLPasteProps } from "@twilio-paste/types";
+
+export interface SidePanelProps extends HTMLPasteProps<"div"> {
+ children?: React.ReactNode;
+ /**
+ * Accessible label for the Side Panel
+ *
+ * @type {string}
+ * @memberof SidebarProps
+ */
+ label: string;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ * @default "SIDE_PANEL"
+ * @type {BoxProps['element']}
+ * @memberof SidePanelProps
+ */
+ element?: BoxProps["element"];
+}
+
+export interface SidePanelBodyProps extends HTMLPasteProps<"div"> {
+ children?: React.ReactNode;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ * @default "SIDE_PANEL_BODY"
+ * @type {BoxProps['element']}
+ * @memberof SidePanelBodyProps
+ */
+ element?: BoxProps["element"];
+}
+
+export interface SidePanelHeaderProps extends HTMLPasteProps<"div"> {
+ children?: React.ReactNode;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ * @default "SIDE_PANEL_HEADER"
+ * @type {BoxProps['element']}
+ * @memberof SidePanelHeaderProps
+ */
+ element?: BoxProps["element"];
+}
+
+export interface SidePanelHeaderActionsProps extends HTMLPasteProps<"div"> {
+ children?: React.ReactNode;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ * @default "SIDE_PANEL_HEADER_ACTIONS"
+ * @type {BoxProps['element']}
+ * @memberof SidePanelHeaderActionsProps
+ */
+ element?: BoxProps["element"];
+}
+
+export interface SidePanelContainerProps extends HTMLPasteProps<"div"> {
+ children: React.ReactNode;
+ /**
+ * Accessible title for the close Side Panel button for non-english languages
+ * @type string
+ * @memberof SidePanelHeaderProps
+ * @default "close the side panel"
+ */
+ i18nCloseSidePanelTitle?: string;
+ /**
+ * Accessible title for the open Side Panel button for non-english languages
+ * @type string
+ * @memberof SidePanelHeaderProps
+ * @default "open the side panel"
+ */
+ i18nOpenSidePanelTitle?: string;
+ /**
+ * Id for the Side Panel. Gets passed to the `aria-controls` attribute of the Side Panel Button for accessibility. A unique ID will be created if nothing is passed.
+ * @type {string}
+ * @memberof SidePanelContainerProps
+ */
+ sidePanelId?: string;
+ /**
+ * State for the Side Panel. Determines whether the Side Panel is open or closed.
+ * @type {boolean}
+ * @default false
+ * @memberof SidePanelContainerProps
+ */
+ isOpen: boolean;
+ /**
+ * Sets the state of the Side Panel between open and closed.
+ * @type {Dispatch>}
+ * @memberof SidePanelContainerProps
+ */
+ setIsOpen: React.Dispatch>;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ * @default "SIDE_PANEL_CONTAINER"
+ * @type {BoxProps['element']}
+ * @memberof SidePanelContainerProps
+ */
+ element?: BoxProps["element"];
+}
+
+export type ButtonBadgeProps = BadgeBaseProps &
+ Omit & {
+ onClick?: BadgeButtonProps["onClick"];
+ };
+
+type SidePanelButtonBaseProps = {
+ id?: string;
+ toggle?: () => void;
+};
+
+export type SidePanelButtonProps = SidePanelButtonBaseProps &
+ Omit & {
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ *
+ * @default 'SIDE_PANEL_BUTTON'
+ * @type {BoxProps['element']}
+ * @memberof SidePanelButtonProps
+ */
+ element?: BoxProps["element"];
+ };
+export type SidePanelBadgeButtonProps = SidePanelButtonBaseProps &
+ Omit & {
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ *
+ * @default 'SIDE_PANEL_BADGE'
+ * @type {BoxProps['element']}
+ * @memberof SidePanelBadgeButtonProps
+ */
+ element?: BoxProps["element"];
+ };
+
+export interface SidePanelPushContentWrapperProps extends HTMLPasteProps<"div"> {
+ children: React.ReactNode;
+ /**
+ * Overrides the default element name to apply unique styles with the Customization Provider
+ *
+ * @default "SIDE_PANEL_PUSH_CONTENT_WRAPPER"
+ * @type {BoxProps["element"]}
+ * @memberof SidePanelPushContentWrapperProps
+ */
+ element?: BoxProps["element"];
+}
+
+export interface SidePanelContextProps {
+ sidePanelId: string;
+ isOpen: boolean;
+ setIsOpen: React.Dispatch>;
+ i18nCloseSidePanelTitle: string;
+ i18nOpenSidePanelTitle: string;
+}
diff --git a/packages/paste-core/components/side-panel/stories/components/MessagingInsightsContent.tsx b/packages/paste-core/components/side-panel/stories/components/MessagingInsightsContent.tsx
new file mode 100644
index 0000000000..b30a9c09ef
--- /dev/null
+++ b/packages/paste-core/components/side-panel/stories/components/MessagingInsightsContent.tsx
@@ -0,0 +1,163 @@
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable react/jsx-max-depth */
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-extraneous-dependencies */
+import { Badge } from "@twilio-paste/badge";
+import { Box } from "@twilio-paste/box";
+import { Button } from "@twilio-paste/button";
+import { Card } from "@twilio-paste/card";
+import { Combobox } from "@twilio-paste/combobox";
+import { Disclosure, DisclosureContent, DisclosureHeading } from "@twilio-paste/disclosure";
+import { Heading } from "@twilio-paste/heading";
+import { ArtificialIntelligenceIcon } from "@twilio-paste/icons/esm/ArtificialIntelligenceIcon";
+import { ClearIcon } from "@twilio-paste/icons/esm/ClearIcon";
+import { PlusIcon } from "@twilio-paste/icons/esm/PlusIcon";
+import { Label } from "@twilio-paste/label";
+import { Paragraph } from "@twilio-paste/paragraph";
+import { Option, Select } from "@twilio-paste/select";
+import { Separator } from "@twilio-paste/separator";
+import { Tab, TabList, TabPanel, TabPanels, Tabs } from "@twilio-paste/tabs";
+import { Text } from "@twilio-paste/text";
+import { useUID } from "@twilio-paste/uid-library";
+import * as React from "react";
+
+import { SidePanelBadgeButton } from "../../src";
+
+export const MessagingInsightsContent: React.FC> = ({
+ mainContentSkipLinkID,
+}) => {
+ const selectedTabId = useUID();
+ const fieldId = useUID();
+ const operatorId = useUID();
+ const valueId = useUID();
+
+ return (
+
+
+
+ Messaging Insights
+
+
+
+
+
+ Ask Intelligent Assistant
+
+
+
+
+
+ Filters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Overview
+ Delivery
+ Responses
+ OTP
+ Latency
+ Scheduled
+ Deliverability
+
+
+
+
+
+
+
+ Your message deliverability health is Fair
+
+
+ Twilio Messaging deliverability score is an indicator to check your messaging health at a glance.
+
+
+
+
+
+
+ Alerts & recommendations
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+};
diff --git a/packages/paste-core/components/side-panel/stories/components/SidePanelWithContent.tsx b/packages/paste-core/components/side-panel/stories/components/SidePanelWithContent.tsx
new file mode 100644
index 0000000000..350bd7e338
--- /dev/null
+++ b/packages/paste-core/components/side-panel/stories/components/SidePanelWithContent.tsx
@@ -0,0 +1,89 @@
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-extraneous-dependencies */
+import { Anchor } from "@twilio-paste/anchor";
+import { Avatar } from "@twilio-paste/avatar";
+import { Box } from "@twilio-paste/box";
+import { Button } from "@twilio-paste/button";
+import { ChatComposer } from "@twilio-paste/chat-composer";
+import { ChatBubble, ChatLog, ChatMessage, ChatMessageMeta, ChatMessageMetaItem } from "@twilio-paste/chat-log";
+import { DetailText } from "@twilio-paste/detail-text";
+import { Heading } from "@twilio-paste/heading";
+import { ArtificialIntelligenceIcon } from "@twilio-paste/icons/esm/ArtificialIntelligenceIcon";
+import { MoreIcon } from "@twilio-paste/icons/esm/MoreIcon";
+import { Separator } from "@twilio-paste/separator";
+import * as React from "react";
+
+import { SidePanel, SidePanelBody, SidePanelHeader, SidePanelHeaderActions } from "../../src";
+
+export const SidePanelWithContent: React.FC = () => {
+ return (
+
+
+
+
+ Assistant
+
+
+
+
+
+
+
+
+
+
+ Hello, what can I help you with?
+
+
+
+ Gibby Radki ・ 3:35 PM
+
+
+
+
+ Hi! What is your return policy?
+
+ 3:35 PM
+
+
+
+ Hello, what can I help you with?
+
+
+
+ Gibby Radki ・ 3:35 PM
+
+
+
+
+ Hi! What is your return policy?
+
+ 3:35 PM
+
+
+
+ {
+ throw e;
+ },
+ }}
+ initialValue="Are switch labels required in the context of a data grid? I'm exploring a UI that allows users to make the same configuration to every row in that data grid, and i'm wondering if there are any accessibility issues with having the column header in the top row with just the switch component in each of the row cells? the label gets pretty repetitive and we're expecting the table to have 20+ rows in this table, so trying to find ways to make it less visually crowded"
+ placeholder="Chat text"
+ ariaLabel="A basic chat composer"
+ />
+
+
+ This chatbot is powered by OpenAI. For more information, see the{" "}
+ Customer AI Trust Principles and{" "}
+ Twilio Privacy Notice.
+
+
+
+
+
+ );
+};
diff --git a/packages/paste-core/components/side-panel/stories/components/SidebarWithContent.tsx b/packages/paste-core/components/side-panel/stories/components/SidebarWithContent.tsx
new file mode 100644
index 0000000000..9119903746
--- /dev/null
+++ b/packages/paste-core/components/side-panel/stories/components/SidebarWithContent.tsx
@@ -0,0 +1,46 @@
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable import/no-extraneous-dependencies */
+import { LogoTwilioIcon } from "@twilio-paste/icons/esm/LogoTwilioIcon";
+import {
+ Sidebar,
+ SidebarBody,
+ SidebarHeader,
+ SidebarHeaderIconButton,
+ SidebarHeaderLabel,
+ SidebarNavigation,
+ SidebarNavigationItem,
+} from "@twilio-paste/sidebar";
+import { useUID } from "@twilio-paste/uid-library";
+import * as React from "react";
+
+export const SidebarWithContent: React.FC<
+ React.PropsWithChildren<{ topbarSkipLinkID: string; mainContentSkipLinkID: string }>
+> = ({ topbarSkipLinkID, mainContentSkipLinkID }) => {
+ const id = useUID();
+ const sidebarNavigationSkipLinkID = useUID();
+
+ return (
+
+
+
+
+
+ Product name
+
+
+
+
+ Explore products
+
+
+
+
+ );
+};
diff --git a/packages/paste-core/components/side-panel/stories/index.stories.tsx b/packages/paste-core/components/side-panel/stories/index.stories.tsx
new file mode 100644
index 0000000000..15210c3434
--- /dev/null
+++ b/packages/paste-core/components/side-panel/stories/index.stories.tsx
@@ -0,0 +1,223 @@
+/* eslint-disable eslint-comments/disable-enable-pair */
+/* eslint-disable react/jsx-max-depth */
+/* eslint-disable import/no-extraneous-dependencies */
+import { Box } from "@twilio-paste/box";
+import { Button } from "@twilio-paste/button";
+import { CustomizationProvider } from "@twilio-paste/customization";
+import { Heading } from "@twilio-paste/heading";
+import { ChevronDoubleLeftIcon } from "@twilio-paste/icons/esm/ChevronDoubleLeftIcon";
+import { ChevronDoubleRightIcon } from "@twilio-paste/icons/esm/ChevronDoubleRightIcon";
+import { MoreIcon } from "@twilio-paste/icons/esm/MoreIcon";
+import { SidebarPushContentWrapper } from "@twilio-paste/sidebar";
+import { useTheme } from "@twilio-paste/theme";
+import { Topbar } from "@twilio-paste/topbar";
+import { useUID } from "@twilio-paste/uid-library";
+import * as React from "react";
+
+import {
+ SidePanel,
+ SidePanelBody,
+ SidePanelButton,
+ SidePanelContainer,
+ SidePanelHeader,
+ SidePanelHeaderActions,
+ SidePanelPushContentWrapper,
+} from "../src";
+import { MessagingInsightsContent } from "./components/MessagingInsightsContent";
+import { SidePanelWithContent } from "./components/SidePanelWithContent";
+import { SidebarWithContent } from "./components/SidebarWithContent";
+
+// eslint-disable-next-line import/no-default-export
+export default {
+ title: "Components/Side Panel",
+ component: SidePanel,
+};
+
+export const Default = (): React.ReactNode => {
+ const [isOpen, setIsOpen] = React.useState(true);
+ return (
+
+
+
+
+
+ Toggle Side Panel
+ {!isOpen && }
+ {isOpen && }
+
+
+
+
+ );
+};
+Default.parameters = {
+ padding: false,
+};
+
+export const Basic = (): React.ReactNode => {
+ const [isOpen, setIsOpen] = React.useState(true);
+ const sidePanelId = useUID();
+ return (
+
+
+
+ Toggle Side Panel
+
+
+ );
+};
+Basic.parameters = {
+ padding: false,
+};
+
+export const ContentDemo = (): React.ReactNode => {
+ const [isOpen, setIsOpen] = React.useState(true);
+
+ const topbarSkipLinkID = useUID();
+ const mainContentSkipLinkID = useUID();
+ const sidePanelId = useUID();
+ return (
+
+
+
+
+
+
+
+ I am a box with a gray border and I have width 100%
+
+ Toggle Side Panel
+
+
+ I am a box with a red border and I have fixed height and width
+
+
+
+
+
+
+ Heading
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+};
+
+ContentDemo.parameters = {
+ padding: false,
+};
+
+export const Composed = (): React.ReactNode => {
+ const [isOpen, setIsOpen] = React.useState(true);
+
+ const topbarSkipLinkID = useUID();
+ const mainContentSkipLinkID = useUID();
+
+ return (
+
+ {/* Sidebar can be placed anywhere - position fixed */}
+
+
+
+
+
+
+
+ {/* Side Panel can be placed anywhere - position fixed */}
+
+
+
+
+ );
+};
+
+Composed.parameters = {
+ padding: false,
+};
+
+export const Customized = (): React.ReactNode => {
+ const [isOpen, setIsOpen] = React.useState(true);
+ const label = useUID();
+ const theme = useTheme();
+
+ return (
+
+
+
+
+
+
+
+
+
+
+ Heading
+
+
+
+
+
+
+
+
+
+
+
+ );
+};
+
+Customized.parameters = {
+ padding: false,
+};
diff --git a/packages/paste-core/components/side-panel/tsconfig.json b/packages/paste-core/components/side-panel/tsconfig.json
new file mode 100644
index 0000000000..b5daed7034
--- /dev/null
+++ b/packages/paste-core/components/side-panel/tsconfig.json
@@ -0,0 +1,12 @@
+{
+ "extends": "../../../../tsconfig.json",
+ "compilerOptions": {
+ "outDir": "dist/",
+ },
+ "include": [
+ "src/**/*",
+ ],
+ "exclude": [
+ "node_modules"
+ ]
+}
diff --git a/packages/paste-core/components/side-panel/type-docs.json b/packages/paste-core/components/side-panel/type-docs.json
new file mode 100644
index 0000000000..854fd87f72
--- /dev/null
+++ b/packages/paste-core/components/side-panel/type-docs.json
@@ -0,0 +1,12926 @@
+{
+ "SidePanelButton": {
+ "variant": {
+ "type": "| \"link\"\n | \"reset\"\n | \"primary\"\n | \"primary_icon\"\n | \"secondary\"\n | \"secondary_icon\"\n | \"destructive\"\n | \"destructive_icon\"\n | \"destructive_link\"\n | \"destructive_secondary\"\n | \"inverse_link\"\n | \"inverse\"",
+ "defaultValue": "'primary'",
+ "required": true,
+ "externalProp": false,
+ "description": "The different appearance variants for a button. [Avoid using link variants when possible.](https://paste.twilio.design/components/button#button-vs-anchor-link)"
+ },
+ "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": "\"link\" | \"none\" | \"copy\" | \"execute\" | \"move\" | \"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."
+ },
+ "autoCapitalize": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "autoCorrect": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "autoFocus": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "autoSave": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "contentEditable": {
+ "type": "Booleanish | \"inherit\"",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "contextMenu": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "dangerouslySetInnerHTML": {
+ "type": "{ __html: string }",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "datatype": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "defaultChecked": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "defaultValue": {
+ "type": "string | number | readonly string[]",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "dir": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "defaultValue": false,
+ "required": false,
+ "externalProp": false,
+ "description": "Prevent actions from firing on this Button"
+ },
+ "draggable": {
+ "type": "Booleanish",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "element": {
+ "type": "string",
+ "defaultValue": "'BUTTON'",
+ "required": false,
+ "externalProp": false,
+ "description": "Overrides the default element name to apply unique styles with the Customization Provider.\n\n\nOverrides the default element name to apply unique styles with the Customization Provider"
+ },
+ "form": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "formAction": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "formEncType": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "formMethod": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "formNoValidate": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "formTarget": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "fullWidth": {
+ "type": "boolean",
+ "defaultValue": false,
+ "required": false,
+ "externalProp": false,
+ "description": "Sets the Button width to 100% of the parent container."
+ },
+ "hidden": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "href": {
+ "type": "string",
+ "defaultValue": "null",
+ "required": false,
+ "externalProp": false,
+ "description": "A URL to route to. Must use as=\"a\" for this prop to work."
+ },
+ "i18nExternalLinkLabel": {
+ "type": "string",
+ "defaultValue": "'(link takes you to an external page)'",
+ "required": false,
+ "externalProp": false,
+ "description": "Title for showExternal icon"
+ },
+ "id": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": false
+ },
+ "inlist": {
+ "type": "any",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "inputMode": {
+ "type": "| \"text\"\n | \"none\"\n | \"search\"\n | \"tel\"\n | \"url\"\n | \"email\"\n | \"numeric\"\n | \"decimal\"",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true,
+ "description": "Hints at the type of data that might be entered by the user while editing the element or its contents"
+ },
+ "is": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true,
+ "description": "Specify that a standard HTML element should behave like a defined custom built-in element"
+ },
+ "itemID": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "itemProp": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "itemRef": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "itemScope": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "itemType": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "key": {
+ "type": "Key",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "lang": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "loading": {
+ "type": "boolean",
+ "defaultValue": false,
+ "required": false,
+ "externalProp": false,
+ "description": "Prevent actions and show a loading spinner"
+ },
+ "name": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "nonce": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAbort": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAbortCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationEnd": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationEndCapture": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationIteration": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationIterationCapture": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationStart": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAnimationStartCapture": {
+ "type": "AnimationEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAuxClick": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onAuxClickCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onBeforeInput": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onBeforeInputCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onBlur": {
+ "type": "FocusEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onBlurCapture": {
+ "type": "FocusEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCanPlay": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCanPlayCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCanPlayThrough": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCanPlayThroughCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onChange": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onChangeCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onClick": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onClickCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionEnd": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionEndCapture": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionStart": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionStartCapture": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionUpdate": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCompositionUpdateCapture": {
+ "type": "CompositionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onContextMenu": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onContextMenuCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCopy": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCopyCapture": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCut": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onCutCapture": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDoubleClick": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDoubleClickCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDrag": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragEnd": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragEndCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragEnter": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragEnterCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragExit": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragExitCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragLeave": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragLeaveCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragOver": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragOverCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragStart": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDragStartCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDrop": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDropCapture": {
+ "type": "DragEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDurationChange": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onDurationChangeCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEmptied": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEmptiedCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEncrypted": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEncryptedCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEnded": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onEndedCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onError": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onErrorCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onFocus": {
+ "type": "FocusEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onFocusCapture": {
+ "type": "FocusEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onGotPointerCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onGotPointerCaptureCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onInput": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onInputCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onInvalid": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onInvalidCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyDown": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyDownCapture": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyPress": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyPressCapture": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyUp": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onKeyUpCapture": {
+ "type": "KeyboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoad": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadedData": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadedDataCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadedMetadata": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadedMetadataCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadStart": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLoadStartCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLostPointerCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onLostPointerCaptureCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseDown": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseDownCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseEnter": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseLeave": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseMove": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseMoveCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseOut": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseOutCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseOver": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseOverCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseUp": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onMouseUpCapture": {
+ "type": "MouseEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPaste": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPasteCapture": {
+ "type": "ClipboardEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPause": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPauseCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPlay": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPlayCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPlaying": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPlayingCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerCancel": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerCancelCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerDown": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerDownCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerEnter": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerEnterCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerLeave": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerLeaveCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerMove": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerMoveCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerOut": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerOutCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerOver": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerOverCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerUp": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onPointerUpCapture": {
+ "type": "PointerEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onProgress": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onProgressCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onRateChange": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onRateChangeCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onReset": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onResetCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onResize": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onResizeCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onScroll": {
+ "type": "UIEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onScrollCapture": {
+ "type": "UIEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSeeked": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSeekedCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSeeking": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSeekingCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSelect": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSelectCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onStalled": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onStalledCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSubmit": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSubmitCapture": {
+ "type": "FormEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSuspend": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onSuspendCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTimeUpdate": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTimeUpdateCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchCancel": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchCancelCapture": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchEnd": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchEndCapture": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchMove": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchMoveCapture": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchStart": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTouchStartCapture": {
+ "type": "TouchEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTransitionEnd": {
+ "type": "TransitionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onTransitionEndCapture": {
+ "type": "TransitionEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onVolumeChange": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onVolumeChangeCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onWaiting": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onWaitingCapture": {
+ "type": "ReactEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onWheel": {
+ "type": "WheelEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "onWheelCapture": {
+ "type": "WheelEventHandler",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "placeholder": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "prefix": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "pressed": {
+ "type": "boolean",
+ "defaultValue": false,
+ "required": false,
+ "externalProp": false,
+ "description": "Sets the aria-pressed attribute. Must be used with 'secondary' or 'secondary_icon' variants."
+ },
+ "property": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "radioGroup": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "resource": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "results": {
+ "type": "number",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "role": {
+ "type": "AriaRole",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "security": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "size": {
+ "type": "ButtonSizes",
+ "defaultValue": "'default'",
+ "required": false,
+ "externalProp": false
+ },
+ "slot": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "spellCheck": {
+ "type": "Booleanish",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "suppressContentEditableWarning": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "suppressHydrationWarning": {
+ "type": "boolean",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "tabIndex": {
+ "type": "ButtonTabIndexes",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": false
+ },
+ "target": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": false
+ },
+ "title": {
+ "type": "string",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "toggle": {
+ "type": "() => void",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": false
+ },
+ "translate": {
+ "type": "\"yes\" | \"no\"",
+ "defaultValue": null,
+ "required": false,
+ "externalProp": true
+ },
+ "type": {
+ "type": "ButtonTypes",
+ "defaultValue": "'button'",
+ "required": false,
+ "externalProp": false,
+ "description": "Use at least one `submit` button per `