Divider
Horizontal or vertical separator using theme border tokens.
Preview
A live, theme-aware example rendered with the published component.
Loading preview…
Import
Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.
tsximport { Divider } from "@tavojs/ui/divider";The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/divider.
When to use
Use it when
Choose something else when
Examples
These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.
Divider example
tsximport { Divider } from "@tavojs/ui/divider";
export function DividerExample1() {
return (
<>
<Divider label="Details" />
</>
);
}Common props and defaults
A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
as | string | Component<Record<string, unknown>> | — | Changes the rendered root element or component while preserving Tavo.js UI styling and public props. |
orientation | "horizontal" | "vertical" | — | Configures orientation for this component. |
label | Child | — | Configures label for this component. |
Complete TypeScript API
Import from @tavojs/ui/divider. Published exports: Divider, DividerProps.
DividerProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by Divider. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by Divider. |
id | string | No | Inherited id attribute accepted by Divider. |
role | string | No | Inherited role attribute accepted by Divider. |
style | Record<string, unknown> | No | Inherited style attribute accepted by Divider. |
title | string | No | Inherited title attribute accepted by Divider. |
tabIndex | number | No | Inherited tabIndex attribute accepted by Divider. |
hidden | boolean | No | Inherited hidden attribute accepted by Divider. |
disabled | boolean | No | Inherited disabled attribute accepted by Divider. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by Divider. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by Divider. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by Divider. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by Divider. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by Divider. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by Divider. |
as | PolymorphicAs | No | Changes the rendered root element or component while preserving Tavo.js UI styling and public props. |
orientation | "horizontal" | "vertical" | No | Configures orientation for this component. |
label | Child | No | Configures label for this component. |
State ownership and DOM target
| Concern | Contract |
|---|---|
| State | No component state contract is exposed; the application owns the rendered content and surrounding behavior. |
| DOM target | The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there. |
Anatomy and related components
Limitations
Avoid Divider when for interactive form state; combine with form, feedback, or data components instead.
Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.
Accessibility
Layout primitives are semantic-neutral unless a component prop selects an element role.
Choose semantic elements such as main, nav, aside, or section when the region has document meaning.
Keep heading order and landmark labels app-owned.
Component status
| Contract | Current value |
|---|---|
| Maturity | stable |
| Category | layout |
| Component import | @tavojs/ui/divider |
| Explicit CSS import | @tavojs/ui/css/divider |
| Preview | Interactive preview available on this page |