import { Link, Strong, Text } from "@chakra-ui/react"
import {
HoverCardArrow,
HoverCardContent,
HoverCardRoot,
HoverCardTrigger,
} from "@/components/ui/hover-card"
const Demo = () => {
return (
<HoverCardRoot size="sm">
<HoverCardTrigger asChild>
<Link href="#">@chakra_ui</Link>
</HoverCardTrigger>
<HoverCardContent maxWidth="240px">
<HoverCardArrow />
<Text as="div" marginTrim="in-flow">
<Strong>Chakra</Strong> is a Sanskrit word that means disk or wheel,
referring to energy centers in the body
</Text>
</HoverCardContent>
</HoverCardRoot>
)
}
Setup
If you don't already have the snippet, run the following command to add the
hover-card snippet
chakra snippet add hover-cardThe snippet includes component compositions based on the HoverCard component.
Usage
import {
HoverCardArrow,
HoverCardContent,
HoverCardRoot,
HoverCardTrigger,
} from "@/components/ui/popover"<HoverCardRoot>
<HoverCardTrigger />
<HoverCardContent>
<HoverCardArrow />
</HoverCardContent>
</HoverCardRoot>Examples
Controlled
Use the open and onOpenChange to control the visibility of the hover card.
"use client"
import { Link, Strong, Text } from "@chakra-ui/react"
import {
HoverCardArrow,
HoverCardContent,
HoverCardRoot,
HoverCardTrigger,
} from "@/components/ui/hover-card"
import { useState } from "react"
const Demo = () => {
const [open, setOpen] = useState(false)
return (
<HoverCardRoot size="sm" open={open} onOpenChange={(e) => setOpen(e.open)}>
<HoverCardTrigger asChild>
<Link href="#">@chakra_ui</Link>
</HoverCardTrigger>
<HoverCardContent maxWidth="240px">
<HoverCardArrow />
<Text as="div" marginTrim="in-flow">
<Strong>Chakra</Strong> is a Sanskrit word that means disk or wheel,
referring to energy centers in the body
</Text>
</HoverCardContent>
</HoverCardRoot>
)
}
Delays
Control the open and close delays using the openDelay and closeDelay props.
import { Link, Strong, Text } from "@chakra-ui/react"
import {
HoverCardArrow,
HoverCardContent,
HoverCardRoot,
HoverCardTrigger,
} from "@/components/ui/hover-card"
const Demo = () => {
return (
<HoverCardRoot size="sm" openDelay={1000} closeDelay={100}>
<HoverCardTrigger asChild>
<Link href="#">@chakra_ui</Link>
</HoverCardTrigger>
<HoverCardContent maxWidth="240px">
<HoverCardArrow />
<Text as="div" marginTrim="in-flow">
<Strong>Chakra</Strong> is a Sanskrit word that means disk or wheel,
referring to energy centers in the body
</Text>
</HoverCardContent>
</HoverCardRoot>
)
}
Placement
Use the positioning.placement prop to configure the underlying floating-ui
positioning logic.
import { Link, Strong, Text } from "@chakra-ui/react"
import {
HoverCardArrow,
HoverCardContent,
HoverCardRoot,
HoverCardTrigger,
} from "@/components/ui/hover-card"
const Demo = () => {
return (
<HoverCardRoot size="sm" positioning={{ placement: "top" }}>
<HoverCardTrigger asChild>
<Link href="#">@chakra_ui</Link>
</HoverCardTrigger>
<HoverCardContent maxWidth="240px">
<HoverCardArrow />
<Text as="div" marginTrim="in-flow">
<Strong>Chakra</Strong> is a Sanskrit word that means disk or wheel,
referring to energy centers in the body
</Text>
</HoverCardContent>
</HoverCardRoot>
)
}
Accessibility
HoverCard should be used solely for supplementary information that is not essential for understanding the context.
It is inaccessible to screen readers and cannot be activated via keyboard, so avoid placing crucial content within it.
Props
| Prop | Default | Type |
|---|---|---|
closeDelay | '300' | numberThe duration from when the mouse leaves the trigger or content until the hover card closes. |
lazyMount | false | booleanWhether to enable lazy mounting |
openDelay | '700' | numberThe duration from when the mouse enters the trigger until the hover card opens. |
unmountOnExit | false | booleanWhether to unmount on exit. |
colorPalette | 'gray' | 'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink' | 'accent'The color palette of the component |
size | 'md' | 'xs' | 'sm' | 'md' | 'lg'The size of the component |
defaultOpen | booleanThe initial open state of the hover card when it is first rendered. Use when you do not need to control its open state. | |
id | stringThe unique identifier of the machine. | |
ids | Partial<{
trigger: string
content: string
positioner: string
arrow: string
}>The ids of the elements in the popover. Useful for composition. | |
immediate | booleanWhether to synchronize the present change immediately or defer it to the next frame | |
onExitComplete | () => voidFunction called when the animation ends in the closed state | |
onOpenChange | (details: OpenChangeDetails) => voidFunction called when the hover card opens or closes. | |
open | booleanWhether the hover card is open | |
positioning | PositioningOptionsThe user provided options used to position the popover content | |
present | booleanWhether the node is present (controlled by the user) | |
as | React.ElementTypeThe underlying element to render. | |
asChild | booleanUse the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide. | |
unstyled | booleanWhether to remove the component's style. |