From a4404eab37a8ce17e9505607857c6c5251337980 Mon Sep 17 00:00:00 2001 From: krisantrobus <55083528+krisantrobus@users.noreply.github.com> Date: Wed, 13 Nov 2024 13:18:03 -0600 Subject: [PATCH] feat(keyboard-key): create package (#4136) * feat(keyboard-key): component init * chore(tools): plopfile syntax fix * chore(tools): plopfile syntax fix * chore(tools): plopfile syntax fix * feat(keyboard-key): styled w/ hook unit tests * feat(keyboard-key): added variants and styles * chore(plop): update tsx dependency * chore(keyboard-key): internal exports in core * chore(keyboard-key): typedocs & build * feat(keyboard-key): change to infline-flex style * chore(keyboard-key): added stroy * chore(keyboard-key): linting * fix(keyboard-key): command logic * feat(design-tokens): added new box shadows to support keyboard-keys * chore(ci-cd): added chagesets * fix(keyboard-key): boxShadow stylings * fix(keyboard-key): remove null component wrapper * fix(keyboard-key): aria-hidden * chore(keyboard-key): refactor * chore(keyboard-key): code cleanup * chore(keyboard-key): code cleanup * chore(keyboard-key): typedocs * chore(keyboard-key): fix tests * fix(keyboard-key): aria and diableBrowserShortcuts * fix(keyboard-key): props fix * chore(keyboard-key): playgorund storybook * chore(keyboard-key): formatting fix * chore(keyboard-key): stories update * chore(keyboard-key): formatting fix * chore(keyboard-key): typo * Update .changeset/sweet-mugs-admire.md Co-authored-by: Nora Krantz <75342690+nkrantz@users.noreply.github.com> * Update .changeset/shaggy-sheep-confess.md Co-authored-by: Nora Krantz <75342690+nkrantz@users.noreply.github.com> * chore(keyboard-key): address PR comments * fix(keyboard-key): no exported member * fix(keyboard-key): typedocs * fix(keyboard-key): typedocs * chore(keyboard-key): update prop name to eventKey * chore(keyboard-key): typedoc changes --------- Co-authored-by: Nora Krantz <75342690+nkrantz@users.noreply.github.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- .changeset/confused-whale.md | 5 + .changeset/shaggy-sheep-confess.md | 6 + .changeset/sweet-mugs-admire.md | 6 + .codesandbox/ci.json | 1 + .../paste-codemods/tools/.cache/mappings.json | 4 + .../components/keyboard-key/CHANGELOG.md | 0 .../keyboard-key/__tests__/hooks.spec.tsx | 315 ++ .../keyboard-key/__tests__/index.spec.tsx | 65 + .../components/keyboard-key/build.js | 3 + .../components/keyboard-key/package.json | 59 + .../keyboard-key/src/KeyboardKey.tsx | 104 + .../keyboard-key/src/KeyboardKeyContext.tsx | 38 + .../keyboard-key/src/KeyboardKeyGroup.tsx | 43 + .../components/keyboard-key/src/hooks.ts | 94 + .../components/keyboard-key/src/index.tsx | 6 + .../keyboard-key/stories/index.stories.tsx | 270 ++ .../components/keyboard-key/tsconfig.json | 12 + .../components/keyboard-key/type-docs.json | 3237 +++++++++++++++++ packages/paste-core/core-bundle/.gitignore | 1 + packages/paste-core/core-bundle/package.json | 1 + packages/paste-core/core-bundle/src/index.tsx | 1 + .../core-bundle/src/keyboard-key.tsx | 1 + .../paste-core/primitives/box/type-docs.json | 2 +- .../primitives/sibling-box/type-docs.json | 2 +- .../paste-core/primitives/text/type-docs.json | 2 +- .../__snapshots__/index.test.tsx.snap | 10 + .../tokens/global/box-shadow.yml | 6 + tools/plop-templates/component-component.hbs | 2 +- tools/plop-templates/component-index.hbs | 2 +- tools/plop-templates/package.hbs | 2 +- yarn.lock | 37 + 31 files changed, 4331 insertions(+), 6 deletions(-) create mode 100644 .changeset/confused-whale.md create mode 100644 .changeset/shaggy-sheep-confess.md create mode 100644 .changeset/sweet-mugs-admire.md create mode 100644 packages/paste-core/components/keyboard-key/CHANGELOG.md create mode 100644 packages/paste-core/components/keyboard-key/__tests__/hooks.spec.tsx create mode 100644 packages/paste-core/components/keyboard-key/__tests__/index.spec.tsx create mode 100644 packages/paste-core/components/keyboard-key/build.js create mode 100644 packages/paste-core/components/keyboard-key/package.json create mode 100644 packages/paste-core/components/keyboard-key/src/KeyboardKey.tsx create mode 100644 packages/paste-core/components/keyboard-key/src/KeyboardKeyContext.tsx create mode 100644 packages/paste-core/components/keyboard-key/src/KeyboardKeyGroup.tsx create mode 100644 packages/paste-core/components/keyboard-key/src/hooks.ts create mode 100644 packages/paste-core/components/keyboard-key/src/index.tsx create mode 100644 packages/paste-core/components/keyboard-key/stories/index.stories.tsx create mode 100644 packages/paste-core/components/keyboard-key/tsconfig.json create mode 100644 packages/paste-core/components/keyboard-key/type-docs.json create mode 100644 packages/paste-core/core-bundle/src/keyboard-key.tsx diff --git a/.changeset/confused-whale.md b/.changeset/confused-whale.md new file mode 100644 index 0000000000..adf1aa81bc --- /dev/null +++ b/.changeset/confused-whale.md @@ -0,0 +1,5 @@ +--- +"@twilio-paste/codemods": minor +--- + +[KeyboardKey] added a new component to display visual indicators for keyboard shortcuts available to users diff --git a/.changeset/shaggy-sheep-confess.md b/.changeset/shaggy-sheep-confess.md new file mode 100644 index 0000000000..64e9ae135f --- /dev/null +++ b/.changeset/shaggy-sheep-confess.md @@ -0,0 +1,6 @@ +--- +"@twilio-paste/core": minor +"@twilio-paste/design-tokens": minor +--- + +[Design Tokens] added new design tokens shadowBorderBottomWeak and shadowBorderBottomInverseWeaker to support new feature, KeybaordKey. diff --git a/.changeset/sweet-mugs-admire.md b/.changeset/sweet-mugs-admire.md new file mode 100644 index 0000000000..f4032d0eb1 --- /dev/null +++ b/.changeset/sweet-mugs-admire.md @@ -0,0 +1,6 @@ +--- +"@twilio-paste/keyboard-key": major +"@twilio-paste/core": minor +--- + +[KeyboardKey] added a new component to display visual indicators for keyboard shortcuts available to users diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json index 0c92e15e99..b5a072e654 100644 --- a/.codesandbox/ci.json +++ b/.codesandbox/ci.json @@ -56,6 +56,7 @@ "/packages/paste-core/components/inline-control-group", "/packages/paste-core/components/input", "/packages/paste-core/components/input-box", + "/packages/paste-core/components/keyboard-key", "/packages/paste-core/components/label", "/packages/paste-libraries/lexical", "/packages/paste-core/components/list", diff --git a/packages/paste-codemods/tools/.cache/mappings.json b/packages/paste-codemods/tools/.cache/mappings.json index 280ffbc11e..f76c9b97da 100644 --- a/packages/paste-codemods/tools/.cache/mappings.json +++ b/packages/paste-codemods/tools/.cache/mappings.json @@ -147,6 +147,10 @@ "Prefix": "@twilio-paste/core/input-box", "Suffix": "@twilio-paste/core/input-box", "getInputChevronIconColor": "@twilio-paste/core/input-box", + "KeyboardKey": "@twilio-paste/core/keyboard-key", + "KeyboardKeyGroup": "@twilio-paste/core/keyboard-key", + "useKeyCombination": "@twilio-paste/core/keyboard-key", + "useKeyCombinations": "@twilio-paste/core/keyboard-key", "Label": "@twilio-paste/core/label", "RequiredDot": "@twilio-paste/core/label", "List": "@twilio-paste/core/list", diff --git a/packages/paste-core/components/keyboard-key/CHANGELOG.md b/packages/paste-core/components/keyboard-key/CHANGELOG.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/paste-core/components/keyboard-key/__tests__/hooks.spec.tsx b/packages/paste-core/components/keyboard-key/__tests__/hooks.spec.tsx new file mode 100644 index 0000000000..e717daebf3 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/__tests__/hooks.spec.tsx @@ -0,0 +1,315 @@ +import { act, fireEvent, render, renderHook, screen, waitFor } from "@testing-library/react"; +import * as React from "react"; + +import { useKeyCombination, useKeyCombinations } from "../src"; +import { Default } from "../stories/index.stories"; + +describe("Hooks", () => { + it("should handle pressed styling", async () => { + const { getAllByText } = render(); + + const controlKey = getAllByText("Control")[0]; + const bKey = getAllByText("B")[0]; + expect(controlKey).toBeDefined(); + expect(controlKey).toHaveStyleRule("background-color", "rgb(249, 249, 250)"); + expect(bKey).toHaveStyleRule("background-color", "rgb(249, 249, 250)"); + + await act(async () => { + fireEvent.keyDown(controlKey, { key: "Control" }); + }); + + expect(controlKey).toHaveStyleRule("background-color", "rgb(225, 227, 234)"); + expect(bKey).toHaveStyleRule("background-color", "rgb(249, 249, 250)"); + + await act(async () => { + fireEvent.keyUp(controlKey, { key: "Control" }); + }); + + expect(controlKey).toHaveStyleRule("background-color", "rgb(249, 249, 250)"); + expect(bKey).toHaveStyleRule("background-color", "rgb(249, 249, 250)"); + }); + + describe("useKeyCombination", () => { + it("should update activeKeys on keydown and keyup", async () => { + const { result } = renderHook(() => useKeyCombination({ keys: ["Control", "b"], onCombinationPress: jest.fn() })); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "d" }); + fireEvent.keyDown(window, { key: "v" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control", "d", "v"]); + }); + + await act(async () => { + fireEvent.keyUp(window, { key: "Control" }); + fireEvent.keyUp(window, { key: "d" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["v"]); + }); + }); + + it("should call onCombinationPress when keys match", async () => { + const onCombinationPress = jest.fn(); + const { result } = renderHook(() => useKeyCombination({ keys: ["Control", "b"], onCombinationPress }), {}); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b"])); + expect(onCombinationPress).toHaveBeenCalled(); + }); + }); + + it("should not call onCombinationPress when keys do not match", async () => { + const onCombinationPress = jest.fn(); + const { result } = renderHook(() => useKeyCombination({ keys: ["Control", "b"], onCombinationPress }), {}); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "d" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control", "d"]); + expect(onCombinationPress).not.toHaveBeenCalled(); + }); + }); + + it("should not call onCombinationPress when keys are present but more are pressed", async () => { + const onCombinationPress = jest.fn(); + const { result } = renderHook(() => useKeyCombination({ keys: ["Control", "b"], onCombinationPress }), {}); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "v" }); + fireEvent.keyDown(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "v", "b"])); + expect(onCombinationPress).not.toHaveBeenCalled(); + }); + }); + + it("should not call onCombinationPress when disabled", async () => { + const onCombinationPress = jest.fn(); + const { result } = renderHook(() => + useKeyCombination({ keys: ["Control", "b"], onCombinationPress, disabled: true }), + ); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b"])); + expect(onCombinationPress).not.toHaveBeenCalled(); + }); + }); + }); + + describe("useKeyCombinations", () => { + it("should update activeKeys on keydown and keyup", async () => { + const { result } = renderHook(() => + useKeyCombinations({ + combinations: [ + { keys: ["Control", "b"], onCombinationPress: jest.fn() }, + { keys: ["Control", "c"], onCombinationPress: jest.fn() }, + ], + }), + ); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "d" }); + fireEvent.keyDown(window, { key: "v" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control", "d", "v"]); + }); + + await act(async () => { + fireEvent.keyUp(window, { key: "Control" }); + fireEvent.keyUp(window, { key: "d" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["v"]); + }); + }); + + it("should call onCombinationPress when keys match", async () => { + const onCombinationPress1 = jest.fn(); + const onCombinationPress2 = jest.fn(); + + const { result } = renderHook(() => + useKeyCombinations({ + combinations: [ + { keys: ["Control", "b"], onCombinationPress: onCombinationPress1 }, + { keys: ["Control", "c"], onCombinationPress: onCombinationPress2 }, + ], + }), + ); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b"])); + expect(onCombinationPress1).toHaveBeenCalled(); + expect(onCombinationPress2).not.toHaveBeenCalled(); + }); + + await act(async () => { + onCombinationPress1.mockClear(); + fireEvent.keyDown(window, { key: "c" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b", "c"])); + expect(onCombinationPress1).not.toHaveBeenCalled(); + expect(onCombinationPress2).not.toHaveBeenCalled(); + }); + + await act(async () => { + fireEvent.keyUp(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "c"])); + expect(onCombinationPress1).not.toHaveBeenCalled(); + expect(onCombinationPress2).toHaveBeenCalled(); + }); + }); + + it("should not call onCOmbinationPress when disabled", async () => { + const onCombinationPress1 = jest.fn(); + const onCombinationPress2 = jest.fn(); + + const { result } = renderHook(() => + useKeyCombinations({ + combinations: [ + { keys: ["Control", "b"], onCombinationPress: onCombinationPress1 }, + { keys: ["Control", "c"], onCombinationPress: onCombinationPress2, disabled: true }, + ], + }), + ); + + expect(result.current?.activeKeys).toEqual([]); + + await act(async () => { + fireEvent.keyDown(window, { key: "Control" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(["Control"]); + }); + + await act(async () => { + fireEvent.keyDown(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b"])); + expect(onCombinationPress1).toHaveBeenCalled(); + expect(onCombinationPress2).not.toHaveBeenCalled(); + }); + + await act(async () => { + onCombinationPress1.mockClear(); + fireEvent.keyDown(window, { key: "c" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "b", "c"])); + expect(onCombinationPress1).not.toHaveBeenCalled(); + expect(onCombinationPress2).not.toHaveBeenCalled(); + }); + + await act(async () => { + fireEvent.keyUp(window, { key: "b" }); + }); + + await waitFor(() => { + expect(result.current?.activeKeys).toEqual(expect.arrayContaining(["Control", "c"])); + expect(onCombinationPress1).not.toHaveBeenCalled(); + expect(onCombinationPress2).not.toHaveBeenCalled(); + }); + }); + }); +}); diff --git a/packages/paste-core/components/keyboard-key/__tests__/index.spec.tsx b/packages/paste-core/components/keyboard-key/__tests__/index.spec.tsx new file mode 100644 index 0000000000..7fa4ec587b --- /dev/null +++ b/packages/paste-core/components/keyboard-key/__tests__/index.spec.tsx @@ -0,0 +1,65 @@ +import { render } from "@testing-library/react"; +import { CustomizationProvider } from "@twilio-paste/customization"; +import { Theme } from "@twilio-paste/theme"; +import * as React from "react"; + +import { KeyboardKey, KeyboardKeyGroup } from "../src"; +import { Default } from "../stories/index.stories"; + +describe("KeyboardKey", () => { + it("should render", async () => { + const { getAllByText } = render(); + + const controlKey = getAllByText("Control")[0]; + const bKey = getAllByText("B")[0]; + expect(controlKey).toBeDefined(); + expect(controlKey).toBeDefined(); + expect(controlKey).toHaveAttribute("data-paste-element", "KEYBOARD_KEY"); + expect(bKey).toHaveAttribute("data-paste-element", "KEYBOARD_KEY"); + expect(controlKey.parentElement).toHaveAttribute("data-paste-element", "KEYBOARD_KEY_GROUP"); + }); + + describe("Customization", () => { + it("should accept custom element names", async () => { + const { getAllByText } = render( + + + + Control + B + + + , + ); + + const controlKey = getAllByText("Control")[0]; + const bKey = getAllByText("B")[0]; + expect(controlKey).toHaveAttribute("data-paste-element", "MY_CUSTOM_KEY_ONE"); + expect(bKey).toHaveAttribute("data-paste-element", "MY_CUSTOM_KEY_TWO"); + expect(controlKey.parentElement).toHaveAttribute("data-paste-element", "MY_CUSTOM_KEY_GROUP"); + + expect(controlKey).toHaveStyleRule("font-family", "'TwilioSansMono',Courier,monospace"); + expect(controlKey).toHaveStyleRule("border-radius", "8px"); + expect(bKey).toHaveStyleRule("padding", "0.5rem"); + expect(bKey).toHaveStyleRule("border-radius", "16px"); + expect(controlKey.parentElement).toHaveStyleRule("background-color", "rgb(2, 99, 224)"); + }); + }); +}); diff --git a/packages/paste-core/components/keyboard-key/build.js b/packages/paste-core/components/keyboard-key/build.js new file mode 100644 index 0000000000..27dd98f98e --- /dev/null +++ b/packages/paste-core/components/keyboard-key/build.js @@ -0,0 +1,3 @@ +const { build } = require("../../../../tools/build/esbuild"); + +build(require("./package.json")); diff --git a/packages/paste-core/components/keyboard-key/package.json b/packages/paste-core/components/keyboard-key/package.json new file mode 100644 index 0000000000..50e3664666 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/package.json @@ -0,0 +1,59 @@ +{ + "name": "@twilio-paste/keyboard-key", + "version": "0.0.0", + "category": "typography", + "status": "production", + "description": "A keyboard key distinguishes a keyboard command or shortcut from other text.", + "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/animation-library": "^2.0.0", + "@twilio-paste/box": "^10.2.0", + "@twilio-paste/color-contrast-utils": "^5.0.0", + "@twilio-paste/customization": "^8.1.1", + "@twilio-paste/design-tokens": "^10.3.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", + "@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/animation-library": "^2.0.0", + "@twilio-paste/box": "^10.2.0", + "@twilio-paste/color-contrast-utils": "^5.0.0", + "@twilio-paste/customization": "^8.1.1", + "@twilio-paste/design-tokens": "^10.3.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", + "@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/keyboard-key/src/KeyboardKey.tsx b/packages/paste-core/components/keyboard-key/src/KeyboardKey.tsx new file mode 100644 index 0000000000..0d94b74c1f --- /dev/null +++ b/packages/paste-core/components/keyboard-key/src/KeyboardKey.tsx @@ -0,0 +1,104 @@ +import { Box, safelySpreadBoxProps } from "@twilio-paste/box"; +import type { BoxProps, BoxStyleProps } from "@twilio-paste/box"; +import type { HTMLPasteProps } from "@twilio-paste/types"; +import * as React from "react"; + +import { KeyboardKeyCombinationContext, KeyboardKeyVariants } from "./KeyboardKeyContext"; + +const BaseStyles: Record = { + default: { + borderColor: "colorBorderWeak", + backgroundColor: "colorBackgroundWeak", + boxShadow: "shadowBorderBottomWeak", + }, + inverse: { + borderColor: "colorBorderInverseWeaker", + backgroundColor: "colorBackgroundInverse", + color: "colorTextInverse", + boxShadow: "shadowBorderBottomInverseWeaker", + }, +}; + +const DisabledStyles: Record = { + default: { + color: "colorTextWeak", + borderColor: "colorBorderWeakest", + boxShadow: undefined, + }, + inverse: { + color: "colorTextInverseWeaker", + borderColor: "colorBorderInverseWeakest", + boxShadow: undefined, + }, +}; + +const PressedStyles: Record = { + default: { + backgroundColor: "colorBackgroundStrong", + boxShadow: undefined, + }, + inverse: { + backgroundColor: "colorBackgroundInverseStronger", + boxShadow: undefined, + }, +}; + +export interface KeyboardKeyProps extends HTMLPasteProps<"kbd"> { + children?: React.ReactNode; + /** + * Overrides the default element name to apply unique styles with the Customization Provider + * @default 'KEYBOARD_KEY' + * @type {BoxProps['element']} + * @memberof KeyboardKeyProps + */ + element?: BoxProps["element"]; + /** + * Sets the key text that will be used to determine if the key has press stylings. + * A list of keyEvent mapping can be found at: https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/ + * @default 'KEYBOARD_KEY' + * @type string + * @memberof KeyboardKeyProps + */ + keyEvent?: string; +} + +const KeyboardKey = React.forwardRef( + ({ element = "KEYBOARD_KEY", keyEvent, ...props }, ref) => { + const { + disabled, + activeKeys, + enablePressStyles, + variant = "default", + } = React.useContext(KeyboardKeyCombinationContext); + + const isKeyActive = + !disabled && activeKeys && keyEvent && activeKeys.map((k) => k.toLowerCase()).includes(keyEvent.toLowerCase()); + + return ( + + {props.children} + + ); + }, +); + +KeyboardKey.displayName = "KeyboardKey"; + +export { KeyboardKey }; diff --git a/packages/paste-core/components/keyboard-key/src/KeyboardKeyContext.tsx b/packages/paste-core/components/keyboard-key/src/KeyboardKeyContext.tsx new file mode 100644 index 0000000000..dc7dbcf4a9 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/src/KeyboardKeyContext.tsx @@ -0,0 +1,38 @@ +import * as React from "react"; + +export type KeyboardKeyVariants = "default" | "inverse"; + +export interface KeyboardCombinationState { + /** + * The aray of currently active keys + * @default [] + * @type { string[] } + * @memberof KeyboardCombinationState + */ + activeKeys?: string[]; + /** + * Whether the keys should show the disbled state + * @default false + * @type { boolean } + * @memberof KeyboardCombinationState + */ + disabled?: boolean; + /** + * Whether the keys should show pressed state when active keys contains the keyEvent mapped to KeyboardKey + * @default false + * @type { boolean } + * @memberof KeyboardCombinationState + */ + enablePressStyles?: boolean; + /** + * The variant of the keys to display + * @default 'default' + * @type { KeyboardKeyVariants } + * @memberof KeyboardCombinationState + */ + variant?: KeyboardKeyVariants; +} + +export const KeyboardKeyCombinationContext = React.createContext( + {} as KeyboardCombinationState, +); diff --git a/packages/paste-core/components/keyboard-key/src/KeyboardKeyGroup.tsx b/packages/paste-core/components/keyboard-key/src/KeyboardKeyGroup.tsx new file mode 100644 index 0000000000..ff54a5990b --- /dev/null +++ b/packages/paste-core/components/keyboard-key/src/KeyboardKeyGroup.tsx @@ -0,0 +1,43 @@ +import { Box, safelySpreadBoxProps } from "@twilio-paste/box"; +import type { BoxProps } from "@twilio-paste/box"; +import type { HTMLPasteProps } from "@twilio-paste/types"; +import * as React from "react"; + +import { KeyboardCombinationState, KeyboardKeyCombinationContext } from "./KeyboardKeyContext"; + +export interface KeyboardKeyGroupProps extends HTMLPasteProps<"div">, KeyboardCombinationState { + children?: React.ReactNode; + /** + * Overrides the default element name to apply unique styles with the Customization Provider + * @default 'KEYBOARD_KEY_GROUP' + * @type {BoxProps['element']} + * @memberof KeyboardKeyGroupProps + */ + element?: BoxProps["element"]; +} + +const KeyboardKeyGroup = React.forwardRef( + ( + { + element = "KEYBOARD_KEY_GROUP", + activeKeys, + disabled = false, + enablePressStyles = false, + variant = "default", + ...props + }, + ref, + ) => { + return ( + + + {props.children} + + + ); + }, +); + +KeyboardKeyGroup.displayName = "KeyboardKeyGroup"; + +export { KeyboardKeyGroup }; diff --git a/packages/paste-core/components/keyboard-key/src/hooks.ts b/packages/paste-core/components/keyboard-key/src/hooks.ts new file mode 100644 index 0000000000..48e8049c47 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/src/hooks.ts @@ -0,0 +1,94 @@ +import * as React from "react"; + +import { KeyboardCombinationState } from "./KeyboardKeyContext"; + +export interface useKeyCombinationProps { + keys: string[]; + onCombinationPress: () => void; + disabled?: boolean; + enablePressStyles?: boolean; +} + +interface useKeyCombinationReturn extends Omit { + activeKeys: string[]; +} + +interface useKeyCombinationsReturn { + activeKeys: string[]; +} + +export interface useKeyCombinationsProps { + combinations: Omit[]; +} + +const useKeyEvents = (): { activeKeys: string[] } => { + const [activeKeys, setActiveKeys] = React.useState([]); + + const handleKeyDown = (e: KeyboardEvent): void => { + if (!e.repeat) { + setActiveKeys((prev) => { + return Array.from(new Set([...prev, e.key])); + }); + } + }; + + const handleKeyUp = (e: KeyboardEvent): void => { + /** + * Due to a weird behavior on macOS we need to clear the set if the user pressed down the meta key and presses another key. + * https://stackoverflow.com/questions/11818637/why-does-javascript-drop-keyup-events-when-the-metakey-is-pressed-on-mac-browser + * Otherwise the set will hold all ever pressed keys while the meta key is down which leads to wrong results. + */ + if (e.key === "Meta") { + setActiveKeys([]); + } else { + setActiveKeys((prev) => [...prev].filter((k) => k !== e.key)); + } + }; + + React.useEffect(() => { + window.addEventListener("keydown", handleKeyDown); + window.addEventListener("keyup", handleKeyUp); + + return () => { + window.removeEventListener("keydown", handleKeyDown); + window.removeEventListener("keyup", handleKeyUp); + }; + }, []); + + return { activeKeys }; +}; + +const stringArrayMatches = (arr1: string[], arr2: string[]): boolean => + JSON.stringify(arr1.sort((a, b) => a.localeCompare(b))) === JSON.stringify(arr2.sort((a, b) => a.localeCompare(b))); + +export const useKeyCombination = ({ + keys, + onCombinationPress, + disabled, + enablePressStyles, +}: useKeyCombinationProps): useKeyCombinationReturn => { + const { activeKeys } = useKeyEvents(); + + React.useEffect(() => { + const combinationMatch = stringArrayMatches(keys, activeKeys); + + if (combinationMatch && !disabled) { + onCombinationPress(); + } + }, [activeKeys]); + + return { activeKeys, disabled, enablePressStyles }; +}; + +export const useKeyCombinations = ({ combinations }: useKeyCombinationsProps): useKeyCombinationsReturn => { + const { activeKeys } = useKeyEvents(); + React.useEffect(() => { + const combinationMatch = combinations.find((combos) => stringArrayMatches(combos.keys, activeKeys)); + + if (combinationMatch && !combinationMatch.disabled) { + combinationMatch.onCombinationPress(); + } + }, [activeKeys, combinations]); + + return { activeKeys }; +}; diff --git a/packages/paste-core/components/keyboard-key/src/index.tsx b/packages/paste-core/components/keyboard-key/src/index.tsx new file mode 100644 index 0000000000..7a4e508548 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/src/index.tsx @@ -0,0 +1,6 @@ +export { KeyboardKey } from "./KeyboardKey"; +export type { KeyboardKeyProps } from "./KeyboardKey"; +export { KeyboardKeyGroup } from "./KeyboardKeyGroup"; +export type { KeyboardKeyGroupProps } from "./KeyboardKeyGroup"; +export { useKeyCombination, useKeyCombinations } from "./hooks"; +export type { useKeyCombinationsProps, useKeyCombinationProps } from "./hooks"; diff --git a/packages/paste-core/components/keyboard-key/stories/index.stories.tsx b/packages/paste-core/components/keyboard-key/stories/index.stories.tsx new file mode 100644 index 0000000000..28ce65e8d6 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/stories/index.stories.tsx @@ -0,0 +1,270 @@ +import { Box } from "@twilio-paste/box"; +import { Button } from "@twilio-paste/button"; +import { CustomizationProvider } from "@twilio-paste/customization"; +import { Modal, ModalBody, ModalFooter, ModalFooterActions, ModalHeader, ModalHeading } from "@twilio-paste/modal"; +import { Paragraph } from "@twilio-paste/paragraph"; +import { Stack } from "@twilio-paste/stack"; +import { Text } from "@twilio-paste/text"; +import { Theme } from "@twilio-paste/theme"; +import * as React from "react"; + +import { KeyboardKey, KeyboardKeyGroup, useKeyCombination } from "../src"; + +// eslint-disable-next-line import/no-default-export +export default { + title: "Components/KeyboardKey", + component: KeyboardKey, +}; + +export const Default = (): React.ReactElement => { + const state = useKeyCombination({ + keys: ["Control", "b"], + onCombinationPress: (): void => { + // eslint-disable-next-line no-console + console.log("Control + B pressed"); + }, + enablePressStyles: true, + }); + + return ( + + + + + Default/pressed + + + Control + B + + + + + Disabled + + + Control + B + + + + + ); +}; + +export const Inverse = (): React.ReactElement => { + const state = useKeyCombination({ + keys: ["Control", "b"], + onCombinationPress: (): void => { + // eslint-disable-next-line no-console + console.log("Control + B pressed"); + }, + enablePressStyles: true, + }); + + return ( + + + + + Default/pressed + + + Control + B + + + + + Disabled + + + Control + B + + + + + ); +}; + +export const ForcePressed = (): React.ReactElement => { + const state = useKeyCombination({ + keys: ["Control", "b"], + onCombinationPress: (): void => { + // eslint-disable-next-line no-console + console.log("Control + B pressed"); + }, + enablePressStyles: true, + }); + + return ( + + + + Control + B + + + Control + B + + + + ); +}; + +export const MultipleCombinations = (): React.ReactElement => { + const [textToDisplay, setTextToDisplay] = React.useState(""); + + const stateCtrB = useKeyCombination({ + keys: ["Control", "b"], + onCombinationPress: (): void => { + setTextToDisplay("Control + B pressed"); + }, + enablePressStyles: true, + }); + const stateCtrK = useKeyCombination({ + keys: ["Control", "k"], + onCombinationPress: (): void => { + setTextToDisplay("Control + K pressed"); + }, + enablePressStyles: true, + }); + const stateCmdB = useKeyCombination({ + keys: ["Meta", "b"], + onCombinationPress: (): void => { + setTextToDisplay("Cmd + B pressed"); + }, + enablePressStyles: true, + }); + const stateCmdK = useKeyCombination({ + keys: ["Meta", "k"], + onCombinationPress: (): void => { + setTextToDisplay("Cmd + K pressed"); + }, + enablePressStyles: true, + }); + const stateCmdShiftB = useKeyCombination({ + keys: ["Meta", "Shift", "p"], + onCombinationPress: (): void => { + setTextToDisplay("Cmd + Shift + P pressed"); + }, + enablePressStyles: true, + }); + + return ( + + + + Control + B + + + Control + K + + + Cmd + B + + + Cmd + K + + + Cmd + Shift + P + + +
+ Combination pressed: {textToDisplay} + + ); +}; + +export const TriggerModal = (): React.ReactElement => { + const [isOpen, setIsOpen] = React.useState(false); + const state = useKeyCombination({ + keys: ["Control", "k"], + onCombinationPress: (): void => { + setIsOpen(true); + }, + enablePressStyles: true, + }); + + return ( + + Use the following shortcut to open a modal: + + Control + K + + + setIsOpen(false)} size="default"> + + Choose an author + + + + “If there’s a book that you want to read, but it hasn’t been written yet, then you must write it.” — Toni + Morrison + + + + + + + + + + ); +}; + +export const Customization = (): React.ReactElement => { + const state = useKeyCombination({ + keys: ["Control", "b"], + onCombinationPress: (): void => { + // eslint-disable-next-line no-console + console.log("Control + B pressed"); + }, + enablePressStyles: true, + }); + + return ( + + + + Control + B + + + + ); +}; + +Customization.paramters = { + a11y: { + // no need to a11y check customization + disabled: true, + }, +}; diff --git a/packages/paste-core/components/keyboard-key/tsconfig.json b/packages/paste-core/components/keyboard-key/tsconfig.json new file mode 100644 index 0000000000..b5daed7034 --- /dev/null +++ b/packages/paste-core/components/keyboard-key/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "../../../../tsconfig.json", + "compilerOptions": { + "outDir": "dist/", + }, + "include": [ + "src/**/*", + ], + "exclude": [ + "node_modules" + ] +} diff --git a/packages/paste-core/components/keyboard-key/type-docs.json b/packages/paste-core/components/keyboard-key/type-docs.json new file mode 100644 index 0000000000..4389e0190a --- /dev/null +++ b/packages/paste-core/components/keyboard-key/type-docs.json @@ -0,0 +1,3237 @@ +{ + "KeyboardKey": { + "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 + }, + "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 + }, + "draggable": { + "type": "Booleanish", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "element": { + "type": "string", + "defaultValue": "'KEYBOARD_KEY'", + "required": false, + "externalProp": false, + "description": "Overrides the default element name to apply unique styles with the Customization Provider" + }, + "hidden": { + "type": "boolean", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "id": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "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 + }, + "keyEvent": { + "type": "string", + "defaultValue": "'KEYBOARD_KEY'", + "required": false, + "externalProp": false, + "description": "Sets the key text that will be used to determine if the key has press stylings.\nA list of keyEvent mapping can be found at: https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/" + }, + "lang": { + "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 + }, + "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 + }, + "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": "number", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "title": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "translate": { + "type": "\"yes\" | \"no\"", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "typeof": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "unselectable": { + "type": "\"on\" | \"off\"", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "vocab": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + } + }, + "KeyboardKeyGroup": { + "about": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "accessKey": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "activeKeys": { + "type": "string[]", + "defaultValue": "[]", + "required": false, + "externalProp": false, + "description": "The aray of currently active keys" + }, + "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 + }, + "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": "Whether the keys should show the disbled state" + }, + "draggable": { + "type": "Booleanish", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "element": { + "type": "string", + "defaultValue": "'KEYBOARD_KEY_GROUP'", + "required": false, + "externalProp": false, + "description": "Overrides the default element name to apply unique styles with the Customization Provider" + }, + "enablePressStyles": { + "type": "boolean", + "defaultValue": false, + "required": false, + "externalProp": false, + "description": "Whether the keys should show pressed state when active keys contains the keyEvent mapped to KeyboardKey" + }, + "hidden": { + "type": "boolean", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "id": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "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 + }, + "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 + }, + "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 + }, + "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": "number", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "title": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "translate": { + "type": "\"yes\" | \"no\"", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "typeof": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "unselectable": { + "type": "\"on\" | \"off\"", + "defaultValue": null, + "required": false, + "externalProp": true + }, + "variant": { + "type": "KeyboardKeyVariants", + "defaultValue": "'default'", + "required": false, + "externalProp": false, + "description": "The variant of the keys to display" + }, + "vocab": { + "type": "string", + "defaultValue": null, + "required": false, + "externalProp": true + } + }, + "useKeyCombinations": { + "combinations": { + "type": "Omit[]", + "defaultValue": null, + "required": true, + "externalProp": false + } + }, + "useKeyCombination": { + "keys": { + "type": "string[]", + "defaultValue": null, + "required": true, + "externalProp": false + }, + "onCombinationPress": { + "type": "() => void", + "defaultValue": null, + "required": true, + "externalProp": false + }, + "disabled": { + "type": "boolean", + "defaultValue": null, + "required": false, + "externalProp": false + }, + "enablePressStyles": { + "type": "boolean", + "defaultValue": null, + "required": false, + "externalProp": false + } + } +} diff --git a/packages/paste-core/core-bundle/.gitignore b/packages/paste-core/core-bundle/.gitignore index 5729ccbc5f..dbbdf5405c 100644 --- a/packages/paste-core/core-bundle/.gitignore +++ b/packages/paste-core/core-bundle/.gitignore @@ -52,6 +52,7 @@ /inline-control-group /input /input-box +/keyboard-key /label /lexical-library /list diff --git a/packages/paste-core/core-bundle/package.json b/packages/paste-core/core-bundle/package.json index ff66bff890..3c3b8c77b5 100644 --- a/packages/paste-core/core-bundle/package.json +++ b/packages/paste-core/core-bundle/package.json @@ -123,6 +123,7 @@ "@twilio-paste/inline-control-group": "^13.0.2", "@twilio-paste/input": "^9.1.3", "@twilio-paste/input-box": "^10.1.1", + "@twilio-paste/keyboard-key": "^0.0.0", "@twilio-paste/label": "^13.1.1", "@twilio-paste/lexical-library": "^4.2.0", "@twilio-paste/list": "^8.2.1", diff --git a/packages/paste-core/core-bundle/src/index.tsx b/packages/paste-core/core-bundle/src/index.tsx index 29a53f9e81..94c1e06948 100644 --- a/packages/paste-core/core-bundle/src/index.tsx +++ b/packages/paste-core/core-bundle/src/index.tsx @@ -42,6 +42,7 @@ export * from "@twilio-paste/inline-code"; export * from "@twilio-paste/inline-control-group"; export * from "@twilio-paste/input"; export * from "@twilio-paste/input-box"; +export * from "@twilio-paste/keyboard-key"; export * from "@twilio-paste/label"; export * from "@twilio-paste/list"; export * from "@twilio-paste/listbox-primitive"; diff --git a/packages/paste-core/core-bundle/src/keyboard-key.tsx b/packages/paste-core/core-bundle/src/keyboard-key.tsx new file mode 100644 index 0000000000..214484c5be --- /dev/null +++ b/packages/paste-core/core-bundle/src/keyboard-key.tsx @@ -0,0 +1 @@ +export * from "@twilio-paste/keyboard-key"; diff --git a/packages/paste-core/primitives/box/type-docs.json b/packages/paste-core/primitives/box/type-docs.json index 992f6059f6..abd02882f8 100644 --- a/packages/paste-core/primitives/box/type-docs.json +++ b/packages/paste-core/primitives/box/type-docs.json @@ -958,7 +958,7 @@ "description": "Responsive prop for the CSS `bottom` property" }, "boxShadow": { - "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 73 more ... | { ...; }", + "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 75 more ... | { ...; }", "defaultValue": null, "required": false, "externalProp": false, diff --git a/packages/paste-core/primitives/sibling-box/type-docs.json b/packages/paste-core/primitives/sibling-box/type-docs.json index 74821aac52..a23bdfee53 100644 --- a/packages/paste-core/primitives/sibling-box/type-docs.json +++ b/packages/paste-core/primitives/sibling-box/type-docs.json @@ -1060,7 +1060,7 @@ "description": "Responsive prop for the CSS `bottom` property" }, "boxShadow": { - "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 73 more ... | { ...; }", + "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 75 more ... | { ...; }", "defaultValue": null, "required": false, "externalProp": false, diff --git a/packages/paste-core/primitives/text/type-docs.json b/packages/paste-core/primitives/text/type-docs.json index c746be7456..cbf3cb3985 100644 --- a/packages/paste-core/primitives/text/type-docs.json +++ b/packages/paste-core/primitives/text/type-docs.json @@ -531,7 +531,7 @@ "description": "Responsive prop for the CSS `bottom` property" }, "boxShadow": { - "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 73 more ... | { ...; }", + "type": "\"none\" | \"shadow\" | \"shadowBorder\" | \"shadowBorderBottomBrand10Strong\" | \"shadowBorderBottomBrand20Strong\" | \"shadowBorderBottomBrand30Strong\" | \"shadowBorderBottomDecorative10Weaker\" | ... 75 more ... | { ...; }", "defaultValue": null, "required": false, "externalProp": false, diff --git a/packages/paste-design-tokens/__tests__/__snapshots__/index.test.tsx.snap b/packages/paste-design-tokens/__tests__/__snapshots__/index.test.tsx.snap index 28d59d69fd..da3a350385 100644 --- a/packages/paste-design-tokens/__tests__/__snapshots__/index.test.tsx.snap +++ b/packages/paste-design-tokens/__tests__/__snapshots__/index.test.tsx.snap @@ -141,6 +141,7 @@ exports[`Design Tokens matches the Dark theme 1`] = ` \\"shadow-border-destructive-weaker\\": \\"0 0 0 1px #1f304c\\", \\"shadow-border-primary-weaker\\": \\"0 0 0 1px #1f304c\\", \\"shadow-border-top-inverse-strongest\\": \\"0 -1px 0 #cce4ff\\", + \\"shadow-border-bottom-weak\\": \\"0 1px 0 #cacdd8\\", \\"shadow-border-new-weaker\\": \\"0 0 0 1px #5817bd\\", \\"shadow-low\\": \\"0 2px 4px 0 rgba(0, 0, 0, 0.4)\\", \\"shadow-border-inverse-strong\\": \\"0 0 0 1px #e1e3ea\\", @@ -154,6 +155,7 @@ exports[`Design Tokens matches the Dark theme 1`] = ` \\"shadow-high\\": \\"0 16px 24px 4px rgba(0, 0, 0, 0.5)\\", \\"shadow-right\\": \\"-4px 0 8px -4px rgba(0, 0, 0, 0.4)\\", \\"shadow-border-error-strong\\": \\"0 0 0 1px #f6b1b1\\", + \\"shadow-border-bottom-inverse-weaker\\": \\"0 1px 0 #394762\\", \\"shadow-border-primary-strongest\\": \\"0 0 0 1px #ebf4ff\\", \\"shadow-border-destructive-strongest\\": \\"0 0 0 1px #feecec\\", \\"shadow-border-error-weak\\": \\"0 0 0 1px #ad1111\\", @@ -603,6 +605,7 @@ exports[`Design Tokens matches the Global theme 1`] = ` \\"shadow-border-destructive-weaker\\": \\"0 0 0 1px #fccfcf\\", \\"shadow-border-primary-weaker\\": \\"0 0 0 1px #cce4ff\\", \\"shadow-border-top-inverse-strongest\\": \\"0 -1px 0 #cce4ff\\", + \\"shadow-border-bottom-weak\\": \\"0 1px 0 #cacdd8\\", \\"shadow-border-new-weaker\\": \\"0 0 0 1px #e7dcfa\\", \\"shadow-low\\": \\"0 2px 8px 0 rgba(18, 28, 45, 0.1)\\", \\"shadow-border-inverse-strong\\": \\"0 0 0 1px #e1e3ea\\", @@ -616,6 +619,7 @@ exports[`Design Tokens matches the Global theme 1`] = ` \\"shadow-high\\": \\"0 16px 24px 0 rgba(18, 28, 45, 0.2)\\", \\"shadow-right\\": \\"-4px 0 8px -4px rgba(18, 28, 45, 0.2)\\", \\"shadow-border-error-strong\\": \\"0 0 0 1px #750c0c\\", + \\"shadow-border-bottom-inverse-weaker\\": \\"0 1px 0 #394762\\", \\"shadow-border-primary-strongest\\": \\"0 0 0 1px #06033a\\", \\"shadow-border-destructive-strongest\\": \\"0 0 0 1px #310c0c\\", \\"shadow-border-error-weak\\": \\"0 0 0 1px #eb5656\\", @@ -1065,6 +1069,7 @@ exports[`Design Tokens matches the Sendgrid theme 1`] = ` \\"shadow-border-destructive-weaker\\": \\"0 0 0 1px #fccfcf\\", \\"shadow-border-primary-weaker\\": \\"0 0 0 1px #cce4ff\\", \\"shadow-border-top-inverse-strongest\\": \\"0 -1px 0 #cce4ff\\", + \\"shadow-border-bottom-weak\\": \\"0 1px 0 #cacdd8\\", \\"shadow-border-new-weaker\\": \\"0 0 0 1px #e7dcfa\\", \\"shadow-low\\": \\"0 2px 8px 0 rgba(18, 28, 45, 0.1)\\", \\"shadow-border-inverse-strong\\": \\"0 0 0 1px #e1e3ea\\", @@ -1078,6 +1083,7 @@ exports[`Design Tokens matches the Sendgrid theme 1`] = ` \\"shadow-high\\": \\"0 16px 24px 0 rgba(18, 28, 45, 0.2)\\", \\"shadow-right\\": \\"-4px 0 8px -4px rgba(18, 28, 45, 0.2)\\", \\"shadow-border-error-strong\\": \\"0 0 0 1px #750c0c\\", + \\"shadow-border-bottom-inverse-weaker\\": \\"0 1px 0 #394762\\", \\"shadow-border-primary-strongest\\": \\"0 0 0 1px #06033a\\", \\"shadow-border-destructive-strongest\\": \\"0 0 0 1px #310c0c\\", \\"shadow-border-error-weak\\": \\"0 0 0 1px #eb5656\\", @@ -1527,6 +1533,7 @@ exports[`Design Tokens matches the Twilio Dark theme 1`] = ` \\"shadow-border-destructive-weaker\\": \\"0 0 0 1px #1f304c\\", \\"shadow-border-primary-weaker\\": \\"0 0 0 1px #043cb5\\", \\"shadow-border-top-inverse-strongest\\": \\"0 -1px 0 #cce4ff\\", + \\"shadow-border-bottom-weak\\": \\"0 1px 0 #cacdd8\\", \\"shadow-border-new-weaker\\": \\"0 0 0 1px #5817bd\\", \\"shadow-low\\": \\"0 2px 4px 0 rgba(0, 0, 0, 0.4)\\", \\"shadow-border-inverse-strong\\": \\"0 0 0 1px #e1e3ea\\", @@ -1540,6 +1547,7 @@ exports[`Design Tokens matches the Twilio Dark theme 1`] = ` \\"shadow-high\\": \\"0 16px 24px 4px rgba(0, 0, 0, 0.5)\\", \\"shadow-right\\": \\"-4px 0 8px -4px rgba(0, 0, 0, 0.4)\\", \\"shadow-border-error-strong\\": \\"0 0 0 1px #f58a8a\\", + \\"shadow-border-bottom-inverse-weaker\\": \\"0 1px 0 #394762\\", \\"shadow-border-primary-strongest\\": \\"0 0 0 1px #ebf4ff\\", \\"shadow-border-destructive-strongest\\": \\"0 0 0 1px #feecec\\", \\"shadow-border-error-weak\\": \\"0 0 0 1px #ad1111\\", @@ -1989,6 +1997,7 @@ exports[`Design Tokens matches the Twilio theme 1`] = ` \\"shadow-border-destructive-weaker\\": \\"0 0 0 1px #fccfcf\\", \\"shadow-border-primary-weaker\\": \\"0 0 0 1px #cce4ff\\", \\"shadow-border-top-inverse-strongest\\": \\"0 -1px 0 #cce4ff\\", + \\"shadow-border-bottom-weak\\": \\"0 1px 0 #cacdd8\\", \\"shadow-border-new-weaker\\": \\"0 0 0 1px #e7dcfa\\", \\"shadow-low\\": \\"0 2px 8px 0 rgba(18, 28, 45, 0.1)\\", \\"shadow-border-inverse-strong\\": \\"0 0 0 1px #e1e3ea\\", @@ -2002,6 +2011,7 @@ exports[`Design Tokens matches the Twilio theme 1`] = ` \\"shadow-high\\": \\"0 16px 24px 0 rgba(18, 28, 45, 0.2)\\", \\"shadow-right\\": \\"-4px 0 8px -4px rgba(18, 28, 45, 0.2)\\", \\"shadow-border-error-strong\\": \\"0 0 0 1px #750c0c\\", + \\"shadow-border-bottom-inverse-weaker\\": \\"0 1px 0 #394762\\", \\"shadow-border-primary-strongest\\": \\"0 0 0 1px #06033a\\", \\"shadow-border-destructive-strongest\\": \\"0 0 0 1px #310c0c\\", \\"shadow-border-error-weak\\": \\"0 0 0 1px #eb5656\\", diff --git a/packages/paste-design-tokens/tokens/global/box-shadow.yml b/packages/paste-design-tokens/tokens/global/box-shadow.yml index e9b971cdc9..67095948e7 100644 --- a/packages/paste-design-tokens/tokens/global/box-shadow.yml +++ b/packages/paste-design-tokens/tokens/global/box-shadow.yml @@ -225,6 +225,12 @@ props: shadow-border-bottom-inverse-weaker-inset: value: "inset {!offset-0} {!offset-negative-05} {!offset-0} {!offset-0} {!palette-gray-80}" comment: Weaker bottom shadow border for tab container on inverse backgrounds + shadow-border-bottom-weak: + value: "{!offset-0} {!offset-05} {!offset-0} {!palette-gray-30}" + comment: Bottom shadow border for border weak color + shadow-border-bottom-inverse-weaker: + value: "{!offset-0} {!offset-05} {!offset-0} {!palette-gray-80}" + comment: Bottom shadow border for inverse border weaker color # User shadow-border-user: diff --git a/tools/plop-templates/component-component.hbs b/tools/plop-templates/component-component.hbs index bd498c3332..d65ec24bd1 100644 --- a/tools/plop-templates/component-component.hbs +++ b/tools/plop-templates/component-component.hbs @@ -7,7 +7,7 @@ export interface {{pascalCase component-name}}Props extends HTMLPasteProps<"div" children?: React.ReactNode; /** * Overrides the default element name to apply unique styles with the Customization Provider - * @default '{constantCase component-name}' + * @default '{{constantCase component-name}}' * @type {BoxProps['element']} * @memberof {{pascalCase component-name}}Props */ diff --git a/tools/plop-templates/component-index.hbs b/tools/plop-templates/component-index.hbs index 42e94b4bac..532e526b50 100644 --- a/tools/plop-templates/component-index.hbs +++ b/tools/plop-templates/component-index.hbs @@ -1,2 +1,2 @@ -export {{{pascalCase component-name}}} from './{{pascalCase component-name}}' +export { {{pascalCase component-name}} } from './{{pascalCase component-name}}' export type { {{pascalCase component-name}}Props} from './{{pascalCase component-name}}' diff --git a/tools/plop-templates/package.hbs b/tools/plop-templates/package.hbs index b8da359597..551b42a378 100644 --- a/tools/plop-templates/package.hbs +++ b/tools/plop-templates/package.hbs @@ -53,7 +53,7 @@ "@types/react-dom": "^18.0.10", "react": "^18.0.0", "react-dom": "^18.0.0", - "tsx": "^3.12.10", + "tsx": "^4.0.0", "typescript": "^4.9.4" } } diff --git a/yarn.lock b/yarn.lock index fb6443790a..9bed85e1a5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -12321,6 +12321,7 @@ __metadata: "@twilio-paste/inline-control-group": ^13.0.2 "@twilio-paste/input": ^9.1.3 "@twilio-paste/input-box": ^10.1.1 + "@twilio-paste/keyboard-key": ^0.0.0 "@twilio-paste/label": ^13.1.1 "@twilio-paste/lexical-library": ^4.2.0 "@twilio-paste/list": ^8.2.1 @@ -13526,6 +13527,42 @@ __metadata: languageName: unknown linkType: soft +"@twilio-paste/keyboard-key@^0.0.0, @twilio-paste/keyboard-key@workspace:packages/paste-core/components/keyboard-key": + version: 0.0.0-use.local + resolution: "@twilio-paste/keyboard-key@workspace:packages/paste-core/components/keyboard-key" + dependencies: + "@twilio-paste/animation-library": ^2.0.0 + "@twilio-paste/box": ^10.2.0 + "@twilio-paste/color-contrast-utils": ^5.0.0 + "@twilio-paste/customization": ^8.1.1 + "@twilio-paste/design-tokens": ^10.3.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 + "@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 + peerDependencies: + "@twilio-paste/animation-library": ^2.0.0 + "@twilio-paste/box": ^10.2.0 + "@twilio-paste/color-contrast-utils": ^5.0.0 + "@twilio-paste/customization": ^8.1.1 + "@twilio-paste/design-tokens": ^10.3.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 + "@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 + languageName: unknown + linkType: soft + "@twilio-paste/label@^13.1.0, @twilio-paste/label@^13.1.1, @twilio-paste/label@workspace:packages/paste-core/components/label": version: 0.0.0-use.local resolution: "@twilio-paste/label@workspace:packages/paste-core/components/label"