From 4b6f7f5a72c2be9cece729ca2db4765458a2cc25 Mon Sep 17 00:00:00 2001 From: Armagan Ersoz Date: Thu, 9 Nov 2023 16:42:56 +1000 Subject: [PATCH 1/2] Tooltip: make text prop required --- src/drafts/Tooltip/Tooltip.docs.json | 1 + src/drafts/Tooltip/Tooltip.playground.stories.tsx | 4 ++-- src/drafts/Tooltip/Tooltip.tsx | 2 +- src/drafts/Tooltip/__tests__/Tooltip.test.tsx | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/drafts/Tooltip/Tooltip.docs.json b/src/drafts/Tooltip/Tooltip.docs.json index d49cf420c97..b98d1415068 100644 --- a/src/drafts/Tooltip/Tooltip.docs.json +++ b/src/drafts/Tooltip/Tooltip.docs.json @@ -13,6 +13,7 @@ }, { "name": "text", + "required": true, "type": "string", "description": "The text to be displayed in the tooltip" }, diff --git a/src/drafts/Tooltip/Tooltip.playground.stories.tsx b/src/drafts/Tooltip/Tooltip.playground.stories.tsx index c0e303e55e4..5f13fcbba2e 100644 --- a/src/drafts/Tooltip/Tooltip.playground.stories.tsx +++ b/src/drafts/Tooltip/Tooltip.playground.stories.tsx @@ -18,10 +18,10 @@ export default { export const Playground: StoryFn = args => { // this is a hack to remove the `type` prop from the args because for this example type label is not a valid choice and violates accessibility // eslint-disable-next-line @typescript-eslint/no-unused-vars - const {type, ...rest} = args + const {text, type, ...rest} = args return ( - + diff --git a/src/drafts/Tooltip/Tooltip.tsx b/src/drafts/Tooltip/Tooltip.tsx index e586905c97c..417f8e03bab 100644 --- a/src/drafts/Tooltip/Tooltip.tsx +++ b/src/drafts/Tooltip/Tooltip.tsx @@ -126,7 +126,7 @@ type TooltipDirection = 'nw' | 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' export type TooltipProps = React.PropsWithChildren< { direction?: TooltipDirection - text?: string + text: string type?: 'label' | 'description' } & SxProp & ComponentProps diff --git a/src/drafts/Tooltip/__tests__/Tooltip.test.tsx b/src/drafts/Tooltip/__tests__/Tooltip.test.tsx index db0dbb67c77..e8fbea212f3 100644 --- a/src/drafts/Tooltip/__tests__/Tooltip.test.tsx +++ b/src/drafts/Tooltip/__tests__/Tooltip.test.tsx @@ -5,7 +5,7 @@ import {render as HTMLRender} from '@testing-library/react' import theme from '../../../theme' import {Button, ActionMenu, ActionList, ThemeProvider, SSRProvider, BaseStyles} from '../../../' -const TooltipComponent = (props: TooltipProps) => ( +const TooltipComponent = (props: Omit & {text?: string}) => ( From ca3e552dda90a96fb001cdee9f27e6ffe7f499f3 Mon Sep 17 00:00:00 2001 From: Armagan Ersoz Date: Thu, 9 Nov 2023 16:45:16 +1000 Subject: [PATCH 2/2] changeset --- .changeset/young-trees-move.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/young-trees-move.md diff --git a/.changeset/young-trees-move.md b/.changeset/young-trees-move.md new file mode 100644 index 00000000000..4594b3debb3 --- /dev/null +++ b/.changeset/young-trees-move.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Tooltip2: make the text prop required