From 21751805d7287d25452f124d2fa9d4fd19a9ec28 Mon Sep 17 00:00:00 2001 From: Brian Vaughn Date: Sun, 24 Dec 2023 09:04:09 -0500 Subject: [PATCH] Updated README to remove incorrect prop --- packages/react-resizable-panels/README.md | 25 ++++++++++------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/packages/react-resizable-panels/README.md b/packages/react-resizable-panels/README.md index 47aa17bb2..90225c1aa 100644 --- a/packages/react-resizable-panels/README.md +++ b/packages/react-resizable-panels/README.md @@ -26,26 +26,23 @@ import { Panel, PanelGroup, PanelResizeHandle } from "react-resizable-panels"; ### `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 | -| `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 | +| `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` - `setItem: (name: string, value: string) => void` -2: This behavior is disabled by default because it can interfere with scrollbar styles, but it can be useful in the edge case where a `Panel` contains an `