HovercardDescription

Hovercard

Renders a description in a hovercard. This component must be wrapped within Hovercard so the aria-describedby prop is properly set on the content element.

Code examples

<HovercardProvider>
  <Hovercard>
    <HovercardDescription>Description</HovercardDescription>
  </Hovercard>
</HovercardProvider>
<HovercardProvider>
  <Hovercard>
    <HovercardDescription>Description</HovercardDescription>
  </Hovercard>
</HovercardProvider>

Optional Props

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged.

Check out the Composition guide for more details.

`store`

HovercardStore | undefined
HovercardStore | undefined

Object returned by the useHovercardStore hook. If not provided, the closest Hovercard or HovercardProvider components' context will be used.

HovercardDescription

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`