SplitPane

Fixed two-region main/aside layout with responsive ratio, side, and gap.

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.

TSX

tsximport { SplitPane } from "@tavojs/ui/split-pane";

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/split-pane.

When to use

Use it when

Use SplitPane for stable main-and-aside layouts such as navigation plus content or inspector plus canvas.

Choose something else when

Use Spacer only for empty distance, and Resizable only when the application will add adjustable panel behavior.

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.

SplitPane example

TSXCreate: src/components/examples/SplitPaneExample1.tsx

tsximport { SplitPane } from "@tavojs/ui/split-pane";
import { Card } from "@tavojs/ui";

export function SplitPaneExample1() {
  return (
    <>
      <SplitPane aside={<Card />}>Main content</SplitPane>
    </>
  );
}

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.
`aside`	`Child`	—	Configures aside for this component.
`side`	`"left" \| "right"`	—	Configures side for this component.
`ratio`	`ResponsiveValue<"third" \| "half" \| "golden">`	—	Configures ratio for this component.
`gap`	`ResponsiveValue<"none" \| "sm" \| "md" \| "lg">`	—	Configures gap for this component.

Complete TypeScript API

Import from @tavojs/ui/split-pane. Published exports: SplitPane, SplitPaneAside, SplitPaneMain, SplitPaneProps, SplitPaneRegionProps, SplitPaneRoot.

`SplitPaneProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by SplitPane.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by SplitPane.
`id`	`string`	No	Inherited id attribute accepted by SplitPane.
`role`	`string`	No	Inherited role attribute accepted by SplitPane.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by SplitPane.
`title`	`string`	No	Inherited title attribute accepted by SplitPane.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by SplitPane.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by SplitPane.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by SplitPane.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by SplitPane.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by SplitPane.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by SplitPane.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by SplitPane.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by SplitPane.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by SplitPane.
`aside`	`import("/Users/hrach/Documents/Projects/Codex/tavo-ui-monorepo/node_modules/@tavojs/core/dist/jsx").Child`	No	Configures aside for this component.
`side`	`"left" \| "right"`	No	Configures side for this component.
`ratio`	`ResponsiveValue<SplitPaneRatio>`	No	Configures ratio for this component.
`gap`	`ResponsiveValue<Gap>`	No	Configures gap for this component.

`SplitPaneRegionProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by SplitPane.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by SplitPane.
`id`	`string`	No	Inherited id attribute accepted by SplitPane.
`role`	`string`	No	Inherited role attribute accepted by SplitPane.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by SplitPane.
`title`	`string`	No	Inherited title attribute accepted by SplitPane.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by SplitPane.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by SplitPane.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by SplitPane.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by SplitPane.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by SplitPane.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by SplitPane.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by SplitPane.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by SplitPane.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by SplitPane.

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	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

Public compound members: Root, Aside, Main

Limitations

Use Spacer only for empty distance, and Resizable only when the application will add adjustable panel behavior.

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/split-pane`
Explicit CSS import	`@tavojs/ui/css/split-pane`
Preview	Interactive preview available on this page