HovercardHeading

Hovercard

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

Code examples

<HovercardProvider>
  <Hovercard>
    <HovercardHeading>Heading</HovercardHeading>
  </Hovercard>
</HovercardProvider>
<HovercardProvider>
  <Hovercard>
    <HovercardHeading>Heading</HovercardHeading>
  </Hovercard>
</HovercardProvider>

Optional Props

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, 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.

Some Ariakit components detect the type of the underlying element when they mount. If the render element's type may change while the component is mounted, pass a key⁠ prop that changes with the element type so React remounts the component with the new element. Remounting resets uncontrolled state, so keep the relevant state controlled:

<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>
<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>

Check out the Composition guide for more details.

`store`

HovercardStore | undefined
HovercardStore | undefined

Object returned by the useHovercardStore hook.

Note: This prop has no effect on this component. The heading is linked to the closest Hovercard component through React context, so it must be rendered inside the hovercard for the aria-labelledby prop to be set on the hovercard element.

HovercardHeading

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`