Heading

Renders a heading element. The element type (or the aria-level attribute, if the element type is not a native heading) is determined by the context level provided by the closest HeadingLevel ancestor.

Code examples

<HeadingLevel>
  <Heading>Heading 1</Heading>
  <HeadingLevel>
    <Heading>Heading 2</Heading>
  </HeadingLevel>
</HeadingLevel>
<HeadingLevel>
  <Heading>Heading 1</Heading>
  <HeadingLevel>
    <Heading>Heading 2</Heading>
  </HeadingLevel>
</HeadingLevel>

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.

Heading

Code examples

Optional Props

render

Stay tuned

`render`