npm 包 @historylab/design-tokens 使用教程

简介

@historylab/design-tokens 是一个通过使用 CSS 变量来管理设计标准的 npm 包。使用该包可以使前端开发人员在整个项目中有效地使用设计元素,从而保持一致性、可重用性和易维护性。本文将详细介绍如何在前端项目中使用该 npm 包。

安装

可以通过 npm 进行安装:

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

使用

导入

要使用该 npm 包,你需要首先导入它:

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

使用变量

该 npm 包包含了一些预定义的 CSS 变量。你可以直接在你的 CSS 样式中使用这些变量进行样式的定义。变量可以分为颜色、字体、边距、阴影和尺寸等多个类别。例如使用颜色变量:

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

编写自定义 CSS 变量

除了使用预定义的变量之外,你还可以自定义你自己的 CSS 变量。你可以在你的样式表中声明自定义变量,并在其中使用它们,如下所示:

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

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

使用自动生成的类名

在使用 CSS 变量的时候,它的写法可能会重复出现很多次,给代码的可读性和可维护性造成困扰。该 npm 包也提供了自动生成类名的功能。你可以在你的 HTML 元素中使用相应的类名,如下所示:

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

该类名会自动地应用与预定义的颜色变量。你可以按照这种方式继续使用其他类别的预定义变量。

深度使用

如果你认为上述有关该 npm 包的使用方法过于简单,请继续阅读,下面将详细讨论如何深入使用以获取更高的自定义能力。

自定义变量集

你可以通过使用 createToken 方法来创建自己的变量集。使用此方法,您可以创建一个包含您自己预定义变量的对象。例如,以下代码创建了一个自定义变量集:

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

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

创建的参数对象可以包含以上阐述的任何预定义变量集类别。例如,你还可以包含字体、边距、阴影和尺寸等编写你自己的自定义变量集。

实例化自定义变量集

在为项目设置预定义的变量时,你需要实例化你创建的自定义变量集:

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

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

这样可以将你的自定义变量集应用于整个应用程序中。

自定义类名前缀

使用预定义的 CSS 类名可以使你的代码更加清晰和易读。为了进一步优化此体验,你可以设置一个自定义类名前缀。此时,您不再需要使用“变量名 + 类型”作为类名,而是可以添加您选择的前缀,从而使类名更加通用和语义化。

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

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

这样,预定义类名将被自动添加前缀作为类名的一部分。您可以按照自己的标准添加类名前缀。

示例代码

在下面的示例中,我们将使用自定义变量集为页面增加了自定义颜色和字体变量。该代码同样使用了自动生成的类名。

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

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

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

总结

通过使用 @historylab/design-tokens 这个 npm 包可以为你的项目提供一致的设计元素,具有成本效益且易维护。除此之外,你还可以使用自动类名、自定义变量集以及类名前缀等功能,增加自己的自定义能力。希望本文可以为你的前端项目带来帮助。

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


猜你喜欢

  • npm 包 @jordanpapaleo/ui-library 使用教程

    随着前端开发的不断发展,现在很多项目都需要使用到 UI 库来完成开发。在这方面,npm 包 @jordanpapaleo/ui-library 是一个非常优秀的选择。

    3 年前
  • npm 包 draft.min.js 使用教程

    前言 在前端开发中,我们需要经常使用富文本编辑器来实现一些文本编辑和排版的功能。而 Draft.js 是由 Facebook 开发的一个强大的富文本编辑器框架,拥有很多的插件,可以满足大部分文本编辑需...

    3 年前
  • npm 包 @jimjkelly/cloudfront-invalidate 使用教程

    前言 在以往开发过程中,我们经常需要更新我们的 CDN 内容,以便确保最新的代码被访问者使用。为了实现 CDN 刷新,我们可以使用 AWS CloudFront 服务。

    3 年前
  • npm 包 dial.min.js 使用教程

    简介 dial.min.js 是一个能够生成带刻度和数字的钟表形式的刻度盘的 npm 包。它非常适合用于网页中的计时器和计数器等应用。本文将介绍 dial.min.js 的使用方法及示例代码。

    3 年前
  • npm 包 dialog.min.js 使用教程

    在前端开发中,对话框是常见的 UI 组件。而 npm 包 dialog.min.js 是一个轻量级的对话框插件,可以方便地创建各种对话框和提示框。本文将详细介绍如何使用该插件来创建对话框。

    3 年前
  • npm 包 @jamestalmage/empower-assert 使用教程

    概述 在前端开发中,单元测试是一个重要的环节。而其中一个关键的组成部分就是断言库,也就是用来判断测试结果是否符合预期的工具。 在 npm 中,@jamestalmage/empower-assert ...

    3 年前
  • npm 包 @jamestalmage/empower-core 使用教程

    在前端开发中,我们经常使用 npm 包来实现各种复杂的功能,提高开发效率和代码质量。其中,@jamestalmage/empower-core 是一个十分实用的 npm 包,它可以帮助我们更加方便和高...

    3 年前
  • npm 包 @juztcode/sqlite-admin 使用教程

    介绍 npm包 @juztcode/sqlite-admin 是一款用于管理sqlite数据库的工具。它可以通过命令行或图形界面的形式,提供了一些强大的功能,如数据导入/导出、表结构修改、查询等。

    3 年前
  • npm 包 @jamieconnolly/eslint-config 的使用教程

    随着前端技术的不断发展,我们需要借助各种工具提高我们的代码的质量和可维护性。其中一个非常重要的工具就是代码规范检查工具 eslint。而 eslint 的配置也是一个非常重要的问题。

    3 年前
  • npm 包 @jamiedixon/react-autosuggest 使用教程

    前端开发中,自动补全组件是经常使用到的一个功能。其中 @jamiedixon/react-autosuggest 是一款轻量级的 React 自动补全组件。本文将介绍如何使用该 npm 包,涵盖安装、...

    3 年前
  • npm 包 @jamiemcl001/object-pool 使用教程

    简介 JavaScript 中的对象池是一种缓存对象的设计模式。Object Pool 模式是对象池的一个具体实现,它用于管理可重用对象的集合。当需要对象时,可以从对象池中取出对象并使用它。

    3 年前
  • npm 包 @jamieparkinson/redux-form-material-ui 使用教程

    简介 @jamieparkinson/redux-form-material-ui 是一个用于 React 和 Redux 应用的 npm 包,其中包含了易于使用的 Material UI 表单控件和...

    3 年前
  • npm 包 @janrywang/react-contextmenu 使用教程

    简介 @janrywang/react-contextmenu 是一款 React 上下文菜单组件库,通过该组件库可以快速在你的 React 应用中添加强大的上下文菜单功能。

    3 年前
  • npm 包 @josecuevas/isipv4 使用教程

    IPv4 是互联网协议中使用最为广泛的一种,它是一个 32 位无符号整数,通常表示为 4 个十进制数字,例如:192.168.1.1。在前端开发中,经常需要对输入的 IP 地址进行校验以保证数据的准确...

    3 年前
  • npm 包 @jigsaw/purescript 使用教程

    什么是 PureScript PureScript 是一种开源编程语言,它旨在为编写高效且可维护的代码而设计。PureScript 基于函数式编程风格,可运行在 Node.js、浏览器、React N...

    3 年前
  • npm 包 @justinc/dir-exists 使用教程

    在进行前端开发的过程中,我们常常需要检查文件夹是否存在。npm 包 @justinc/dir-exists 就是一款帮助我们进行这项工作的工具。 本文将详细介绍如何使用 @justinc/dir-ex...

    3 年前
  • npm包@josephfinlayson/reshape-layouts使用教程

    前言 在前端开发中,我们经常需要对页面进行布局,很多时候可能通过CSS实现比较繁琐,这时可以使用reshape-layouts这个npm包来帮我们快速地生成布局。 reshape-layouts是一个...

    3 年前
  • npm 包 @josepmc/openapi-client 使用教程

    前言 在现代的 Web 应用程序中,很多时候需要与后端应用程序进行 API 交互。为了简化 API 开发,使用 OpenAPI 规范 可以帮助开发者定义和文档化 API,支持自动化生成客户端库和服务端...

    3 年前
  • npm 包 @justinc/dirs-as-promised 使用教程

    在前端开发中,我们经常需要读取文件夹中的所有文件或者需要在特定的目录下创建新的文件夹,这时候就需要用到文件夹操作的工具。@justinc/dirs-as-promised 是一款便捷的 npm 包,可...

    3 年前
  • npm 包 @justinc/dirs 使用教程

    npm 是一个非常重要的 Node.js 包管理器,可以让开发者更方便地使用、管理和共享自己的程序包。@justinc/dirs 是一个非常优秀的 npm 包,可以帮助我们快速地获取文件夹中的所有文件...

    3 年前

相关推荐

    暂无文章