Light Dark System

Divider

<ol-divider> | OlDivider
Since 1.0 stable

Dividers are used to visually separate or group elements.

<ol-divider></ol-divider>

import OlDivider from '@onlive.site/ui/dist/react/divider';

const App = () => <OlDivider />;

Examples

Width

Use the --width custom property to change the width of the divider.

<ol-divider style="--width: 4px;"></ol-divider>

import OlDivider from '@onlive.site/ui/dist/react/divider';

const App = () => <OlDivider style={{ '--width': '4px' }} />;

Color

Use the --color custom property to change the color of the divider.

<ol-divider style="--color: tomato;"></ol-divider>

import OlDivider from '@onlive.site/ui/dist/react/divider';

const App = () => <OlDivider style={{ '--color': 'tomato' }} />;

Spacing

Use the --spacing custom property to change the amount of space between the divider and it’s neighboring elements.

Above Below 
<div style="text-align: center;">
  Above
  <ol-divider style="--spacing: 2rem;"></ol-divider>
  Below
</div>

import OlDivider from '@onlive.site/ui/dist/react/divider';

const App = () => (
  <>
    Above
    <OlDivider style={{ '--spacing': '2rem' }} />
    Below
  </>
);

Vertical

Add the vertical attribute to draw the divider in a vertical orientation. The divider will span the full height of its container. Vertical dividers work especially well inside of a flex container.

First Middle Last 
<div style="display: flex; align-items: center; height: 2rem;">
  First
  <ol-divider vertical></ol-divider>
  Middle
  <ol-divider vertical></ol-divider>
  Last
</div>

import OlDivider from '@onlive.site/ui/dist/react/divider';

const App = () => (
  <div
    style={{
      display: 'flex',
      alignItems: 'center',
      height: '2rem'
    }}
  >
    First
    <OlDivider vertical />
    Middle
    <OlDivider vertical />
    Last
  </div>
);

Use dividers in menus to visually group menu items.

Option 1 Option 2 Option 3 Option 4 Option 5 Option 6 
<ol-menu style="max-width: 200px;">
  <ol-menu-item value="1">Option 1</ol-menu-item>
  <ol-menu-item value="2">Option 2</ol-menu-item>
  <ol-menu-item value="3">Option 3</ol-menu-item>
  <ol-divider></ol-divider>
  <ol-menu-item value="4">Option 4</ol-menu-item>
  <ol-menu-item value="5">Option 5</ol-menu-item>
  <ol-menu-item value="6">Option 6</ol-menu-item>
</ol-menu>

import OlDivider from '@onlive.site/ui/dist/react/divider';
import OlMenu from '@onlive.site/ui/dist/react/menu';
import OlMenuItem from '@onlive.site/ui/dist/react/menu-item';

const App = () => (
  <OlMenu style={{ maxWidth: '200px' }}>
    <OlMenuItem value="1">Option 1</OlMenuItem>
    <OlMenuItem value="2">Option 2</OlMenuItem>
    <OlMenuItem value="3">Option 3</OlMenuItem>
    <ol-divider />
    <OlMenuItem value="4">Option 4</OlMenuItem>
    <OlMenuItem value="5">Option 5</OlMenuItem>
    <OlMenuItem value="6">Option 6</OlMenuItem>
  </OlMenu>
);

Tailwind users

Using TailwindCSS with OnliveUI may override divider styles, making them invisible. As a workaround, add this to your Tailwind config file. 

@layer base {
  ol-divider:not([vertical]) {
    border-top: solid var(--width) var(--color);
  }

  ol-divider[vertical] {
    border-left: solid var(--width) var(--color);
  }
}

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

Script Import Bundler React

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.onlive.site/@onlive.site/ui@1.8.20/cdn/components/divider/divider.js"></script>

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.onlive.site/@onlive.site/ui@1.8.20/cdn/components/divider/divider.js';

To import this component using a bundler:

import '@onlive.site/ui/dist/components/divider/divider.js';

To import this component as a React component:

import OlDivider from '@onlive.site/ui/dist/react/divider';

Properties

Name Description Reflects Type Default
vertical Draws the divider in a vertical orientation. boolean false
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Custom Properties

Name Description Default
--color The color of the divider.
--width The width of the divider.
--spacing The spacing of the divider.

Learn more about customizing CSS custom properties.