npm包 frypan-react-mobx-grid使用教程

介绍

frypan-react-mobx-grid是一个用于制作可编辑数据表格的React组件库。它是基于React和MobX构建的,用于简化了React表格的数据管理。

安装

安装npm包:

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

用法

以下是一个简单的示例,展示如何使用frypan-react-mobx-grid来创建一个带有编辑功能的数据表格:

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

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

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

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

在上面的示例中,我们首先定义了一个store对象,它保存我们的数据和一些操作数据的方法,如添加、删除和更新项。接着,我们创建了Grid和Column组件,并从store中获取数据和方法。最后,我们将Grid和Column组件渲染到页面上。

API

<Grid />

Grid组件用于包裹我们的表格,并且从store中获取数据和操作数据的方法。

Props

store

类型: Object

必需项。

一个对象,包含着我们的数据和一些操作数据的方法。

editable

类型: boolean

一个布尔值,表示表格是否可以编辑。默认为true。

emptyText

类型: string

一个字符串,表示当表格没有任何数据时,显示在表格上的文本。默认为"No data."

height

类型: number/string

一个数字或字符串,表示表格的高度。默认为"auto"。

loading

类型: boolean

一个布尔值,表示是否正在加载数据。默认为false。

onAdd

一个回调函数,当添加数据时被调用。

onDelete

一个回调函数,当删除数据时被调用。

onUpdate

一个回调函数,当更新数据时被调用。

plugins

类型: Array

一个数组,表示需要使用的插件。默认为空数组。

selection

类型: boolean/object

一个布尔值或对象,表示是否启用单元格选择。默认为false。

如果启用了单元格选择,可以使用以下选项:

Properties

mode:表示选择模式。支持的值为:"cell"(单元格选择模式)或 "row"(行选择模式)。默认为"cell"。

onChange:选择单元格或行后的回调函数。

<Column />

Column组件用于表示表格的每一列,并且从store中获取该列的数据。

Props

field

类型: string

必需项。

一个字符串,表示该列的数据在store中的属性名。

title

类型: string

一个字符串,表示该列的标题。

width

类型: number/string

一个数字或字符串,表示该列的宽度。默认为100。

editor

类型: function

一个函数,用于自定义该列的编辑器。函数应当返回一个React组件。

插件

frypan-react-mobx-grid包含了以下可选插件:

FilterPlugin

FilterPlugin用于为表格添加筛选功能。

Props
fields

类型: Object

必需项。

一个对象,表示每列的筛选条件。对象的属性名应当对应每列的数据属性名,在每列中可以设置如下条件:

emptyText:该列没有数据时显示的文本。

filterType:筛选数据时所使用的过滤器类型。过滤器可以是以下之一:"like"(表示匹配),"eq"(表示相等),"neq"(表示不相等),"gte"(表示大于或等于),"gt"(表示大于),"lte"(表示小于或等于),或 "lt"(表示小于)。默认为"like"。

filterValue:筛选数据所使用的匹配值。

PaginationPlugin

PaginationPlugin用于为表格添加分页功能。

Props
current

类型: number

必需项。

一个数字,表示当前页码数。

pageSize

类型: number

一个数字,表示每页的数据量。

pageSizeOptions

类型: Array

一个数组,表示分页器所支持的每页数据量选项。默认为[10, 20, 50, 100]。

totalRecords

类型: number

一个数字,表示数据的总记录数。

onChange

类型: function

当页数或每页数据量发生变化时调用的回调函数。该函数接受两个参数:page(表示变化后的页码数)和 pageSize(表示变化后每页的数据量)。

结论

frypan-react-mobx-grid是一个非常简单但实用的组件库,可以帮助在React应用中快速实现可编辑的数据表格,并且也提供了可自定义的插件。如果你正在寻找一种简单的方法来管理React数据,我强烈建议你试试这个库。

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


猜你喜欢

  • npm包使用教程:@broid/callr

    介绍 @broid/callr是一个npm包,可用于调用REST API接口。该npm包可以轻松帮助您在前端应用程序中调用REST API接口,以便您能够轻松地使用数据。

    3 年前
  • npm 包 @broid/discord 使用教程

    前言 在开发中,前端开发人员需要获取第三方服务提供的 API,来实现一些基于该服务的功能。 Discord 是一款广泛使用的聊天软件,通过其官方提供的 API,我们可以在我们的应用程序中集成 Disc...

    3 年前
  • npm 包 git-clone-repo 使用教程

    在前端开发中,我们经常需要从 Git 上 clone 各种代码库,这时候就可以使用 npm 包 git-clone-repo。git-clone-repo 是一个简单的 Git 仓库克隆工具,它是基于...

    3 年前
  • npm 包 @broid/google-assistant 使用教程

    Google Assistant 是一种智能个人助手,它通常被使用在监控和控制智能家居设备方面。现如今,开发者可以使用 @broid/google-assistant 这个 npm 包来为他们的应用程...

    3 年前
  • npm 包 @broid/gitter 使用教程

    前言 在前端开发中,我们经常需要使用第三方库来完成一些功能。npm 是前端常用的包管理工具之一,它可以方便地下载和安装各种第三方库。在 npm 生态中,有一个名为 @broid/gitter 的包,它...

    3 年前
  • npm 包 gh-app-token 使用教程

    介绍 npm 包 gh-app-token 是一个用于生成 GitHub 应用的访问令牌 token 的工具。GitHub 应用是一种提供更为安全的 OAuth 2.0 认证方式的应用。

    3 年前
  • npm 包 interactive-scripts 使用教程

    介绍 interactive-scripts 是一个 npm 包,它提供了一个交互式命令行界面 (CLI) 工具,可以帮助前端开发人员更方便地创建和管理项目。该工具基于 Node.js 平台和 Inq...

    3 年前
  • npm 包 lesx-parser 使用教程

    1. 什么是 lesx-parser lesx-parser 是一个用于解析 lesx 模板的 npm 包。lesx 是一种类似于 JSX 的模板语言,用于直接在前端编写 HTML 或者其他文档类型。

    3 年前
  • 完全指南:使用 npm 包 mlt-ts 的教程

    随着前端项目变得越来越复杂,我们需要使用 TypeScript 来更好地管理代码。但是,编写 TypeScript 代码通常需要大量的代码重复,包括类型定义,接口和实现。

    3 年前
  • npm包 rearmed-js使用教程

    在前端开发中,我们经常会遇到需要对数组或对象进行操作的情况,例如过滤、排序、去重、映射等。这时,我们可以使用JavaScript提供的一些原生方法,但是这些方法的功能有限、语法复杂等问题,因此,我们可...

    3 年前
  • npm 包 sweets-toffee-nuts 使用教程

    简介 sweets-toffee-nuts 是一个前端开发中常用的 npm 包,它可以用来生成随机的甜点店名。本文将介绍如何使用 sweets-toffee-nuts 进行前端开发。

    3 年前
  • npm包gatsby-plugin-uncss使用教程

    如果你是一个前端开发人员,你一定知道同一个项目可能因为引入了大量的css、js等无用代码而导致加载缓慢的问题。这也就是我们编写本文的原因,我们将介绍如何使用npm包gatsby-plugin-uncs...

    3 年前
  • npm 包 vue-popx 使用教程

    vue-popx 是一个基于 Vue.js 的弹出框插件,可以快速帮助我们创建弹出层,包括页面提示、确认、输入、加载等等。它支持多种主题,默认提供了两个主题,浅色(light)和深色(dark)。

    3 年前
  • npm 包 @broid/groupme 使用教程

    前言 随着互联网的发展,聊天应用已经成为人们生活中必不可少的一部分。在开发聊天应用的过程中,我们常常会使用到第三方聊天服务平台的 API。这其中,GroupMe 聊天服务平台就是非常优秀的一款产品,支...

    3 年前
  • npm 包 @broid/irc 使用教程

    在前端开发过程中,使用 npm 包是必不可少的。今天我们将介绍一个非常有用的 npm 包 @broid/irc,它提供了一套完整的 IRC(Internet Relay Chat)协议客户端功能,让我...

    3 年前
  • npm 包 @broid/kik 使用教程

    简介 @broid/kik 是一个基于 Node.js 的 Kik Bot 客户端库,可以快速帮助开发者搭建 Kik 机器人,实现与用户进行自动交互的功能。 安装 安装 @broid/kik 很简单,...

    3 年前
  • npm 包 @broid/line 使用教程

    在前端开发过程中,我们常常需要与不同的聊天平台进行集成。@broid/line 是一个基于 Node.js 的 npm 包,它可以帮助我们快速、方便地集成 Line 聊天平台。

    3 年前
  • npm 包 @broid/nexmo 使用教程

    前言 在前端开发中,有很多需要使用到短信、语音等通信服务的场景,其中 Nexmo 是较为常用的服务提供商之一。在使用 Nexmo 时,我们可以通过 npm 包 @broid/nexmo 来方便地访问 ...

    3 年前
  • npm包 @broid/skype的使用教程

    前言 顾名思义,@broid/skype是一个npm包,它允许你使用JavaScript或TypeScript编写Skype聊天中的交互式机器人。此包可简化与Skype Bot API之间的交互,使之...

    3 年前
  • npm 包 @broid/slack 使用教程

    简介 @broid/slack 是一个用于连接 Slack Bot 的 npm 包。该包提供了一系列的 API,使开发者可以轻松地将 Slack 与自己的应用程序集成,从而实现更好的工作效率和任务自动...

    3 年前

相关推荐

    暂无文章