npm 包 gatsby-design-tokens 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

在前端开发中,设计系统(Design System)常常是必不可少的。设计系统可以提高团队的协作效率,同时也能让产品在视觉和用户体验上保持一致性。而在设计系统的构建过程中,设计变量(Design Tokens)则扮演了重要的角色。

其中,使用 npmgatsby-design-tokens 可以快速生成并管理设计变量。在接下来的内容中,我们将详细介绍如何使用 gatsby-design-tokens

安装

gatsby 项目中使用 gatsby-design-tokens 需要安装 gatsby-plugin-design-tokensgatsby-theme-styleguide 两个包。可以使用以下命令进行安装:

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

使用

配置 gatsby-plugin-design-tokens

在项目根目录下的 gatsby-config.js 文件中,新增以下内容:

-------------- - -
  -------- -
    -
      -------- ------------------------------
      -------- -
        ------- ------------------
        ------- -----------------
        -------- -------- ------- --------
      --
    --
  --
-
  • source:设计变量源文件 .json 存放的路径。
  • output:输出的 .js 文件路径。在后面的例子中,它们在 src 目录内的 theme.js 文件中输出。
  • formats:输出的格式,支持 flatjsonscss。在这里,我们选择输出以上 3 种格式。

在上述配置中,我们需要在项目根目录中新建 design-tokens 文件夹用于存放设计变量源文件。

编写设计变量源文件

例如,我们需要管理颜色变量。可以新建一个 colors.json 文件,内容如下:

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

以此类推,可以在 design-tokens 文件夹中创建多个 .json 文件作为不同的设计变量。例如 typography.json 用于管理字体相关变量,spacing.json 用于管理间距相关变量等。

在以上示例中,我们将 primarysecondary 两个颜色变量定义为数组,每个数组项包括了 namevalue 两个字段,对应了变量名和变量值。

导入和使用设计变量

当配置和设计变量源文件都已准备完成后,我们就可以在项目的其他地方引入并使用设计变量了。在我们的示例中,将这些设计变量作为 theme.js 中输出的一个对象来使用。

gatsby-browser.jsgatsby-ssr.js 中导入 theme.js

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

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

在组件中使用设计变量:

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

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

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

以上示例中,我们导入了 theme.js,并将其作为 ThemeProvidertheme 属性的值。这样,在组件中,我们就可以通过 props 来访问对应的设计变量。

示例代码

下面是使用 gatsby-design-tokens 创建的一个基于 styled-components 的按钮样式。

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

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

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

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

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

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

指导意义

使用设计变量可更好地组织和管理设计系统,减少代码的重复和维护成本。通过 npmgatsby-design-tokens,可以更加方便地添加、更新和应用设计变量,让设计系统的维护变得更加容易。

总的来说,使用 gatsby-design-tokens 有以下几个优点:

  • 能够统一管理设计变量,减少代码的重复和维护成本。
  • 配置简单,使用方便,让前端开发人员能够更快地拥有设计系统。
  • 支持多种格式的输出,使得设计变量可以方便的应用到不同的开发场景。
  • 结合 styled-components 更好地实现了设计系统与组件的结合。

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


猜你喜欢

  • npm 包 `stripe-charge-list` 使用教程

    前言 随着互联网行业的快速发展,越来越多的公司开始将其业务转移到了线上,而电子商务也成为了其中的一部分。其中支付环节是整个流程中最为重要的环节之一,而 Stripe 则是目前业内较为流行的支付解决方案...

    4 年前
  • npm 包 igroot-text-diff 使用教程

    在前端开发中,我们经常需要进行文本对比,以便在我们的应用程序中完成各种功能。这时我们需要一个可靠的工具来实现文本差异比较。在这篇文章中,我们将要介绍一个名为 igroot-text-diff 的 np...

    4 年前
  • npm 包 igroot-upgrade-select 使用教程

    igroot-upgrade-select 是一款快速实现升级带有筛选与排序功能的下拉框组件的 npm 包。它基于 antd-select 组件,通过简单的配置即可开箱即用。

    4 年前
  • npm 包 clc 使用教程

    什么是 npm 包 clc? npm 包 clc 是一个命令行颜色模块库,它可以在终端输出带有颜色的文本,并支持加粗、下划线、背景色等效果。该模块可大大提高命令行程序的交互性和用户体验。

    4 年前
  • npm 包 testarmada-magellan-nightwatch 使用教程

    testarmada-magellan-nightwatch 是一个基于 Node.js 的工具,可以用于自动化测试 Web 应用程序。它可以方便地运行多浏览器测试,并支持并行执行测试。

    4 年前
  • npm 包 marge 使用教程

    简介 marge 是一个能够将多个 git 分支整合成一份报告的工具,可以方便地用来比较、汇总代码分支之间的差异。它可以为我们节省大量的工作时间,特别是在合并代码时。

    4 年前
  • npm 包 testarmada-magellan-local-executor 使用教程

    前言 在前端开发中,我们经常需要进行自动化的测试以保证代码的质量和稳定性,而 npm 平台上有很多方便我们进行测试的工具包和插件。本文将介绍一款常用的 npm 包 testarmada-magella...

    4 年前
  • npm 包 testarmada-tree-kill 使用教程

    在前端开发过程中,我们经常需要启动多个进程来运行不同的任务比如开发服务器、构建工具、测试脚本等等。这时候,往往需要手动从任务管理器中终止这些进程,比较麻烦。而使用 testarmada-tree-ki...

    4 年前
  • npm 包 hast-util-to-html 使用教程

    什么是 hast-util-to-html? hast-util-to-html 是一个可将 hast 抽象语法树转换为 HTML 字符串的 npm 包。hast-util-to-html 的内部实现...

    4 年前
  • npm 包 anchorate 使用教程

    anchorate 是一个 JavaScript 库,可以帮助你创建锚点,滚动到锚点处,并创建目录。它可以让你的网页更加便于阅读和导航。在本文中,我们将学习如何使用 anchorate。

    4 年前
  • npm包 builder-victory-component-dev 使用教程

    1. 前言 Builder-victory-component-dev是一个针对React和Victory组件库的npm包,用于方便开发者在构建项目和组件时使用开发版本组件,而不必等待正式发布。

    4 年前
  • npm 包 builder-support 使用教程

    npm 是 Node.js 的包管理器,因为方便、快捷,已经成为前端开发的必备工具之一。其中,builder-support 是一个 Node.js 库,它提供了很多有用的工具和辅助函数,可以帮助开发...

    4 年前
  • npm 包 builder-victory-component 使用教程

    在前端开发中,很多时候我们需要使用图表来展示数据,而 Victory 是 React 中一个非常受欢迎的图表库。而 builder-victory-component 则是一个用于生成 Victory...

    4 年前
  • npm 包 formidable-charts 使用教程

    前端数据可视化是现代化应用程序中不可或缺的一部分。随着相应技术的发展,现在有越来越多的数据可视化解决方案。在这里,我们将介绍一个流行的 npm 包 formidable-charts 来创建地图和图表...

    4 年前
  • npm 包 formidable-landers 使用教程

    前端开发离不开各种 npm 包,其中 formidable-landers 是一个解析表单数据的包。你可以使用它轻松处理文件上传和其他表单数据的解析。本文将提供 formidable-landers ...

    4 年前
  • npm 包 @theme-ui/prism 使用教程

    @theme-ui/prism 是一个轻量级且高度可定制的语法高亮库。它可以与 @theme-ui 或其他 CSS 库一起使用,提供现代且易于理解的代码突出显示。 安装 在终端中使用以下命令进行安装:...

    4 年前
  • npm 包 typography-theme-alton 使用教程

    在现代网页设计中,排版是非常重要的一部分。为了让网页看上去更加美观,设计师们需要调整字体、字号、间距等参数,这需要花费大量的时间和精力。不过幸运的是,我们可以使用一些工具来简化这个过程。

    4 年前
  • 前端技术文章:使用 typography-theme-anonymous npm 包教程

    在前端开发中,页面排版是非常重要的一环。为了方便排版,许多开发者使用 typography 工具实现自动化排版。对于需要快速排版且排版需求不是很高的开发者,推荐使用 typography-theme-...

    4 年前
  • npm 包 typography-theme-bootstrap 使用教程

    前言 在前端的开发过程中,我们常常需要关注用户界面的视觉效果。而字体,作为一种文本的表现方式,对于用户体验有着不可忽视的作用。然而,在处理字体方面,我们需要考虑到的因素远不止于字体本身,还包括字母的大...

    4 年前
  • npm 包 typography-theme-de-young 使用教程

    简介 typography-theme-de-young 是一个基于 typography.js 的 npm 包。typography.js 是一个以可配置方式生成样式的库,通常与 React 或 G...

    4 年前

相关推荐

    暂无文章