Hover Card

Used to display content when hovering over an element

Follow @saas_js for updates

'use client'

import { Stack, Text } from '@chakra-ui/react'
import { Avatar, HoverCard, Link } from '@saas-ui/react'

export const HoverCardBasic = () => {
  return (
    <HoverCard.Root size="sm">
      Follow{' '}
      <HoverCard.Trigger asChild>
        <Link href="#" colorPalette="accent">
          @saas_js
        </Link>
      </HoverCard.Trigger>{' '}
      for updates
      <HoverCard.Content>
        <HoverCard.Arrow />
        <Stack gap="4" direction="row">
          <Avatar
            name="Saas UI"
            src="https://pbs.twimg.com/profile_images/1542114663420383235/Otz6CbhI_400x400.png"
          />
          <Stack gap="0">
            <Text textStyle="sm" fontWeight="semibold">
              Saas UI
            </Text>
            <Text textStyle="xs" color="fg.muted" mb="2">
              @saas_js
            </Text>
            <Text textStyle="sm" color="fg.muted">
              Design system and React components for startups.
            </Text>
          </Stack>
        </Stack>
      </HoverCard.Content>
    </HoverCard.Root>
  )
}

Anatomy

import { HoverCard } from '@saas-ui/react/hover-card'

<HoverCard.Root>
  <HoverCard.Trigger />
  <HoverCard.Content>
    <HoverCard.Arrow />
  </HoverCard.Content>
</HoverCard.Root>

Examples

Controlled

Use the open and onOpenChange to control the visibility of the hover card.

Follow @saas_js for updates

'use client'

import { useState } from 'react'

import { Stack, Text } from '@chakra-ui/react'
import { Avatar, HoverCard, Link } from '@saas-ui/react'

export const HoverCardControlled = () => {
  const [open, setOpen] = useState(false)
  return (
    <HoverCard.Root size="sm" open={open} onOpenChange={(e) => setOpen(e.open)}>
      Follow{' '}
      <HoverCard.Trigger asChild>
        <Link href="#" colorPalette="accent">
          @saas_js
        </Link>
      </HoverCard.Trigger>{' '}
      for updates
      <HoverCard.Content>
        <HoverCard.Arrow />
        <Stack gap="4" direction="row">
          <Avatar
            name="Saas UI"
            src="https://pbs.twimg.com/profile_images/1542114663420383235/Otz6CbhI_400x400.png"
          />
          <Stack gap="0">
            <Text textStyle="sm" fontWeight="semibold">
              Saas UI
            </Text>
            <Text textStyle="xs" color="fg.muted" mb="2">
              @saas_js
            </Text>
            <Text textStyle="sm" color="fg.muted">
              Design system and React components for startups.
            </Text>
          </Stack>
        </Stack>
      </HoverCard.Content>
    </HoverCard.Root>
  )
}

Delays

Control the open and close delays using the openDelay and closeDelay props.

Follow @saas_js for updates

'use client'

import { Stack, Text } from '@chakra-ui/react'
import { Avatar, HoverCard, Link } from '@saas-ui/react'

export const HoverCardWithDelay = () => {
  return (
    <HoverCard.Root size="sm" openDelay={1000} closeDelay={100}>
      Follow{' '}
      <HoverCard.Trigger asChild>
        <Link href="#" colorPalette="accent">
          @saas_js
        </Link>
      </HoverCard.Trigger>{' '}
      for updates
      <HoverCard.Content>
        <HoverCard.Arrow />
        <Stack gap="4" direction="row">
          <Avatar
            name="Saas UI"
            src="https://pbs.twimg.com/profile_images/1542114663420383235/Otz6CbhI_400x400.png"
          />
          <Stack gap="0">
            <Text textStyle="sm" fontWeight="semibold">
              Saas UI
            </Text>
            <Text textStyle="xs" color="fg.muted" mb="2">
              @saas_js
            </Text>
            <Text textStyle="sm" color="fg.muted">
              Design system and React components for startups.
            </Text>
          </Stack>
        </Stack>
      </HoverCard.Content>
    </HoverCard.Root>
  )
}

Placement

Use the positioning.placement prop to configure the underlying floating-ui positioning logic.

Follow @saas_js for updates

'use client'

import { Stack, Text } from '@chakra-ui/react'
import { Avatar, HoverCard, Link } from '@saas-ui/react'

export const HoverCardWithPlacement = () => {
  return (
    <HoverCard.Root size="sm" positioning={{ placement: 'top' }}>
      Follow{' '}
      <HoverCard.Trigger asChild>
        <Link href="#" colorPalette="accent">
          @saas_js
        </Link>
      </HoverCard.Trigger>{' '}
      for updates
      <HoverCard.Content>
        <HoverCard.Arrow />
        <Stack gap="4" direction="row">
          <Avatar
            name="Saas UI"
            src="https://pbs.twimg.com/profile_images/1542114663420383235/Otz6CbhI_400x400.png"
          />
          <Stack gap="0">
            <Text textStyle="sm" fontWeight="semibold">
              Saas UI
            </Text>
            <Text textStyle="xs" color="fg.muted" mb="2">
              @saas_js
            </Text>
            <Text textStyle="sm" color="fg.muted">
              Design system and React components for startups.
            </Text>
          </Stack>
        </Stack>
      </HoverCard.Content>
    </HoverCard.Root>
  )
}

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'`	`number` The duration from when the mouse leaves the trigger or content until the hover card closes.
`lazyMount`	`false`	`boolean` Whether to enable lazy mounting
`openDelay`	`'700'`	`number` The duration from when the mouse enters the trigger until the hover card opens.
`unmountOnExit`	`false`	`boolean` Whether 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`		`boolean` The initial open state of the hover card when it is first rendered. Use when you do not need to control its open state.
`id`		`string` The 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`		`boolean` Whether to synchronize the present change immediately or defer it to the next frame
`onExitComplete`		`() => void` Function called when the animation ends in the closed state
`onOpenChange`		`(details: OpenChangeDetails) => void` Function called when the hover card opens or closes.
`open`		`boolean` Whether the hover card is open
`positioning`		`PositioningOptions` The user provided options used to position the popover content
`present`		`boolean` Whether the node is present (controlled by the user)
`as`		`React.ElementType` The underlying element to render.
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`unstyled`		`boolean` Whether to remove the component's style.

File Upload

Icon

Hover Card

.css-vfo6uh{color:var(--chakra-colors-fg);-webkit-text-decoration:underline;text-decoration:underline;text-underline-offset:3px;text-decoration-thickness:2px;text-decoration-color:var(--chakra-colors-border-emphasized);font-weight:500;}Anatomy

Examples

Controlled

Delays

Placement

Accessibility

Props

Anatomy