Home Docs

Separator

A Separator is a component that visually separates content into groups.

Usage

Basic
Simple Separator


Separator with text


Separator with icon
<BitSeparator />
<BitSeparator>Text</BitSeparator>
<BitSeparator><BitIcon IconName="Clock" /></BitSeparator>
Vertical
Item 1
Item 2
Item 3
Item 4
Item 5
<style>
    .custom-horizontal-layout {
        gap: 1rem;
        height: 3rem;
        display: flex;
        white-space: nowrap;
        align-items: center;
    }
</style>


<div class="custom-horizontal-layout">
    <span>Item 1</span>
    <BitSeparator Vertical />
    <span>Item 2</span>
    <BitSeparator Vertical />
    <span>Item 3</span>
    <BitSeparator Vertical />
    <span>Item 4</span>
    <BitSeparator Vertical />
    <span>Item 5</span>
</div>
AlignContent
Horizontal








Vertical

<BitSeparator AlignContent="@BitSeparatorAlignContent.Center">Center</BitSeparator>
<BitSeparator AlignContent="@BitSeparatorAlignContent.Start">Start</BitSeparator>
<BitSeparator AlignContent="@BitSeparatorAlignContent.End">End</BitSeparator>

<div style="height: 13rem">
    <BitSeparator Vertical AlignContent="@BitSeparatorAlignContent.Center">Center</BitSeparator>
    <BitSeparator Vertical AlignContent="@BitSeparatorAlignContent.Start">Start</BitSeparator>
    <BitSeparator Vertical AlignContent="@BitSeparatorAlignContent.End">End</BitSeparator>
</div>
FullWidth
While using inside a flex container with align-items css style:



<div style="display:flex;flex-direction:column;align-items:center">
    <BitSeparator>Default</BitSeparator>
    <BitSeparator AutoSize>AutoSize</BitSeparator>
</div>
Colors
Background:







Border:




<BitSeparator Background="BitColorKind.Primary">Primary</BitSeparator>
<BitSeparator Background="BitColorKind.Secondary">Secondary</BitSeparator>
<BitSeparator Background="BitColorKind.Tertiary">Tertiary</BitSeparator>
<BitSeparator Background="BitColorKind.Transparent">Transparent</BitSeparator>

<BitSeparator Border="BitColorKind.Primary">Primary</BitSeparator>
<BitSeparator Border="BitColorKind.Secondary">Secondary</BitSeparator>
<BitSeparator Border="BitColorKind.Tertiary">Tertiary</BitSeparator>
<BitSeparator Border="BitColorKind.Transparent">Transparent</BitSeparator>

API

BitSeparator parameters
Name
Type
Default value
Description
AlignContent BitSeparatorAlignContent BitSeparatorAlignContent.Center Where the content should be aligned in the separator.
AutoSize bool false Renders the separator with auto width or height.
Background BitColorKind? null The color kind of the background of the separator.
Border BitColorKind? null The color kind of the border of the separator.
ChildContent RenderFragment? null The content of the Separator, it can be any custom tag or text.
Vertical bool false Whether the element is a vertical separator.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitSeparatorAlignContent enum
Name
Value
Description
Start 0
Center 1
End 2
BitColorKind enum
Name
Value
Description
Primary 0 The primary color kind.
Secondary 1 The secondary color kind.
Tertiary 2 The tertiary color kind.
Transparent 3 The transparent color kind.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.

Or you can review / edit this page on GitHub.

Or you can review / edit this component on GitHub.
  • On this page