Skip to content

Divider

A horizontal divider/separator component.

Basic Usage

blade
<x-basekit-ui::divider />

Props

PropTypeDefaultDescription
orientationstring'horizontal'Divider direction (horizontal,vertical)
variantstring'solid'Divider style (solid,dashed,dotted)
tonestring'default'Divider color preset (light,default,dark)
labelstringnullOptional horizontal divider label

Simple Divider

blade
<div>
    <p>Section 1</p>
    <x-basekit-ui::divider />
    <p>Section 2</p>
</div>

With Label

blade
<x-basekit-ui::divider label="OR" />

<x-basekit-ui::divider>
    <span class="px-2 bg-white text-gray-500">Continue</span>
</x-basekit-ui::divider>

Variants

Supported variants: solid, dashed, dotted.

blade
<x-basekit-ui::divider variant="solid" />
<x-basekit-ui::divider variant="dashed" />
<x-basekit-ui::divider variant="dotted" />

Tones

Supported tones: light, default, dark (dark is the highest contrast).

blade
<x-basekit-ui::divider tone="light" class="my-3" />
<x-basekit-ui::divider tone="default" class="my-3" />
<x-basekit-ui::divider tone="dark" class="my-3" />

Vertical Divider

blade
<x-basekit-ui::divider orientation="vertical" class="h-6" />

In Forms Example

blade
<form>
    <x-basekit-ui::input name="email" label="Email" />
    <x-basekit-ui::input name="password" label="Password" />

    <x-basekit-ui::divider label="OR" />

    <x-basekit-ui::button variant="ghost" class="w-full mt-2">
        Sign in with Google
    </x-basekit-ui::button>
</form>

Custom Classes

Override or extend styles with the class attribute:

blade
<x-basekit-ui::divider class="my-6" />

CSS Variables

Customize divider appearance via CSS variables:

css
:root {
  --divider-color: var(--color-slate-200);
  --divider-color-light: var(--color-slate-100);
  --divider-color-default: var(--color-slate-200);
  --divider-color-dark: var(--color-slate-400);
  --divider-label-bg: var(--surface-base);
  --divider-label-color: var(--color-slate-500);
}

Configuration

php
'divider' => [
    'enabled' => true,
    'orientations' => ['horizontal', 'vertical'],
    'default_orientation' => 'horizontal',
    'variants' => ['solid', 'dashed', 'dotted'],
    'default_variant' => 'solid',
    'tones' => ['light', 'default', 'dark'],
    'default_tone' => 'default',
],

Released under the MIT License.