Separator

A separator element accessible to screen readers.

import { Separator } from '@base-ui/react/separator';
import styles from './index.module.css';

export default function ExampleSeparator() {
  return (
    <div className={styles.Container}>
      <a href="#" className={styles.Link}>
        Home
      </a>
      <a href="#" className={styles.Link}>
        Pricing
      </a>
      <a href="#" className={styles.Link}>
        Blog
      </a>
      <a href="#" className={styles.Link}>
        Support
      </a>

      <Separator orientation="vertical" className={styles.Separator} />

      <a href="#" className={styles.Link}>
        Log in
      </a>
      <a href="#" className={styles.Link}>
        Sign up
      </a>
    </div>
  );
}

Anatomy

Import the component and use it as a single part:

Anatomy

import { Separator } from '@base-ui/react/separator';

<Separator />

API reference

orientationOrientation'horizontal'

Name: orientation
Description: The orientation of the separator.
Type: 'horizontal' | 'vertical' | undefined
Default: 'horizontal'

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Separator.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Separator.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Separator.State, ) => ReactElement) | undefined

data-orientation

Indicates the orientation of the separator.

Attribute	Description	-
`data-orientation`	Indicates the orientation of the separator.

Separator.PropsHide

Re-Export of Separator props as SeparatorProps

Separator.StateHide

type SeparatorState = {
  /** The orientation of the separator. */
  orientation: 'horizontal' | 'vertical';
}