npm 包 @storybook/core 使用教程

在前端开发中,组件库是一个很常见的概念,它可以提供一系列的 UI 组件来帮助我们快速搭建页面。而仅仅有组件不够,我们还需要组件的预览和文档,这就是 Storybook 的存在目的。

@storybook/core 是 Storybook 的核心依赖,它提供了一个本地的开发环境,你可以在其中编写和预览你的组件。本文将会介绍如何使用 @storybook/core。

安装

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

配置

添加脚本

package.json 中添加以下脚本:

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

添加配置文件

在项目的根目录下新建一个 .storybook 目录,并在其中添加 main.jspreview.js 配置文件。

main.js 的内容如下:

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

这个配置告诉 Storybook 在 src/components 目录下查找 *.stories.js 文件。

preview.js 的内容如下:

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

这个配置文件用于添加全局样式。

写组件

src/components 目录下创建一个组件以及一个对应的 *.stories.js 文件。

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

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

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

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

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

运行

运行以下命令启动 Storybook:

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

Storybook 启动后,在浏览器中访问 http://localhost:6006 即可查看组件的预览和文档。你可以在左侧的菜单中选择组件并查看不同的状态。同时,你也可以在右上角的 Actions 选项卡中执行一些交互动作。

总结

本文介绍了如何使用 @storybook/core 配置并运行 Storybook,以及如何编写组件和预览文件。通过学习本文,你应该可以使用 Storybook 为你的组件库提供更好的文档和预览支持。

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


猜你喜欢

  • npm 包 @59naga/babel-plugin-transform-array-from 使用教程

    简介 @59naga/babel-plugin-transform-array-from 是一个 Babel 插件,用于将 ES6 新增的 Array.from 方法转换成原生的 Array.from...

    5 年前
  • npm 包 babel-traverse 使用教程

    简介 babel-traverse 是 babel 的一个 npm 包,它可以让我们方便地遍历和修改 AST(抽象语法树)。 AST 是源代码的抽象表示,常常被用作静态分析和代码转换的基础。

    5 年前
  • npm 包 @absolunet/terminal 使用教程

    @absolunet/terminal 是一个 Node.js 模块,提供了一些便捷的函数封装,用于在命令行终端中执行命令,并获取其输出结果。本文将介绍该模块的安装步骤、使用方法以及一些示例代码。

    5 年前
  • npm 包 @absolunet/stylelint-config-nwayo 使用教程

    介绍 在前端开发中,为了保证代码的风格一致性和可读性,我们常常需要使用代码规范。而 stylelint 就是一个非常优秀的 CSS 代码规范工具。然而,由于个人的编程经验和项目需求的不同,对于规范的要...

    5 年前
  • npm 包 @absolunet/private-registry 使用教程

    简介 在前端开发中,使用 NPM 进行依赖管理是很常见的操作。但是,在某些情况下,我们希望将一些依赖包放在一个私有 NPM registry 中,以便于自己的团队使用。

    5 年前
  • npm 包 @absolunet/json-to-scss 使用教程

    介绍 npm 包 @absolunet/json-to-scss 是一个将 JSON 格式转换为 SCSS 格式的工具,可以方便地将设计师提供的 UI 风格定义文件转换为 SCSS 变量,以便在前端开...

    5 年前
  • npm 包 @absolunet/gulp-include 使用教程

    在前端开发过程中,我们经常需要将一个模块或组件嵌入到其他的模块或组件中。这时,我们可以使用 @absolunet/gulp-include 这个 npm 包来实现模块的嵌入。

    5 年前
  • npm 包 @absolunet/fss 使用教程

    前言 在日常前端开发中,文件操作是不可避免的,例如读取文件内容、写入文件、复制文件等等。npm 包 @absolunet/fss 提供了一系列文件操作的工具函数,简化了前端开发中的文件操作流程,提高了...

    5 年前
  • npm 包 @absolunet/fsp 使用教程

    在前端开发中,文件操作几乎是难以避免的一部分。npm 包 @absolunet/fsp 就是专门为前端文件操作而生的一个优秀的 npm 包。 如果您还没有接触过这个 npm 包,或者不太熟悉它的使用...

    5 年前
  • npm 包 @absolunet/eslint-config-nwayo 使用教程

    前言 在日常的前端开发中,我们可能会用到很多技术工具和框架。其中,eslint 是一款非常流行的 JavaScript 代码检查工具,可以帮助我们检查代码风格和排查一些潜在的问题,在开发的过程中起到非...

    5 年前
  • npm 包 @absolunet/eslint-config-json 使用教程

    在前端开发中,代码质量和规范性是非常重要的,在项目中使用 ESLint 工具可以自动检测和纠正代码风格和语法错误,提高开发效率和代码质量。@absolunet/eslint-config-json 是...

    5 年前
  • npm 包 @absolunet/cli 使用教程

    在现代前端开发中,使用 npm 包已成为必不可少的一部分。它提供了许多好用的工具和库,帮助我们更快地开发 Web 应用程序,并提供了许多有用的功能。其中,@absolunet/cli 是一个非常实用的...

    5 年前
  • npm 包 @types/amqplib 使用教程

    简介 当我们需要在前端应用中使用 RabbitMQ 时,往往需要与 amqplib 库进行交互。amqplib 是一个 Node.js 库,专门用于与 RabbitMQ 进行交互,提供了 Rabbit...

    5 年前
  • npm 包 gekko 使用教程

    什么是 gekko gekko 是一个用于加密货币交易策略的 JavaScript 库,是由 Mike van Rossum 创建的一款开源软件,可用于分析数据,执行交易策略,以生成交易信号并执行实际...

    5 年前
  • npm包dedupe使用教程

    在前端开发中,我们常常会用到 npm(node package manager)来管理第三方依赖包。npm可以很好地帮助我们安装和管理这些依赖包,但由于某些原因,我们可能会安装重复的依赖,这时候诞生了...

    5 年前
  • npm 包 cuke-tree 使用教程

    cuke-tree 是一个基于 React 的树组件库,它可以帮助我们快速构建树形结构的 UI 组件。它具有良好的可定制性,支持拖拽和多选等功能。本文将介绍 cuke-tree 的使用方法以及一些常见...

    5 年前
  • npm 包 codebricks 使用教程

    在开发前端项目的过程中,我们经常会遇到需要使用一些精美的 UI 特效或者是复杂的交互功能等需求,而这些功能往往需要借助各种前端库或者插件来实现。这时候,npm 包就是我们的一个不错选择,而其中的一个智...

    5 年前
  • npm 包 account-logger 使用教程

    无论是开发者还是普通用户,账户系统是现代应用程序中必不可少的一部分。而账户日志则是管理和保护这些账户的关键工具之一。npm 包 account-logger 提供了一种简单的账户日志解决方案,可用于 ...

    5 年前
  • npm 包 create-test-users 使用教程

    随着 web 前端的快速发展,测试已经成为了每个前端开发者必不可少的一项技能。而在进行测试时,经常需要用到测试账户。如果每次手动创建测试账户都需要耗费大量时间和精力,并且还容易出错。

    5 年前
  • npm 包 couchdb-update-views 使用教程

    简介 couchdb-update-views 是一个用于更新 CouchDB 视图的 npm 包。它可以帮助开发者快速、简单地更新这些视图,从而提高开发效率和开发体验。

    5 年前

相关推荐

    暂无文章