> For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt.

# Splitter

Layout`@rockshin/tao-ui`

[Examples](#examples)[API](#api)

Creates resizable panes separated by draggable handles.

## When to use

Use Splitter for work surfaces where users need to allocate space between adjacent panes.

**Recommended**

- Set sensible min sizes.
- Persist sizes only when the layout is user-specific.

**Avoid**

- Do not use the component outside its intended interaction model.

## Examples


### Basic usage
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

function SplitterExample() {
  return (
    <div
      style={{
        height: 220,
        border: '1px solid var(--tao-color-border-secondary)',
      }}
    >
      <Splitter>
        <Splitter.Panel defaultSize="40%">
          <div style={{ padding: 16 }}>Navigation</div>
        </Splitter.Panel>
        <Splitter.Panel>
          <div style={{ padding: 16 }}>Content</div>
        </Splitter.Panel>
      </Splitter>
    </div>
  );
}

export default SplitterExample;
```

### Vertical and multiple panels
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

function SplitterLayouts() {
  return (
    <div
      style={{
        height: 280,
        border: '1px solid var(--tao-color-border-secondary)',
      }}
    >
      <Splitter orientation="vertical">
        <Splitter.Panel defaultSize="35%" min={60}>
          <div style={{ padding: 16 }}>Preview</div>
        </Splitter.Panel>
        <Splitter.Panel min={80}>
          <div style={{ padding: 16 }}>Editor</div>
        </Splitter.Panel>
        <Splitter.Panel defaultSize="25%" min={60}>
          <div style={{ padding: 16 }}>Console</div>
        </Splitter.Panel>
      </Splitter>
    </div>
  );
}

export default SplitterLayouts;
```

### Collapsible panel
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

function CollapsibleSplitter() {
  return (
    <div
      style={{
        height: 220,
        border: '1px solid var(--tao-color-border-secondary)',
      }}
    >
      <Splitter>
        <Splitter.Panel defaultSize="30%" collapsible min={0}>
          <div style={{ padding: 16 }}>Collapsible navigation</div>
        </Splitter.Panel>
        <Splitter.Panel>
          <div style={{ padding: 16 }}>Main content</div>
        </Splitter.Panel>
      </Splitter>
    </div>
  );
}

export default CollapsibleSplitter;
```

### Three panels
Multiple panels share the available space; drag the adjacent separators to change their proportions.
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

const Panel = Splitter.Panel;

const boxStyle = (bg: string): React.CSSProperties => ({
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center',
  height: '100%',
  minHeight: 40,
  background: bg,
  borderRadius: 4,
  color: 'var(--tao-color-text-secondary)',
  fontSize: 14,
});

export default function SplitterThreePanels() {
  return (
    <div
      style={{
        height: 200,
        border: '1px solid var(--tao-color-border-secondary)',
        borderRadius: 6,
      }}
    >
      <Splitter>
        <Panel defaultSize="25%" min={60}>
          <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
            Sidebar
          </div>
        </Panel>
        <Panel min={100}>
          <div style={boxStyle('var(--tao-color-fill-tertiary)')}>Main</div>
        </Panel>
        <Panel defaultSize="25%" min={60}>
          <div style={boxStyle('var(--tao-color-fill-quaternary)')}>Detail</div>
        </Panel>
      </Splitter>
    </div>
  );
}
```

### Collapsible panels
Collapse and restore supporting panels while retaining the main work area.
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

const Panel = Splitter.Panel;

const boxStyle = (bg: string): React.CSSProperties => ({
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center',
  height: '100%',
  minHeight: 40,
  background: bg,
  borderRadius: 4,
  color: 'var(--tao-color-text-secondary)',
  fontSize: 14,
});

export default function SplitterCollapsible() {
  return (
    <div
      style={{
        height: 200,
        border: '1px solid var(--tao-color-border-secondary)',
        borderRadius: 6,
      }}
    >
      <Splitter>
        <Panel defaultSize="30%" collapsible min={0}>
          <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
            Collapsible
          </div>
        </Panel>
        <Panel>
          <div style={boxStyle('var(--tao-color-fill-tertiary)')}>
            Main Content
          </div>
        </Panel>
      </Splitter>
    </div>
  );
}
```

### Panel size limits
Constrain resizing with `min` and `max` so content remains usable.
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

const Panel = Splitter.Panel;

const boxStyle = (bg: string): React.CSSProperties => ({
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center',
  height: '100%',
  minHeight: 40,
  background: bg,
  borderRadius: 4,
  color: 'var(--tao-color-text-secondary)',
  fontSize: 14,
});

export default function SplitterMinMax() {
  return (
    <div
      style={{
        height: 200,
        border: '1px solid var(--tao-color-border-secondary)',
        borderRadius: 6,
      }}
    >
      <Splitter>
        <Panel defaultSize="30%" min={100} max={300}>
          <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
            min:100 max:300
          </div>
        </Panel>
        <Panel min={100}>
          <div style={boxStyle('var(--tao-color-fill-tertiary)')}>min:100</div>
        </Panel>
      </Splitter>
    </div>
  );
}
```

### Controlled panel sizes
Observe size changes and keep the layout in application state so it can be reset.
```tsx preview
import { Splitter, Stack } from '@rockshin/tao-ui';

import { useState } from 'react';

const Panel = Splitter.Panel;

const boxStyle = (bg: string): React.CSSProperties => ({
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center',
  height: '100%',
  minHeight: 40,
  background: bg,
  borderRadius: 4,
  color: 'var(--tao-color-text-secondary)',
  fontSize: 14,
});

export default function SplitterControlled() {
  function Demo() {
    const [sizes, setSizes] = useState<number[]>([]);
    return (
      <Stack gap="sm">
        <p style={{ fontSize: 13, color: 'var(--tao-color-text-secondary)' }}>
          sizes: [{sizes.map((s) => Math.round(s)).join(', ')}]
        </p>
        <div
          style={{
            height: 200,
            border: '1px solid var(--tao-color-border-secondary)',
            borderRadius: 6,
          }}
        >
          <Splitter onResize={setSizes}>
            <Panel defaultSize="40%">
              <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
                Left
              </div>
            </Panel>
            <Panel>
              <div style={boxStyle('var(--tao-color-fill-tertiary)')}>
                Right
              </div>
            </Panel>
          </Splitter>
        </div>
      </Stack>
    );
  }
  return <Demo />;
}
```

### Nested splitters
Combine horizontal and vertical splitters into an editor layout with bounded container heights.
```tsx preview
import { Splitter } from '@rockshin/tao-ui';

const Panel = Splitter.Panel;

const boxStyle = (bg: string): React.CSSProperties => ({
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center',
  height: '100%',
  minHeight: 40,
  background: bg,
  borderRadius: 4,
  color: 'var(--tao-color-text-secondary)',
  fontSize: 14,
});

export default function SplitterNested() {
  return (
    <div
      style={{
        height: 400,
        border: '1px solid var(--tao-color-border-secondary)',
        borderRadius: 6,
      }}
    >
      <Splitter>
        <Panel defaultSize="25%" collapsible min={0}>
          <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
            Sidebar
          </div>
        </Panel>
        <Panel>
          <Splitter orientation="vertical">
            <Panel defaultSize="70%">
              <div style={boxStyle('var(--tao-color-fill-tertiary)')}>
                Editor
              </div>
            </Panel>
            <Panel collapsible min={0}>
              <div style={boxStyle('var(--tao-color-fill-quaternary)')}>
                Terminal
              </div>
            </Panel>
          </Splitter>
        </Panel>
      </Splitter>
    </div>
  );
}
```

## API


### [#](#panel)Panel



| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| style | Additional style | `CSSProperties | undefined` | `-` |
| className | Additional css class | `string | undefined` | `-` |



### [#](#splitter)Splitter



| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| className | Additional css class | `string | undefined` | `-` |



### [#](#splitterpanel)Splitter.Panel



| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| style | Additional style | `CSSProperties | undefined` | `-` |
| className | Additional css class | `string | undefined` | `-` |

