npm 包 speed-admin 使用教程

简介

speed-admin 是一个基于 React 的后台管理系统快速开发框架，它提供了一套完整的前端解决方案，旨在让开发者更加专注于业务逻辑的实现而不必花费大量时间在构建基础框架上。

安装

您可以通过 npm 进行安装：

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

快速开始

运行以下命令，创建一个新的项目并安装依赖：

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

接着，在您的 src/App.js 中使用 speed-admin：

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

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

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

现在启动您的应用程序并访问 http://localhost:3000/admin，您将看到一个包含“用户列表”的页面。

组件

speed-admin 提供了许多用于快速开发后台管理系统的 React 组件。

Admin

Admin 组件是 speed-admin 的核心组件，它是整个管理系统的根组件。通过 Admin 组件，您可以为您的管理系统注册资源。

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

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

属性

属性 类型 必须 描述
authProvider Function 可选 一个认证提供程序函数，在进行任何后端请求之前都会首先调用它。
dashboard React.Component 可选 指定管理系统的仪表板，它是一个 React 组件。
dataProvider Function 必须 数据提供程序函数，用于从远程 REST API 检索数据。
i18nProvider Function 可选 一个国际化提供程序函数，用于提供翻译，它会注入到所有的子组件中。
loginPage React.Component 可选 指定登录页，它是一个 React 组件。
logoutButton React.Component 可选 指定注销按钮，它是一个 React 组件。
menu React.Component 可选 指定包含应用程序菜单的组件。
resources Array 可选 注册资源的数组。
theme Object 可选 指定应用程序的主题，它是一个 Material UI 主题对象。
title string 可选 指定管理系统的标题。
dataProvider Function 必须 数据提供者，在删除，更新或创建后，应更新并发回数据。

Resource

Resource 组件用于告诉 speed-admin 要管理哪种类型的实体（例如 users）。通过资源，您可以指定如何渲染实体，并使用渲染后的组件呈现数据。

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

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

属性

属性 类型 必须 描述
name string 必须 要管理的资源的名称
list React.Component 必须 用于呈现资源列表的组件
create React.Component 可选 用于呈现创建条目表单的组件。当删除、编辑或查看选项卡呈现到页面时，Create 组件也会用作替代组件。
edit React.Component 可选 用于呈现编辑条目表单的组件。当删除、创建或查看选项卡呈现到页面时，Edit 组件也会用作替代组件。
show React.Component 可选 用于呈现查看条目的组件。当删除、编辑或创建选项卡呈现到页面时，Show 组件也会用作替代组件。
icon React.Component 可选 资源图标
options Object 可选 用于自定义组件名称和图标的对象
listProps Object 可选 传递给列表组件的 props
title String 可选 资源标头
actions Array<Object> 可选 操作的数组, 每个操作都是一个对象，每个对象包含 name 和 icon 属性。
filters Array<React.Component> or Boolean 可选 表示资源筛选器的一个数组对象或 boolean 类型。
sort Object 可选 根据提供的参数对资源进行排序： { field: 'title', order: 'DESC' }

List

List 组件用于渲染资源列表。您可以使用内置的 ListGuesser 组件，也可以为您的资源实现自己的自定义组件。

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

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

子组件

List 组件的子组件必须是 Datagrid 组件。

Datagrid

Datagrid 组件用于对资源进行分页、排序和筛选。它是 List 组件的内置子组件。

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

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

子组件

子组件必须是列组件，例如 TextField 或 DateField。

TextField

TextField 组件用于呈现文本字段。

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

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

属性

属性 类型 必须 描述
source String 必须 要渲染的字段的名称
label String 可选 显示的标签(可理解为名称)。
sortable Boolean 可选 指示此字段是否可排序

DateField

DateField 组件用于呈现日期字段。

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

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

属性

属性 类型 必须 描述
source String 必须 要渲染的字段的名称
label String 可选 显示的标签(可理解为名称)。
format String 可选 要使用的日期格式(默认为ISO)

总结

在本文中，我们介绍了 speed-admin 的一些核心组件，以及如何使用这些组件来快速构建并开发管理系统。虽然我们只是涵盖了一小部分 speed-admin 的可能性，但希望这篇文章能够引导您开始使用 speed-admin 并构建自己的管理系统。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600670a08ccae46eb111f07b

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐

    暂无文章