Skip to main content

Divider API

Available from version 0.3.0

API reference docs for the React Divider component. Learn about the props of this exported module.

Demos​

tip

For examples and details on the usage of this React component, visit the component demo pages:

Import​

import { Divider } from 'tailwind-joy/components';

Props​

info

The ref is forwarded to the root element.

children​

The content of the component.

  • Type: ReactNode

className​

Class name applied to the root element.

  • Type: string

component​

Available from version 0.4.0

The component used for the root node.

  • Type: keyof JSX.IntrinsicElements
  • Default: 'hr'

inset​

A class name is applied to the divider to shrink or stretch the line based on the orientation.

  • Type: 'none' | 'context'
  • Default: 'none'

orientation​

The component orientation.

  • Type: 'horizontal' | 'vertical'
  • Default: 'horizontal'

slotProps​

Available from version 0.4.0

The props used for each slot inside.

  • Type: 
    {
      root?: ComponentProps<'hr'>;
    }
  • Default: {}