@eds/popover
v4.2.5
Popover
A contextual overlay to provide additional information or actions.Prop | Required | Description | Type |
---|---|---|---|
content | ✅ | Content inside the popover. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
children | — | Component that will trigger the popover. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
collisionPadding | — | The distance in pixels from the trigger to the edge. | number | Partial<Record<"top" | "right" | "bottom" | "left", number>> |
blank | — | Remove all styles on the popover. | boolean |
side | — | Define which side of the trigger the Popover will be displayed | "top" | "right" | "bottom" | "left" |
align | — | Alignment of the popover. | "start" | "center" | "end" |
defaultOpen | — | Set the popover to be open by default. | boolean |
isOpen | — | Control the state of the popover. | boolean |
onOpenChange | — | Callback when the popover changes the state. | (open: boolean) => void |
onEscapeKeyDown | — | Callback when the escape key is pressed. | (event: KeyboardEvent) => void |
modal | — | The modality of the popover. When set to true, interaction with outside elements will be disabled and only popover content will be visible to screen readers. | boolean |