diff --git a/packages/react-resizable-panels/README.md b/packages/react-resizable-panels/README.md index 35c6c7029..3ad5f6b45 100644 --- a/packages/react-resizable-panels/README.md +++ b/packages/react-resizable-panels/README.md @@ -22,19 +22,18 @@ import { Panel, PanelGroup, PanelResizeHandle } from "react-resizable-panels"; ## Props ### `PanelGroup` -| prop | type | description -| :--------------------------------- | :----------------------------- | :--- -| `autoSaveId` | `?string` | Unique id used to auto-save group arrangement via `localStorage` -| `children` | `ReactNode` | Arbitrary React element(s) -| `className` | `?string` | Class name to attach to root element -| `direction` | `"horizontal" \| "vertical"` | Group orientation -| `disablePointerEventsDuringResize` | `?boolean = false` | Disable pointer events inside `Panel`s during resize 2 -| `id` | `?string` | Group id; falls back to `useId` when not provided -| `onDragging` | `?(isDragging: boolean) => void` | Called when group layout changes -| `onLayout` | `?(sizes: number[]) => void` | Called when group layout changes -| `storage` | `?PanelGroupStorage` | Custom storage API; defaults to `localStorage` 1 -| `style` | `?CSSProperties` | CSS style to attach to root element -| `tagName` | `?string = "div"` | HTML element tag name for root element +| prop | type | description +| :--------------------------------- | :--------------------------- | :--- +| `autoSaveId` | `?string` | Unique id used to auto-save group arrangement via `localStorage` +| `children` | `ReactNode` | Arbitrary React element(s) +| `className` | `?string` | Class name to attach to root element +| `direction` | `"horizontal" \| "vertical"` | Group orientation +| `disablePointerEventsDuringResize` | `?boolean = false` | Disable pointer events inside `Panel`s during resize 2 +| `id` | `?string` | Group id; falls back to `useId` when not provided +| `onLayout` | `?(sizes: number[]) => void` | Called when group layout changes +| `storage` | `?PanelGroupStorage` | Custom storage API; defaults to `localStorage` 1 +| `style` | `?CSSProperties` | CSS style to attach to root element +| `tagName` | `?string = "div"` | HTML element tag name for root element 1: Storage API must define the following _synchronous_ methods: * `getItem: (name:string) => string` @@ -70,14 +69,15 @@ import { Panel, PanelGroup, PanelResizeHandle } from "react-resizable-panels"; | `resize(percentage: number)` | Resize panel to the specified _percentage_ (`1 - 100`). ### `PanelResizeHandle` -| prop | type | description -| :------------ | :---------------- | :--- -| `children` | `?ReactNode` | Custom drag UI; can be any arbitrary React element(s) -| `className` | `?string` | Class name to attach to root element -| `disabled` | `?boolean` | Disable drag handle -| `id` | `?string` | Resize handle id (unique within group); falls back to `useId` when not provided -| `style` | `?CSSProperties` | CSS style to attach to root element -| `tagName` | `?string = "div"` | HTML element tag name for root element +| prop | type | description +| :------------ | :------------------------------- | :--- +| `children` | `?ReactNode` | Custom drag UI; can be any arbitrary React element(s) +| `className` | `?string` | Class name to attach to root element +| `disabled` | `?boolean` | Disable drag handle +| `id` | `?string` | Resize handle id (unique within group); falls back to `useId` when not provided +| `onDragging` | `?(isDragging: boolean) => void` | Called when group layout changes +| `style` | `?CSSProperties` | CSS style to attach to root element +| `tagName` | `?string = "div"` | HTML element tag name for root element --- #### If you like this project, [buy me a coffee](http://givebrian.coffee/). \ No newline at end of file