Popover: Deprecate the caret (#4997)

* deprecate the caret * Fix comment * Add changeset
primer · Sep 23, 2024 · dbfb504 · dbfb504
1 parent 48a56e9
commit dbfb504
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.changeset/tidy-bats-warn.md b/.changeset/tidy-bats-warn.md
@@ -0,0 +1,5 @@
+---
+'@primer/react': patch
+---
+
+Popover: Add note on deprecation of `caret` in v38
diff --git a/packages/react/src/Popover/Popover.tsx b/packages/react/src/Popover/Popover.tsx
@@ -20,6 +20,9 @@ type CaretPosition =
   | 'right-top'
 
 type StyledPopoverProps = {
+  /**
+   * @deprecated `caret` is deprecated and will be removed in v38.
+   */
   caret?: CaretPosition
   relative?: boolean
   open?: boolean