npm 包 storybook-groups 使用教程

什么是 Storybook?

Storybook 是用于开发 UI 组件的工具,它可以在独立的环境中,独立展示 UI 组件,并且快速反馈开发者对组件的更改。

Storybook 本身是用于组件开发的,而非完整页面的。一旦我们有了可重用的 UI 组件,我们就可以将其列表传递给 Storybook,并在独立的环境中展示出来。这有助于我们开发者了解其他开发者在项目中使用的组件,以及在他们自己的代码中如何使用这些组件。

npm 包 storybook-groups

storybook-groups 是一个可以使的 Storybook 分组展示的插件,它可以让我们更加清晰的展示组件,以及方便我们更好的管理组件。

安装和配置

我们可以通过 npm 安装 storybook-groups:

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

接下来,在 .storybook/addons.js 中导入 storybook-groups:

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

这里的 addons.js 的位置可能在 .storybook 文件夹内,也有可能在单个组件项目的根目录内。

接着,在 .storybook/config.js 中,配置 storybook-groups 的参数:

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

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

同时,我们需要在 stories 文件中,给组件加上 groupName 属性,指定组件所属的分组:

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

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

这里将三个 Button 组件分到了一个名为 Button 的分组中。

分组展示

在配置好 storybook-groups 后,我们可以开始分组展示组件了。在默认情况下,storybook-groups 会按照 groupName 属性的值来展示组件,如果我们想要修改分组展示的呈现形式,则可以在 .storybook/config.js 中指定具体的配置参数。

举个例子,在以下的配置中,我们指定了所有分组都按照首字母进行分组,并设置了分组展示时的排序方式:

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

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

在以上的配置中,我们:

  1. 指定了一个名为 button 的分组,将其中包含的 Button 组件加入该分组中;
  2. 指定了展示配置中,同时展示 Panel 和 List 呈现;
  3. 指定了展示分组的排序方式,按照组件名称的首字母进行排序;
  4. 指定了展示每个分组所包含的组件的 sections。

总结

通过使用 npm 包 storybook-groups,我们可以更加清晰、方便的管理组件,以及更加高效的展示组件的效果和功能,在组件开发过程中具有非常重要的作用。

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


猜你喜欢

  • npm 包 request-client 使用教程

    简介 request-client 是一个 npm 包,它提供了一种简单的方式来发送 HTTP 请求,特别适合在前端应用中使用。它可以发送 GET、POST、PUT、DELETE、HEAD 请求等,并...

    2 年前
  • npm 包 formstate-engine 使用教程

    在前端开发中,表单验证是一个比较常见且重要的功能。在很多项目中都需要对用户的输入内容进行校验来保证数据的正确性和安全性。而 npm 包 formstate-engine 就是一个优秀的用于表单验证的工...

    2 年前
  • npm 包 generator-react_peng 使用教程

    前言 generator-react_peng 是一个帮助你快速搭建 React.js 应用的工具,可以自动生成 React.js 应用的骨架代码。使用这个工具可以大大提升你的开发效率,减少开发工作量...

    2 年前
  • npm 包 `somejs` 使用教程

    前言 在前端开发中,我们经常会使用到各种第三方工具和库,以便更快、更高效地完成我们的工作。而这些第三方工具和库的使用,通常需要借助 npm 进行管理和安装。 本篇文章将介绍 npm 包 somejs ...

    2 年前
  • npm 包 w-srvr 使用教程

    w-srvr 是一个方便快捷的本地服务器构建工具,它能够极大地提高前端开发的效率,尤其适用于开发静态页面或单页面应用程序 (SPA)。 安装 w-srvr 首先,我们需要先安装 w-srvr。

    2 年前
  • npm 包 @ozylog/validator 使用教程

    在前端开发中,经常会涉及表单校验的问题。为了方便开发者进行表单校验,许多团队开发了各种各样的表单校验插件。@ozylog/validator 就是其中之一,它提供了一套简洁易用的接口,可以轻松地进行表...

    2 年前
  • npm 包 hello-world-node-package 使用教程

    前言 在前端开发过程中,我们经常需要使用各种开源的库和工具来完成任务。而 npm 包是其中使用频率最高的一种工具。本文将介绍如何在 Node.js 环境下使用一个简单的 npm 包 hello-wor...

    2 年前
  • npm 包 my-gists 使用教程

    在前端开发中,我们经常需要分享代码片段和示例,方便交流和协作。而 GitHub Gist 是一个流行的代码片段分享平台,它不仅支持多种文件类型,而且可以直接嵌入到网页中。

    2 年前
  • npm 包 js-collections-framework 使用教程

    在前端开发中,集合框架是一类非常重要的工具,用于在数据处理过程中方便地存储和操作数据。js-collections-framework 是一个流行的 JavaScript 集合框架,支持数组、列表、树...

    2 年前
  • npm 包 mqtt_service 使用教程

    前言 前端技术栈中,集成 MQTT 协议的应用已经成为非常常见的事情。MQTT 协议是一种轻量级的、基于发布-订阅模式的通信协议,其最大特点是可以在不同设备之间方便地传输数据。

    2 年前
  • npm 包 generator-react-demo 使用教程

    在前端开发中,快速搭建一个 React 项目是非常常见的需求。这时我们可以使用 generator-react-demo 这个 npm 包来快速创建一个 React 项目的脚手架。

    2 年前
  • npm 包 platzom2 使用教程

    本文将介绍 npm 包 platzom2 的使用教程,包括安装、使用、API 以及示例代码等方面的内容。通过学习本文,你将了解如何使用 platzom2 将西班牙语转换成一种类似乱码的语言形式。

    2 年前
  • NPM包 React-Native-Web-Responsive 使用教程

    React Native 是一款非常流行的跨平台的移动端应用程序开发框架。而 React-Native-Web-Responsive 这个 NPM 包,则是为 React Native 应用程序提供了...

    2 年前
  • npm包stack-fsm-reducer使用教程

    在前端开发中,状态机技术应用越来越广泛,借助状态机可以更好的管理组件状态等复杂逻辑。在React中也可以使用有限状态机来进行状态管理,针对Redux的应用,stack-fsm-reducer是一个开源...

    2 年前
  • npm 包 module-bank-api 使用教程

    简介 module-bank-api 是一款用于访问银行 API 的 npm 模块。它内置了多种银行的 API 接口,并提供了简单易用的函数调用方式,方便开发人员在项目中进行银行 API 调用。

    2 年前
  • npm 包 @pratico/ngx-auth 使用教程

    介绍 @pratico/ngx-auth 是一种 Angular 库,旨在添加身份验证功能,以便在 Angular 程序中安全地管理用户身份验证。本教程将介绍如何使用该库,以及如何在 Angular ...

    2 年前
  • npm 包 formstatejs 使用教程

    在前端开发中,表单验证是非常重要的一环。而现如今,有很多方便并且易用的 JavaScript 库可以帮我们实现这个功能。本文将介绍一种高度定制化的表单验证库 formstatejs,并结合示例代码详细...

    2 年前
  • npm 包 get-arguments 使用教程

    1. 前言 在前端开发中,我们经常需要向函数传递一组参数。有时候,这些参数的数量和类型可能会非常多,给我们的开发带来一定的困难。npm 包 get-arguments 可以帮助我们方便地获取函数的参数...

    2 年前
  • npm 包 js-zrim-mongo-manager 使用教程

    js-zrim-mongo-manager 是一个 Node.js 的 npm 包,主要用于管理 MongoDB 数据库的增删改查操作。它提供了一些简单易用的 API,方便开发者快速地操作 Mongo...

    2 年前
  • npm 包 adoredemo 使用教程

    在前端开发中,我们常常需要使用各种 npm 包来加速我们的开发过程。adoredemo 是一个功能强大的 npm 包,它可以帮助我们快速构建出一个简洁而美观的前端 demo。

    2 年前

相关推荐

    暂无文章