Splitter
Resizable split panel layout
When To Use
Can be used to separate areas horizontally or vertically. When you need to freely drag and adjust the size of each area. When you need to specify the maximum and minimum width and height of an area.
Examples
- Basic ·
size - Control mode ·
control - Vertical ·
vertical - Collapsible ·
collapsible - Control collapsible icons ·
collapsibleIcon - Multiple panels ·
multiple - Complex combination ·
group - Lazy ·
lazy - Customize ·
customize - Custom semantic dom styling ·
style-class - Double-clicked reset ·
reset
API
Common props ref：Common props
The Splitter component needs to calculate the panel size through its child elements, so its child elements only support
Splitter.Panel.
Splitter
| Property | Description | Type | Default | Version | Global Config |
|---|---|---|---|---|---|
| classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 6.0.0 | 6.0.0 |
| collapsible | motion to enable collapse animation, icon to customize collapse icons | { motion?: boolean; icon?: { start?: ReactNode; end?: ReactNode } } | - | 6.4.0 | × |
| custom collapsible icon | {start?: ReactNode; end?: ReactNode} | - | 6.0.0 | × | |
| destroyOnHidden | Destroy panel content when collapsed (size is 0). Applies to all panels, can be overridden per panel | boolean | false | 6.4.0 | × |
| draggerIcon | custom dragger icon | ReactNode | - | 6.0.0 | × |
| Layout direction | horizontal | vertical | horizontal | - | × | |
| lazy | Lazy mode | boolean | false | 5.23.0 | × |
| onCollapse | Callback when expanding or collapsing | (collapsed: boolean[], sizes: number[]) => void | - | 5.28.0 | × |
| orientation | Orientation direction | horizontal | vertical | horizontal | 6.0.0 | × |
| styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 6.0.0 | 6.0.0 |
| vertical | Orientation. Simultaneously existing with orientation, orientation takes priority | boolean | false | 6.0.0 | × |
| onDraggerDoubleClick | Callback triggered when the dragger is double-clicked | (index: number) => void | - | 6.3.0 | × |
| onResize | Panel size change callback | (sizes: number[]) => void | - | - | × |
| onResizeEnd | Drag end callback | (sizes: number[]) => void | - | - | × |
| onResizeStart | Callback before dragging starts | (sizes: number[]) => void | - | - | × |
Panel
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| collapsible | Quick folding | boolean | { start?: boolean; end?: boolean; showCollapsibleIcon?: boolean | 'auto' } | false | showCollapsibleIcon: 5.27.0 |
| defaultSize | Initial panel size support number for px or 'percent%' usage | number | string | - | - |
| destroyOnHidden | Destroy panel content when collapsed (size is 0). Overrides Splitter's destroyOnHidden | boolean | - | 6.4.0 |
| max | Maximum threshold support number for px or 'percent%' usage | number | string | - | - |
| min | Minimum threshold support number for px or 'percent%' usage | number | string | - | - |
| resizable | Whether to enable drag and drop | boolean | true | - |
| size | Controlled panel size support number for px or 'percent%' usage | number | string | - | - |
Semantic DOM
| Semantic node | Native description | Version |
|---|---|---|
root | Root element with flex layout, width and height, alignment and stretch styles | 6.0.0 |
panel | Panel element with flex basis, grow ratio and panel container styles | 6.0.0 |
dragger | Drag control element with absolute positioning, user selection, z-index, center alignment, background color, hover and active states styles | 6.0.0 |
Semantic description source: vendor/components/splitter/demo/_semantic.tsx
Design Token
Types, inheritance and declarations retain the pinned native source. Defaults are computed by the native theme and may be overridden by ConfigProvider; this table does not invent static defaults.
| Token | Type | Native description |
|---|---|---|
resizeSpinnerSize | number | Drag and drop the identity element size |
splitBarDraggableSize | number | Drag and drop the identity element size |
splitBarSize | number | Drag the element display size |
splitTriggerSize | number | Drag and drop trigger area size |
Declaration source: vendor/components/splitter/style/index.ts
import type { CSSObject } from '@ant-design/cssinjs';
import { genFocusOutline, resetComponent } from '../../style';
import { genNoMotionStyle } from '../../style/motion';
import type { FullToken, GenerateStyle, GetDefaultToken } from '../../theme/internal';
import { genStyleHooks } from '../../theme/internal';
import { genCssVar } from '../../theme/util/genStyleUtils';
export interface ComponentToken {
/**
* @desc 拖拽标识元素大小
* @descEN Drag and drop the identity element size
* @deprecated Please use `splitBarDraggableSize` instead.
*/
resizeSpinnerSize: number;
/**
* @desc 拖拽标识元素大小
* @descEN Drag and drop the identity element size
*/
splitBarDraggableSize: number;
/**
* @desc 拖拽元素显示大小
* @descEN Drag the element display size
*/
splitBarSize: number;
/**
* @desc 拖拽触发区域大小
* @descEN Drag and drop trigger area size
*/
splitTriggerSize: number;
}
interface SplitterToken extends FullToken<'Splitter'> {}
Shared native props
Tips: The following generic properties apply to most antd components; those not supported are described separately.
| Property | Description | Type | Default |
|---|---|---|---|
| style | The additional style | CSSProperties | - |
| className | The additional css class | string | - |
| rootClassName | ClassName on the root element | string | - |
| autoFocus | Auto focus when component mounted, only effective for focusable elements like forms, links, etc. | boolean | false |
Install and reproduce an example
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23
Use ConfigProvider and native App; configure dayjs locale separately. Each example lists its complete source files and additional pinned dependencies in View code. Example names select demos, not universal component props. See the resource setup guide for theme, locale and SSR.
Native type references
The source viewer includes unchanged native implementations and the following source declarations. Inherited types remain in their native packages. English source comments are preserved as code reference.
vendor/components/splitter/SplitBar.tsxvendor/components/splitter/Splitter.tsxvendor/components/splitter/hooks/sizeUtil.tsvendor/components/splitter/hooks/useItems.tsvendor/components/splitter/hooks/useResizable.tsvendor/components/splitter/index.tsxvendor/components/splitter/interface.tsvendor/components/splitter/style/index.ts
Source and license
https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd
Original bilingual prose and executable examples are retained. Website-only embeds and token tables are expanded locally. Ant Design is MIT; separately listed dependency notices also apply. Upload previews block outbound requests and do not provide a backend.