Skip to content

Commit

Permalink
docs: add missing direction docs to Drawer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisvxd committed Jun 19, 2024
1 parent 345374c commit 4ee30eb
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions apps/docs/pages/docs/api-reference/components/drawer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Puck } from "@/core/components/Puck";

# \<Drawer\>

A reference list of items that can be dragged into a [`<Puck.Preview>`](puck-preview). Used for composing custom Puck UIs.
A vertical or horizontal list of items that can be dragged into a [`<Puck.Preview>`](puck-preview). Used for composing custom Puck UIs.

<PuckPreview
config={{ components: { Orange: { render: () => <div>Orange</div> } } }}
Expand Down Expand Up @@ -38,8 +38,8 @@ export function Editor() {
| Param | Example | Type | Status |
| ----------------------------- | --------------------------- | ------------------------ | -------- |
| [`children`](#children) | `children: <Drawer.Item />` | ReactNode | Required |
| [`droppableId`](#droppableId) | `droppableId: "my-drawer"` | String | - |
| [`direction`](#direction) | `direction: "horizontal"` | `horizontal`, `vertical` | - |
| [`droppableId`](#droppableId) | `droppableId: "my-drawer"` | String | - |

## Required props

Expand All @@ -49,6 +49,12 @@ A React node representing the contents of the `<Drawer>`. Will likely contain [`

## Optional props

### `direction`

Set the direction of the drawer.

Defaults to `vertical`.

### `droppableId`

Set a custom ID for the underlying [Droppable](https://github.com/hello-pangea/dnd/blob/main/docs/api/droppable.md).
Expand Down

0 comments on commit 4ee30eb

Please sign in to comment.