npm 包 @leiko/m-react-splitters 使用教程

介绍

@leiko/m-react-splitters 是一个 React 分割器组件库,可以用于在页面中划分多个区域,并支持拖拽调整大小。

该组件库建立在 m-react-splitters 之上,并对原有组件进行了优化和功能扩展。

安装

使用 npm 安装 @leiko/m-react-splitters:

--- ------- ------------------------

使用

使用 @leiko/m-react-splitters 非常简单,只需要在需要划分区域的地方引入 Splitter 组件即可。

例如,我们需要在页面中将内容区域分为两部分,左侧固定宽度,右侧可拖拽调整宽度。可以使用以下代码实现:

------ - --------- ------------- ----------- - ---- ---------------------------

-------- ----- -
  ------ -
    --------- -----------------------
      ------------- -------------
        -------- ----- --------
      ---------------
      ------------ --
      --------------
        ------------ --------
      ---------------
    -----------
  --
-

上述代码中,Splitter 组件表示整个划分区域的容器,SplitterArea 组件表示划分后的每个区域,SplitterBar 组件表示可拖拽的分割条。

属性

@leiko/m-react-splitters 提供了丰富的属性设置,以下是主要属性说明:

Splitter

属性名 类型 默认值 说明
className string 整个 Splitter 容器的 class 名称
style CSSProperties 整个 Splitter 容器的样式
direction 'horizontal'
'vertical'
'horizontal' 划分区域的方向
primaryIndex number 0 设置哪个区域为主区域,主区域的大小变化会影响其他区域的大小。
minWidth number 容器最小可调整宽度
minHeight number 容器最小可调整高度
gutterSize number 10 分割条的大小
gutterAlign 'center'
'start'
'end'
'center' 分割条的排列方式
onDragStart Function 拖拽开始时的回调函数
onDragEnd Function 拖拽结束时的回调函数
onDrag Function 拖拽中的回调函数
onSecondaryPaneSizeChange Function 主区域大小变化时的回调函数

SplitterArea

属性名 类型 默认值 说明
className string 区域的 class 名称
style CSSProperties 区域的样式
size string 'auto' 区域的大小,支持百分比或像素值
minSize string 区域的最小大小,支持百分比或像素值
maxSize string 区域的最大大小,支持百分比或像素值
collapsible boolean false 区域是否可折叠
collapsed boolean false 区域是否默认折叠
onResizeStart Function 调整大小开始时的回调函数
onResizeEnd Function 调整大小结束时的回调函数
onResize Function 调整大小中的回调函数

SplitterBar

属性名 类型 默认值 说明
className string 分割条的 class 名称
style CSSProperties 分割条的样式

示例代码

以下是一个完整的例子,演示了如何在页面中使用 @leiko/m-react-splitters 划分布局:

------ - --------- ------------- ----------- - ---- ---------------------------

-------- ----- -
  ------ -
    --------- ---------------------- ---------------
      ------------- ------------ --------------- ----------------
        -------- ----- --------
      ---------------
      ------------ --
      ----------
        ------------- ------------ --------------- ----------------
          -------- ------ --------
        ---------------
        ------------ --
        --------------
          ------------ --------
        ---------------
      -----------
    -----------
  --
-

结语

@leiko/m-react-splitters 组件库提供了一种简单、易用的方式,可以在页面中轻松划分多个区域,并支持拖拽调整大小。

希望这篇教程对大家有所帮助,让大家能够更加轻松地使用该组件库。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066b5451ab1864dac669ac


猜你喜欢

  • npm 包 stream-operaio 使用教程

    标题:NPM 包 Stream-Operator 使用教程 介绍 Stream-Operator 是一个强大的 NPM 包,它可以用简单的语法来处理各种类型的流数据。

    3 年前
  • npm 包 lvsuzhen-vue-gulu-test 使用教程

    概述 lvsuzhen-vue-gulu-test 是一个基于 Vue.js 开发的 UI 组件库,其中包含了众多常用的组件和工具。本文将详细介绍 lvsuzhen-vue-gulu-test 的使用...

    3 年前
  • npm 包 vi-motion 使用教程

    什么是 npm 包 vi-motion vi-motion 是一个基于 Vue 2.x 和 Tween.js 的交互动效解决方案,封装了一些常用的手势动画效果,如滑动、缩放、旋转等,可以用于实现各种交...

    3 年前
  • npm 包 @mstssk/del-bs 使用教程

    在前端开发过程中,有时候会遇到需要从字符串中删除空格和换行符的情形。使用 JavaScript 的 replace 方法是一种通常的解决方法,但在处理大量字符串时效率可能较低。

    3 年前
  • npm 包 @constant-core-ui/base 使用教程

    npm 是 Node.js 的一种包管理工具,提供了很多前端、后端和工具类的包,方便了我们开发和实现功能。今天我们要介绍的是一个 npm 包,它名叫 @constant-core-ui/base,是一...

    3 年前
  • npm 包 castle-sms 使用教程

    前言 在 Web 开发中,发送短信验证是一个非常重要的功能。在 Node.js 中,我们可以使用第三方模块来实现该功能。本文将介绍 npm 包 castle-sms 的使用教程,并提供示例代码以帮助读...

    3 年前
  • npm 包 castle-sms-aliyun 使用教程

    在前端开发中,以及各种应用程序中,发送短信验证码是非常常见的。为了方便快捷、可靠的发送短信,阿里云为开发者提供了 SMS Service 服务。同时,开发者也可以使用封装好的 npm 包来快速实现这个...

    3 年前
  • npm包 @igloo-be/netlify-cms-backend-github 使用教程

    前言 随着云计算和微服务架构的兴起,前端开发也从单纯的“展示层面”逐渐向与后端并驾齐驱的领域发展。为了更加高效地开发前端应用,后端需要提供一些支持,比如数据接口、权限管理、存储等。

    3 年前
  • npm 包 scen 使用教程

    什么是 scen? scen 是一个基于 React 的可视化组件库,它提供了丰富的组件和样式,可以帮助我们快速构建美观的界面。scen 使用了 CSS-in-JS 技术,使得样式和组件代码可以更好地...

    3 年前
  • NPM包@igloo-be/netlify-cms-backend-gitlab使用教程

    前言 在现代化 Web 开发中,静态网站生成器变得越来越受欢迎。Netlify是当前最流行的静态站点托管平台之一,它可以为您的项目提供一个快速,可扩展和安全的环境。

    3 年前
  • npm 包 checkpoints 使用教程

    随着前端开发越来越复杂,我们需要使用更多的工具来帮助我们进行开发。使用 npm 包是一种常见的方法,而其中一个非常有用的 npm 包就是 checkpoints。checkpoints 可以帮助你更好...

    3 年前
  • npm 包 node-red-contrib-mongodb 使用教程

    简介 node-red-contrib-mongodb 是一个用于 MongoDB 数据库的 Node-RED 插件,能够简化与 MongoDB 的交互操作。它提供了一系列的节点,让您可以方便地向 M...

    3 年前
  • npm 包 vvvui 使用教程

    vvvui 是一个基于 Vue.js 的前端组件库,它提供了许多常用的 UI 组件,覆盖了从基础组件到高级组件的所有层次。本教程将介绍如何使用 npm 包来使用 vvvui。

    3 年前
  • npm 包 react-native-js-bottom-sheet 使用教程

    引言 React Native 是一种流行的开源跨平台的应用程序框架,它使用 JavaScript 和 React 构建 iOS 和 Android 应用程序。在 React Native 开发中,我...

    3 年前
  • npm 包 @vericus/slate-kit-plugins-wrapper 使用教程

    前言 在前端开发中,我们经常使用富文本编辑器,以满足用户对于文章编辑方面的需求。而 Slate.js 是一个优秀的富文本编辑器,它提供了很多有用的插件以及扩展性强的 API。

    3 年前
  • NPM包mdi-core使用教程

    如果你正在寻找一个可以方便地使用Material Design图标的方式,那么mdi-core npm包是一个值得尝试的工具。本文将提供一个详尽的mdi-core使用教程,并教你如何集成这个工具到你的...

    3 年前
  • npm 包 redux-ui-persistable 使用教程

    介绍 redux-ui-persistable 是一个能够将 Redux store 中的状态自动保存到本地存储或任何其他存储介质中的 npm 包。它能够将 Redux store 中的数据序列化后保...

    3 年前
  • npm 包 @cromwellian/redux-promise-middleware-actions 使用教程

    前言 @cromwellian/redux-promise-middleware-actions 是一个方便的 Redux 中间件,它可以简化异步操作的处理,使 Redux 开发变得更加简单和高效。

    3 年前
  • npm 包 @jasonmit/ember-cli-document-title 使用教程

    简介 在前端开发中,我们经常需要修改页面的标题,以提高 SEO 和用户体验。但是,在使用 Ember.js 开发应用程序时,手动更改页面标题可能会变得很麻烦。@jasonmit/ember-cli-d...

    3 年前
  • npm 包 soap-nfe 使用教程

    近年来,前端技术得到了迅猛的发展,因而也出现了大量的辅助工具,npm 就是其中之一。npm 是一个面向 Node.js 开发者的包管理器,它让开发者更容易地与他人共享代码,并且可以跨平台使用。

    3 年前

相关推荐

    暂无文章