1. 简介
@gassa/ra-data-opencrud
是一个帮助前端开发者,快速连接 OpenCRUD API 数据源,实现可编辑、可查询、可筛选、可排序、可分页的数据管理系统的工具库。@gassa/ra-data-opencrud
基于 React 和 React Admin 框架实现,提供 CRUD 操作相关功能,可在 React Admin 中直接调用。
2. 安装
npm install @gassa/ra-data-opencrud
3. 使用步骤
3.1 配置文件
首先,你需要在你的 React Admin 项目的根目录中新建一个 config.js
的文件,并添加以下内容:
const API_ROOT = 'http://localhost:3000/graphql'; // 你的 OpenCRUD 数据源 const AUTH_PROVIDER = 'http://localhost:3000/auth'; // 你的身份认证服务 export { API_ROOT, AUTH_PROVIDER };
将 API_ROOT
和 AUTH_PROVIDER
的值替换为你自己的 OpenCRUD 数据源和身份认证服务的地址。
3.2 引入
在 React Admin 的入口文件(通常为 App.js
)中,添加以下代码:
-- -------------------- ---- ------- ------ --------------------- ---- -------------------------- ------ - --------- ------------- - ---- ----------- ----- --- - -- -- - ----- ------------ - ----------------------- -------------- - ---- -------- -- ------------- -------------- --- -- ---- -- --- ------- --
3.3 使用
在 React Admin 的资源组件中,使用 dataProvider
即可实现 CRUD 操作。例如:
-- -------------------- ---- ------- ------ - ----- --------- --------- - ---- -------------- ----- -------- - ------- -- - ----- ----------- ---------- ---------- ----------- -- ---------- ------------- -- ---------- -------------- -- ---------- -------------- -- ----------- ------- --
上面的代码定义了一个 UserList
组件,用于渲染用户列表。在渲染用户列表之前,我们需要通过 dataProvider
获取用户列表数据。此时,我们只需要将 dataProvider
传递给资源组件的 dataProvider
属性即可。例如:
<UserList dataProvider={dataProvider} />
buildOpenCrudProvider
函数返回的 dataProvider
对象包含了一系列资源操作函数,例如 getList
, create
, update
, getMany
等等。如果需要深入了解 dataProvider
的使用方法,可以参考官方文档。
4. 示例代码
完整的示例代码参见以下仓库:
https://github.com/gassaFM/ra-data-opencrud-example
5. 总结
在本文中,我们介绍了 @gassa/ra-data-opencrud 的使用方法,包括如何配置、引入、使用和示例代码。使用 @gassa/ra-data-opencrud 可以帮助我们快速连接 OpenCRUD API 数据源,实现可编辑、可查询、可筛选、可排序、可分页的数据管理系统,提高前端开发的效率和用户体验。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b5c51ab1864dac6708a