snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
This commit is contained in:
136
apps/v4/content/docs/components/aria/resizable.mdx
Normal file
136
apps/v4/content/docs/components/aria/resizable.mdx
Normal file
@@ -0,0 +1,136 @@
|
||||
---
|
||||
title: Resizable
|
||||
description: Accessible resizable panel groups and layouts with keyboard support.
|
||||
base: aria
|
||||
component: true
|
||||
links:
|
||||
doc: https://github.com/bvaughn/react-resizable-panels
|
||||
api: https://github.com/bvaughn/react-resizable-panels
|
||||
---
|
||||
|
||||
<ComponentPreview
|
||||
styleName="aria-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="aria-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>
|
||||
```
|
||||
|
||||
## Composition
|
||||
|
||||
Use the following composition to build a `ResizablePanelGroup`:
|
||||
|
||||
```text
|
||||
ResizablePanelGroup
|
||||
├── ResizablePanel
|
||||
├── ResizableHandle
|
||||
└── ResizablePanel
|
||||
```
|
||||
|
||||
## Vertical
|
||||
|
||||
Use `orientation="vertical"` for vertical resizing.
|
||||
|
||||
<ComponentPreview styleName="aria-nova" name="resizable-vertical" />
|
||||
|
||||
## Handle
|
||||
|
||||
Use the `withHandle` prop on `ResizableHandle` to show a visible handle.
|
||||
|
||||
<ComponentPreview styleName="aria-nova" name="resizable-handle" />
|
||||
|
||||
## RTL
|
||||
|
||||
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
||||
|
||||
<ComponentPreview styleName="aria-nova" name="resizable-rtl" direction="rtl" />
|
||||
|
||||
## API Reference
|
||||
|
||||
See the [react-resizable-panels](https://github.com/bvaughn/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>
|
||||
Reference in New Issue
Block a user