From e1e4c917d7fe79a38927fdcd807fca0bdbe17173 Mon Sep 17 00:00:00 2001 From: Tyler Jones Date: Fri, 20 Sep 2024 09:41:42 -0400 Subject: [PATCH 1/3] deprecate the caret --- packages/react/src/Popover/Popover.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/react/src/Popover/Popover.tsx b/packages/react/src/Popover/Popover.tsx index 8ff7cdaa075..f28f942a239 100644 --- a/packages/react/src/Popover/Popover.tsx +++ b/packages/react/src/Popover/Popover.tsx @@ -20,6 +20,7 @@ type CaretPosition = | 'right-top' type StyledPopoverProps = { + /* @deprecated `caret` is deprecated and will be removed in v38. */ caret?: CaretPosition relative?: boolean open?: boolean From 16335abf339c7d4f86599e5d800df40c42b7d34a Mon Sep 17 00:00:00 2001 From: Tyler Jones Date: Fri, 20 Sep 2024 10:02:26 -0400 Subject: [PATCH 2/3] Fix comment --- packages/react/src/Popover/Popover.tsx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/react/src/Popover/Popover.tsx b/packages/react/src/Popover/Popover.tsx index f28f942a239..711391b338d 100644 --- a/packages/react/src/Popover/Popover.tsx +++ b/packages/react/src/Popover/Popover.tsx @@ -20,7 +20,9 @@ type CaretPosition = | 'right-top' type StyledPopoverProps = { - /* @deprecated `caret` is deprecated and will be removed in v38. */ + /** + * @deprecated `caret` is deprecated and will be removed in v38. + */ caret?: CaretPosition relative?: boolean open?: boolean From 5458f7b38701fc4f4e85981b9a76f3bf8a4ee5ff Mon Sep 17 00:00:00 2001 From: Tyler Jones Date: Fri, 20 Sep 2024 10:56:07 -0400 Subject: [PATCH 3/3] Add changeset --- .changeset/tidy-bats-warn.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/tidy-bats-warn.md diff --git a/.changeset/tidy-bats-warn.md b/.changeset/tidy-bats-warn.md new file mode 100644 index 00000000000..fc748c57f56 --- /dev/null +++ b/.changeset/tidy-bats-warn.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Popover: Add note on deprecation of `caret` in v38