react-resizable-panels

react-resizable-panels

React可调整大小面板布局组件库

react-resizable-panels是一个React组件库,用于构建可调整大小的面板布局。它支持多种输入方式,包括鼠标、触摸和键盘,符合Web无障碍标准。该库特点包括简洁的API、布局持久化和服务器端渲染支持。开发者可以利用其详细文档和示例快速实现灵活的用户界面布局。

React可调整面板布局组件用户界面开源项目Github
<img width="328" alt="React 可调整大小面板的标志" src="https://yellow-cdn.veclightyear.com/835a84d5/4cfc21bb-4f77-450e-b233-c4d792212757.png" />

react-resizable-panels

用于可调整大小的面板组/布局的 React 组件。

支持的输入方法包括鼠标、触摸和键盘(通过窗口分割器)。


如果你喜欢这个项目,🎉 成为赞助者 或 ☕ 给我买杯咖啡


常见问题

面板大小可以用像素指定吗?

不可以。基于像素的约束增加了初始化和验证逻辑的复杂性,所以我决定不支持它们。你可以尝试按照这种模式自己实现一个版本,但这个库并不官方支持。

如何解决条件渲染面板的布局/大小问题?

Panel API 不要求 idorder 属性,因为它们对静态布局不是必需的。但是当面板被条件渲染时,最好提供这些值。

<PanelGroup direction="horizontal"> {renderSideBar && ( <> <Panel id="sidebar" minSize={25} order={1}> <Sidebar /> </Panel> <PanelResizeHandle /> </> )} <Panel minSize={25} order={2}> <Main /> </Panel> </PanelGroup>

可以为 DOM 元素附加 ref 吗?

不可以。我认为暴露两个 ref(一个用于组件的命令式 API,一个用于 DOM 元素)会很尴尬。不过,这个库确实导出了几个用于访问底层 DOM 元素的实用方法。例如:

import { getPanelElement, getPanelGroupElement, getResizeHandleElement, Panel, PanelGroup, PanelResizeHandle, } from "react-resizable-panels"; export function Example() { const refs = useRef(); useEffect(() => { const groupElement = getPanelGroupElement("group"); const leftPanelElement = getPanelElement("left-panel"); const rightPanelElement = getPanelElement("right-panel"); const resizeHandleElement = getResizeHandleElement("resize-handle"); // 如果你想的话,可以将它们存储在 ref 中以便传递 refs.current = { groupElement, leftPanelElement, rightPanelElement, resizeHandleElement, }; }, []); return ( <PanelGroup direction="horizontal" id="group"> <Panel id="left-panel">{/* ... */}</Panel> <PanelResizeHandle id="resize-handle" /> <Panel id="right-panel">{/* ... */}</Panel> </PanelGroup> ); }

为什么我看不到任何调整大小的 UI?

这可能意味着你还没有应用任何 CSS 来样式化调整大小的句柄。默认情况下,调整大小的句柄只是一个空的 DOM 元素。要添加样式,请使用 classNamestyle 属性:

// Tailwind 示例 <PanelResizeHandle className="w-2 bg-blue-800" />

如何在 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} />; }

客户端组件

"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> ); }

[!注意] 请确保为每个 Panel 组件指定 defaultSize 属性,以避免布局闪烁。

这个演示的代码可以在这里找到。

如何设置 CSP "nonce" 属性?

import { setNonce } from "react-resizable-panels"; setNonce("your-nonce-value-here");

如何禁用全局光标样式?

import { disableGlobalCursorStyles } from "react-resizable-panels"; disableGlobalCursorStyles();

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

聊天机器人AI助手热门AI工具AI对话
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多