【React】Ant Design社区扩展库之分割面板：react-resizable-panels

主角：react-resizable-panels
简介：来之Ant Design官方文档社区精选组件

1、效果

2、环境

• react-resizable-panels: ^2.0.16
• next: 14.1.3
• react: ^18

3、安装

# npm
npm install react-resizable-panels

# yarn
yarn add react-resizable-panels

# pnpm
pnpm add react-resizable-panels

# bun
bun add react-resizable-panels
1
2
3
4
5
6
7
8
9
10
11

4、组件概述

• PanelGroup: 布局容器
• PanelResizeHandle: 分割线控件，无自带样式，使用className或style属性自定义
• Panel: 面板容器，其下可嵌套任何元素

5、基础用法

// file: app/test/page.tsx
"use client"

import { Card } from "antd"

// 引入基础组件
import { 
	Panel, 
	PanelGroup, 
	PanelResizeHandle
} from "react-resizable-panels";

// 给边线来点小样式
const PanelResizeHandleStyle = {
    outline: 'none',
    flex: '0 0 .25rem',
    justifyContent: 'stretch',
    alignItems: 'stretch',
    transition: 'background-color .2s linear',
    display: 'flex'
}

const TestView = function () {

    return (
        <>
            <PanelGroup direction="horizontal">
                <Panel>
                    <Card>Card Panel 1</Card>
                </Panel>
                <PanelResizeHandle style={PanelResizeHandleStyle} />
                <Panel>
                    <Card>Card Panel 1</Card>
                </Panel>
            </PanelGroup>;
        </>
    )
}

export default TestView;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

6、组件Props

6.1、PanelGroup Props

①：存储API必须定义以下同步方法：

• getItem: (name:string) => string
• setItem: (name: string, value: string) => void

用于手动调整大小的命令式 API：

6.2、Panel Props

6.3、PanelResizeHandle Props

7、持久布局与 SSR 结合使用

默认情况下，该库用于localStorage保留布局。对于服务器渲染，当默认布局（在服务器上渲染）替换为持久布局（在 中localStorage）时，这可能会导致闪烁。
避免这种闪烁的方法是使用 cookie 来持久化布局，如下所示：

服务器组件

import ResizablePanels from "@/app/ResizablePanels";
import { cookies } from "next/headers";

export function ServerComponent() {
  const layout = cookies().get("react-resizable-panels:layout");

  let defaultLayout;
  if (layout) {
    defaultLayout = JSON.parse(layout.value);
  }

  return <ClientComponent defaultLayout={defaultLayout} />;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

客户端组件

"use client";

import { Panel, PanelGroup, PanelResizeHandle } from "react-resizable-panels";

export function ClientComponent({
  defaultLayout = [33, 67],
}: {
  defaultLayout: number[] | undefined;
}) {
  const onLayout = (sizes: number[]) => {
    document.cookie = `react-resizable-panels:layout=${JSON.stringify(sizes)}`;
  };

  return (
    <PanelGroup direction="horizontal" onLayout={onLayout}>
      <Panel defaultSize={defaultLayout[0]}>{/* ... */}</Panel>
      <PanelResizeHandle className="w-2 bg-blue-800" />
      <Panel defaultSize={defaultLayout[1]}>{/* ... */}</Panel>
    </PanelGroup>
  );
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21