npm 包 @panosvoudouris/storybook-addon-blabbr 使用教程

介绍

@panosvoudouris/storybook-addon-blabbr 是一个 Storybook 的插件,它可以让你在编写组件时,快速提交带有评论的屏幕截图到 Blabbr.app,方便你和你的团队沟通和讨论。

本文将向你介绍如何使用这个插件,以及如何与 Blabbr.app 集成。

安装

首先,你需要将该包安装在你的项目中。如果你使用的是 npm:

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

如果你使用的是 yarn:

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

配置

在你的 Storybook 配置文件中,你需要在 addons 数组中添加 @panosvoudouris/storybook-addon-blabbr,如下所示:

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

使用

在你的组件文档页面中,你可以看到一个新的 Blabbr 图标。点击它,就会在 Blabbr.app 中打开并上传当前组件的屏幕截图,并允许你添加评论。

集成

默认情况下,插件将上传静态屏幕截图,但你也可以配置它以上传交互性截图或 GIF 图像。

要上传交互型截图或 GIF 图像,你可以使用 react-gif-maker等 React 库实现,并将生成的文件传递给插件的 options 配置。

例如,如果你的交互性组件在 Storybook 中被渲染到 canvas 中,那么你可以使用 canvas-to-blob 库将其转换为 Blob 对象,并将该对象传递给插件的 options 中。

示例代码:

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

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

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

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

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

在此示例中,当用户点击 RecordScreenButton 时,组件会生成一个 GIF,并将其传递到 onGifCompleted 回调中。这个回调会上传文件到 Blabbr.app。

结论

使用 @panosvoudouris/storybook-addon-blabbr,你可以方便快捷地与团队成员讨论你的组件,并通过集成 GIF 以便更直观地演示你的组件,从而使你的组件更容易理解和维护。

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


猜你喜欢

  • npm 包 simple-calendar 使用教程

    介绍 simple-calendar 是一个基于 JavaScript 的日历插件。它可以方便地在网页中添加日历功能,支持快速创建日历、大小调整、日期选择、语言切换等特性。

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

    介绍 vue-loadings 是一个基于 Vue.js 的 npm 包,它可以为 Vue.js 应用程序提供加载中、成功和失败的状态。 安装 通过 npm 安装 vue-loadings 包。

    3 年前
  • 前端技术文章:使用fabric8-npm-pipeline-test-prj进行npm包测试

    npm包是web前端开发中常见的资源组织方式,但在开发、测试和部署过程中,我们需要一套系统化的工具来进行管理。fabric8-npm-pipeline-test-prj 是一款专门用于npm包测试的工...

    3 年前
  • npm 包 foox 使用教程

    前言 在前端开发中,我们经常会使用到各种各样的第三方库和框架,而 npm 就是一个非常流行的 JavaScript 包管理器。其中,foox 就是一个优秀的 npm 包,它提供了一些非常方便的工具和方...

    3 年前
  • npm 包 modal-service 使用教程

    在前端开发中,使用模态框(Modal)是经常遇到的需求之一。而 npm 包 modal-service 就是一个可用于创建模态框的便捷工具。本文将为大家介绍如何使用 modal-service 包创建...

    3 年前
  • npm 包 jsonschema-default-validator 使用教程

    在前端开发中,我们经常需要对用户输入或者服务器返回的数据进行验证和校验。数据结构的校验有助于减少代码的异常和错误,提高开发效率。jsonschema-default-validator 就是一款很好用...

    3 年前
  • npm 包 type-of-data 使用教程

    在前端开发中,我们经常需要对数据类型进行判断,比如判断一个变量是否为字符串、数字、对象、数组等等。为了方便更快速地进行数据类型判断,我们可以使用 npm 包中提供的 type-of-data。

    3 年前
  • npm 包 node-alps-env 使用教程

    介绍 node-alps-env 是一个 Node.js 环境下的全局配置包,可以方便地管理不同环境下的配置文件。通过使用这个包,可以将应用程序的配置文件从代码中分离出来,提高了代码的可读性和可维护性...

    3 年前
  • npm 包 create-react-generator 使用教程

    前言 在现代前端开发中,React 已经成为了一个非常流行的前端框架。在使用 React 进行开发过程中,我们通常需要快速搭建一个 React 项目,以便进行具体的开发工作。

    3 年前
  • npm 包 cloudflare-ips 使用教程

    什么是 cloudflare-ips? cloudflare-ips 是一个 npm 包,它包含了 Cloudflare 所有的 IPv4 和 IPv6 地址。这些地址可以用于防止非法请求和进行 IP...

    3 年前
  • npm 包 dange 使用教程

    在前端开发中,有很多的 npm 包可以帮助我们更加高效地开发,其中就有一个名叫 dange 的 npm 包,它是一款非常强大的前端数据可视化工具库。在本篇文章中,我们将会详细地介绍 dange 包的使...

    3 年前
  • NPM 包 Promfiler 使用教程

    在前端开发中,我们常常需要对代码进行性能优化,以提高用户体验。Promfiler 是一个基于 Node.js 的工具,可以帮助我们分析代码性能瓶颈,从而找到优化的方向。

    3 年前
  • npm包fis-parser-less-2.x-function-plus使用教程

    前言 在开发前端项目时,我们经常会使用各种工具来提高开发效率和代码质量。其中,npm是前端必不可少的工具之一。而fis-parser-less-2.x-function-plus则是npm中一个十分实...

    3 年前
  • npm 包 turnstile-react 使用教程

    随着前端开发的不断发展,我们常常需要使用各种工具和库来实现各种交互效果。在这些工具和库中,npm 包是前端开发者最常使用的一种资源。在本篇文章中,我们将介绍一个名为 turnstile-react 的...

    3 年前
  • npm 包 hzl-data-structures 使用教程

    简介 在前端开发中,我们经常需要使用各种数据结构来处理数据。但是如果每次都自己手写,既费时又费力。这时,可以使用 hzl-data-structures 这个 npm 包来方便地实现常见的数据结构,如...

    3 年前
  • npm 包 cordova-plugin-screen-locker 使用教程

    随着移动设备的普及,屏幕锁是一种非常流行的安全措施。屏幕锁可以防止未经授权的使用者访问您的设备,确保设备信息的安全性。针对屏幕锁的要求,许多开发者都选择使用 Cordova,这是一个可扩展的移动应用程...

    3 年前
  • npm 包 cordova-plugin-face-recognition 使用教程

    概述 cordova-plugin-face-recognition 是一款基于 Cordova 框架的人脸识别插件。它使用了最新的人脸识别算法和库,可以快速而准确地识别人脸。

    3 年前
  • npm 包 paycomponentpay 使用教程

    在前端开发中,我们常常需要处理支付功能,而 paycomponentpay 是一个 npm 包,提供了便捷的支付组件集成。本教程将详细介绍如何使用 paycomponentpay 包,帮助前端开发者快...

    3 年前
  • npm 包 redux-vsm 使用教程

    引言 Redux 是一种状态管理工具,它被广泛应用于现代 Web 应用程序的开发中。Redux-vsm 则是为 Redux 提供了更加简洁和易于理解的方式来管理状态的工具。

    3 年前
  • NPM 包 String-Title-Case 使用教程

    1. 前言 在前端开发中,我们经常需要对字符串进行格式化和处理。其中,字符串的大小写转换尤为常见,例如把一篇文章的标题格式化成首字母大写,以及其他字母小写的形式。为了方便处理这类需求,在 Node.j...

    3 年前

相关推荐

    暂无文章