Popover
Popovers contain helpful information such as an explanation of a context.
install | yarn add @clayui/popover |
---|---|
version | 3.119.0 |
Stable3.119.0View in LexiconCHANGELOG
Property | Description |
---|---|
alignPosition typeof ALIGN_POSITIONS[number] | Position in which the tooltip will be aligned to the element. The default value is 'bottom' |
closeOnClickOutside boolean | Flag to indicate if the popover should be closed when
clicking outside, only works if used with trigger The default value is false |
containerProps IPortalBaseProps | Props to add to the The default value is {} |
defaultShow boolean | Sets the default value of show (uncontrolled). The default value is false |
disableScroll boolean | Flag to indicate if container should not be scrollable The default value is false |
displayType string | Appends the type to popover- |
show boolean | Flag to indicate if tooltip is displayed (controlled). |
onOffset (points: Point) => [number, number] | Callback for setting the offset of the popover from the trigger. The default value is (points) => OFFSET_MAP[points.join('') as keyof typeof OFFSET_MAP] as [ number, number ] |
onShowChange InternalDispatch<boolean> | Callback for when the show prop changes (controlled). |
size literal | Sets the size of the popover. |
trigger React.ReactElement &
Omit<React.RefAttributes<HTMLButtonElement>, 'key'> | React element that the popover will align to when clicked. |
header React.ReactNode | Content to display in the header of the popover. |