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

# Splitter

布局`@rockshin/tao-ui`

[代码演示](#代码演示)[API](#api)

通过可拖动分隔条调整相邻面板尺寸。

## 何时使用

用户需要在多个工作区域之间动态分配空间时使用 Splitter。

**推荐**

- 设置合理的最小尺寸。
- 可折叠面板必须保留可发现入口。

**避免**

- 移动端或简单阅读页不要滥用分隔面板。

## 代码演示


### 基础用法
```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;
```

### 垂直与多面板
```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;
```

### 可折叠面板
```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;
```

### 三个面板
多个 `Splitter.Panel` 共享可用空间，拖动相邻分隔条调整比例。
```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>
  );
}
```

### 折叠面板
允许辅助面板收起后恢复，保留主要工作区域。
```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>
  );
}
```

### 尺寸上下限
通过 `min` 与 `max` 约束拖动范围，避免内容缩小到不可操作。
```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>
  );
}
```

### 受控面板尺寸
监听尺寸变化并保存当前布局，可由应用逻辑重置布局。
```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 />;
}
```

### 嵌套分栏
横向与纵向分栏组合出编辑器布局，每个容器都有明确高度。
```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



| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| style | 节点样式 | `CSSProperties | undefined` | `-` |
| className | 节点类名 | `string | undefined` | `-` |



### [#](#splitter)Splitter



| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| className | 节点类名 | `string | undefined` | `-` |



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



| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| style | 节点样式 | `CSSProperties | undefined` | `-` |
| className | 节点类名 | `string | undefined` | `-` |

