@codecademy/gamut
68.2.268.2.3-alpha.112ad1.0
dist/Popover/types.d.ts~
dist/Popover/types.d.tsModified+9−2
Index: package/dist/Popover/types.d.ts
===================================================================
--- package/dist/Popover/types.d.ts
+++ package/dist/Popover/types.d.ts
@@ -29,9 +29,12 @@
* Which horizontal edge of the source component to align against. Center aligns it centered to the component.
*/
position?: 'above' | 'below';
/**
- * Which side to position the beak. If not provided, beak will not be rendered. Position `center` Popovers can only be used with `center` beaks.
+ * Renders the beak. For `above` / `below`, use `center` for a centered triangle; pass
+ * `left` or `right` to pin the corner beak (or omit to derive the corner from `align`).
+ * With `GamutProvider`’s `useLogicalProperties` and an RTL target, `left` / `right` are
+ * mirrored the same way as `align` (logical start / end).
*/
beak?: 'left' | 'right' | 'center';
/**
* Pattern component to use as a background.
@@ -61,9 +64,13 @@
animation?: 'fade';
children: React.ReactElement<any>;
className?: string;
/**
- * Which vertical edge of the source component to align against.
+ * Horizontal alignment of the popover relative to the target. When
+ * `GamutProvider`'s `useLogicalProperties` is enabled, `left` and `right` follow the
+ * inline axis (leading/trailing): under RTL they resolve to the physical side that
+ * matches inline-start and inline-end, consistent with `useElementDir` on `targetRef`.
+ * Applies for all `position` values (`above`, `below`, `center`).
*/
align?: 'left' | 'right' | 'center';
/**
* Number of pixels to offset the popover vertically from the source component.