HovercardProvider
Provides a hovercard store to Hovercard components.
Code examples
Optional Props
defaultOpen
boolean | undefined = false
Whether the content should be visible by default.
disclosure
DisclosureStore | null | undefined
A reference to another disclosure store that controls another disclosure
component to keep them in sync. Element states like contentElement
and
disclosureElement
won't be synced. For that, use the
store
prop
instead.
Live examples
hideTimeout
number | undefined
The amount of time in milliseconds to wait before hiding the popup. It
defaults to the value passed to
timeout
.
Live examples
open
boolean = false
Whether the content is visible.
Live examples
placement
Placement = "bottom"
The placement of the popover.
Live examples
popover
PopoverStore | null | undefined
A reference to another popover store that's controlling another popover to keep them in sync.
setMounted
((mounted: boolean) => void) | undefined
A callback that gets called when the mounted
state changes.
Code examples
const [mounted, setMounted] = useState(false);
setOpen
((open: boolean) => void) | undefined
A callback that gets called when the
open
state
changes.
Code examples
const [open, setOpen] = useState(false);
showTimeout
number | undefined
The amount of time in milliseconds to wait before showing the popup. It
defaults to the value passed to
timeout
.
Live examples
store
Store<Partial<S>> | undefined
Another store object that will be kept in sync with the original store.
Live examples
timeout
number = 500
The amount of time in milliseconds to wait before showing and hiding the
popup. To control the delay for showing and hiding separately, use
showTimeout
and
hideTimeout
.
animated
animated
number | boolean | undefined
Deprecated: Manually setting the animated
prop is no longer necessary.
This will be removed in a future release.
Determines whether the content should animate when it is shown or hidden.
If
true
, theanimating
state will betrue
when the content is shown or hidden and it will wait for a CSS animation/transition to end before becomingfalse
.If it's set to a number, the
animating
state will betrue
when the content is shown or hidden and it will wait for the number of milliseconds to pass before becomingfalse
.