mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-28 07:04:20 +00:00
4b59cb812e
In the [resizable documentation](https://ui.shadcn.com/docs/components/resizable) the handle example shows a horizontal handle but the code example has `direction="vertical"` when it should be `direction="horizontal"` <img width="745" alt="Screenshot 2024-01-05 at 9 34 43 AM" src="https://github.com/shadcn-ui/ui/assets/7241069/68c21241-e0c7-41b1-81d7-579306149520">
121 lines
2.4 KiB
Plaintext
121 lines
2.4 KiB
Plaintext
---
|
|
title: Resizable
|
|
description: Accessible resizable panel groups and layouts with keyboard support.
|
|
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 name="resizable-demo" />
|
|
|
|
## 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
|
|
|
|
<Tabs defaultValue="cli">
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn-ui@latest add resizable
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<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" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</Tabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import {
|
|
ResizableHandle,
|
|
ResizablePanel,
|
|
ResizablePanelGroup,
|
|
} from "@/components/ui/resizable"
|
|
```
|
|
|
|
```tsx
|
|
<ResizablePanelGroup direction="horizontal">
|
|
<ResizablePanel>One</ResizablePanel>
|
|
<ResizableHandle />
|
|
<ResizablePanel>Two</ResizablePanel>
|
|
</ResizablePanelGroup>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Vertical
|
|
|
|
Use the `direction` prop to set the direction of the resizable panels.
|
|
|
|
<ComponentPreview name="resizable-vertical" />
|
|
|
|
```tsx showLineNumbers {9}
|
|
import {
|
|
ResizableHandle,
|
|
ResizablePanel,
|
|
ResizablePanelGroup,
|
|
} from "@/components/ui/resizable"
|
|
|
|
export default function Example() {
|
|
return (
|
|
<ResizablePanelGroup direction="vertical">
|
|
<ResizablePanel>One</ResizablePanel>
|
|
<ResizableHandle />
|
|
<ResizablePanel>Two</ResizablePanel>
|
|
</ResizablePanelGroup>
|
|
)
|
|
}
|
|
```
|
|
|
|
### Handle
|
|
|
|
You can set or hide the handle by using the `withHandle` prop on the `ResizableHandle` component.
|
|
|
|
<ComponentPreview name="resizable-handle" />
|
|
|
|
```tsx showLineNumbers {11}
|
|
import {
|
|
ResizableHandle,
|
|
ResizablePanel,
|
|
ResizablePanelGroup,
|
|
} from "@/components/ui/resizable"
|
|
|
|
export default function Example() {
|
|
return (
|
|
<ResizablePanelGroup direction="horizontal">
|
|
<ResizablePanel>One</ResizablePanel>
|
|
<ResizableHandle withHandle />
|
|
<ResizablePanel>Two</ResizablePanel>
|
|
</ResizablePanelGroup>
|
|
)
|
|
}
|
|
```
|