ContentSeparator
A ContentSeparator
is a component that divides or separates content visually within a layout. It serves as a visual cue to distinguish between different sections or groups of content, helping to improve readability and organization.
Properties
orientation (default: "horizontal")
Sets the main axis of the component
Available values:
Value | Description |
---|---|
horizontal | The component will fill the available space horizontally (default) |
vertical | The component will fill the available space vertically |
See the demo for an example under size
.
The component will not be displayed if the orientation is set to vertical
but the height of the parent container is not explicitly set to a value other than 0 or percentage is used as the size unit (e.g. 20%).
This is true even if the ContentSeparator
has siblings in the container.
The demo below illustrates this.
Notice how the first ContentSeparator
does not show up while the second does:
<App>
<HStack horizontalAlignment="center">
<ContentSeparator orientation="vertical" size="8px" backgroundColor="blue" />
</HStack>
<HStack horizontalAlignment="center" height="48px">
<ContentSeparator orientation="vertical" size="8px" backgroundColor="red" />
</HStack>
</App>
size
This property defines the component's height (if the orientation
is horizontal) or the width (if the orientation
is vertical).
<App>
<Heading level="h2">
Lorem Ipsum
</Heading>
<ContentSeparator />
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi
ut aliquip ex ea commodo consequat.
<ContentSeparator size="4px" />
<HStack height="120px">
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
<ContentSeparator orientation="vertical" size="10px" />
Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam,
eaque ipsa quae ab illo inventore veritatis et quasi architecto
beatae vitae dicta sunt explicabo.
</HStack>
</App>
You can use the width
and height
layout properties to set the ContentSeparator
dimensions.
For the horizontal separator, you can set the height
property; the vertical separator offers the width
property instead of size
.
Nonetheless, we suggest you use the size
property.
Events
This component does not have any events.
Exposed Methods
This component does not expose any methods.
Styling
The ContentSeparator
component uses these theme variables to customize its appearance:
backgroundColor-ContentSeparator
size-ContentSeparator
"backgroundColor-ContentSeparator": "$color-primary-200",
"size-ContentSeparator": "6px"
Theme Variables
Variable | Default Value (Light) | Default Value (Dark) |
---|---|---|
backgroundColor-ContentSeparator | $borderColor | $borderColor |
size-ContentSeparator | 1px | 1px |