mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-23 04:35:46 +00:00
128 lines
3.2 KiB
Plaintext
128 lines
3.2 KiB
Plaintext
---
|
|
title: Resizable
|
|
description: Accessible resizable panel groups and layouts with keyboard support.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://github.com/bvaughn/react-resizable-panels
|
|
api: https://github.com/bvaughn/react-resizable-panels/tree/main/packages/react-resizable-panels
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="resizable-demo"
|
|
previewClassName="h-80"
|
|
/>
|
|
|
|
## About
|
|
|
|
The `Resizable` component is built on top of [react-resizable-panels](https://github.com/bvaughn/react-resizable-panels) by [bvaughn](https://github.com/bvaughn).
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add resizable
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install react-resizable-panels
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="resizable"
|
|
title="components/ui/resizable.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
ResizableHandle,
|
|
ResizablePanel,
|
|
ResizablePanelGroup,
|
|
} from "@/components/ui/resizable"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<ResizablePanelGroup orientation="horizontal">
|
|
<ResizablePanel>One</ResizablePanel>
|
|
<ResizableHandle />
|
|
<ResizablePanel>Two</ResizablePanel>
|
|
</ResizablePanelGroup>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Vertical
|
|
|
|
Use `orientation="vertical"` for vertical resizing.
|
|
|
|
<ComponentPreview styleName="base-nova" name="resizable-vertical" />
|
|
|
|
### Handle
|
|
|
|
Use the `withHandle` prop on `ResizableHandle` to show a visible handle.
|
|
|
|
<ComponentPreview styleName="base-nova" name="resizable-handle" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="resizable-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [react-resizable-panels](https://github.com/bvaughn/react-resizable-panels/tree/main/packages/react-resizable-panels) documentation.
|
|
|
|
## Changelog
|
|
|
|
### 2025-02-02 `react-resizable-panels` v4
|
|
|
|
Updated to `react-resizable-panels` v4. See the [v4.0.0 release notes](https://github.com/bvaughn/react-resizable-panels/releases/tag/4.0.0) for full details.
|
|
|
|
If you're using `react-resizable-panels` primitives directly, note the following changes:
|
|
|
|
| v3 | v4 |
|
|
| ---------------------------- | ----------------------- |
|
|
| `PanelGroup` | `Group` |
|
|
| `PanelResizeHandle` | `Separator` |
|
|
| `direction` prop | `orientation` prop |
|
|
| `defaultSize={50}` | `defaultSize="50%"` |
|
|
| `onLayout` | `onLayoutChange` |
|
|
| `ImperativePanelHandle` | `PanelImperativeHandle` |
|
|
| `ref` prop on Panel | `panelRef` prop |
|
|
| `data-panel-group-direction` | `aria-orientation` |
|
|
|
|
<Callout>
|
|
The shadcn/ui wrapper components (`ResizablePanelGroup`, `ResizablePanel`,
|
|
`ResizableHandle`) remain unchanged.
|
|
</Callout>
|