npm 包 @sugarcoated/fondant-provider 使用教程

前端开发过程中,经常需要实现一些共用逻辑或者跨组件或者跨项目共用的代码,此时,可以采用 npm 包的方式来将共用的逻辑包装成一个包,供其它项目使用,避免每个项目都需要重新开发一遍。本文将介绍一个提供前端业务组件样式管理的 npm 包 @sugarcoated/fondant-provider 的使用方法。

fondant-provider 简介

@sugarcoated/fondant-provider 是一款前端业务组件样式管理工具,可以帮助前端团队有效管理业务组件样式,使其在多个不同技术栈和不同项目中得到复用,提高项目开发效率。

fondant-provider 采用了 fondant-adapter 的方式,对业务组件进行样式的管理,在使用方面通过提供按需生成所需业务样式表,将样式直接注入到需要的业务组件中。

使用步骤

安装 fondant-provider

首先,需要在项目中安装 fondant-provider,执行以下命令:

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

在安装完成后,可以在项目中使用 fondant-provider。接着,需要定义样式范围的项目。在本文的示例中,假设样式定义的范围是在一个示例项目下。

初始化 fondant-provider

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

声明并注入组件样式

考虑到在业务组件中,需要引入 fondant-adapter 并声明使用的组件样式,具体示例如下:

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

通过 fondantAdapter.createStyles 方法可以创建一个样式组件 styles,它是一个含有一些样式和一个 className,使用样式只需要在元素设置它对应的 className。

根据需求生成业务组件样式表

通过使用方法 createStyles,只是定义了组件样式,但没有真正将组件样式添加到样式表中。fondantProvider 中提供了一些方法,以生成业务组件样式表:

  • build(适用于开发模式):根据现有的样式表按需生成业务组件样式。在使用时,调用此方法后,会在调用位置生成对应的样式表,并返回 group 对象。
  • freezeBuild(适用于正常模式):在定义完组件样式后,根据样式表生成业务组件样式,并将其固化成一个不可再次修改的对象,不需要在运行时进行动态样式生成。

完整代码片段

如下所示,是一个完整的样式注入代码示例。

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

总结

@sugarcoated/fondant-provider 是一款前端业务组件样式管理工具,可以帮助前端团队有效管理业务组件样式,提高项目开发效率。使用该工具时,需要通过构建组件样式,并根据需求生成业务组件样式表,再将其注入到业务组件中。在实际开发过程中,可以根据不同项目的需求,定制出适合自己的业务组件模块。

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


猜你喜欢

  • npm 包 sorry-constants 使用教程

    简介 有时我们需要在前端项目中显示一些错误信息或者友好提示,在前端代码中定义一些常量是必不可少的。npm 包 sorry-constants 可以方便地将这些常量集中管理,避免因代码复杂而导致定义的变...

    3 年前
  • npm 包 node-hash-a-number 使用教程

    前言 一些前端开发场景中,我们需要使用哈希函数来将数字转成字符串,比如说在使用哈希表存储数据时。这时候,使用 node-hash-a-number 这个 npm 包,就可以非常方便地完成数字哈希的操作...

    3 年前
  • npm 包 censorify_lu 使用教程

    在前端开发中,我们经常需要处理敏感词汇,如何快速、简单地实现敏感词过滤是一个不容忽视的问题。这时候,censorify_lu 这个 npm 包可以帮助我们解决这个问题。

    3 年前
  • npm 包 fk-app-desktop 使用教程

    简介 fk-app-desktop 是一款基于 Electron 技术栈开发的应用,在前端开发中应用广泛,可以帮助开发者快速创建桌面端应用。它提供了一些常用的桌面开发功能,如窗口管理、菜单栏、快捷键、...

    3 年前
  • npm 包 react-native-vxg-media 使用教程

    简介 react-native-vxg-media 是 React Native 程序中的一个 npm 包。它提供了一个集成了 VXG Media Player SDK 的 React Native ...

    3 年前
  • npm 包 @horacehylee/api-error-handler 使用教程

    前言 在开发前端项目的过程中,我们无法避免地会涉及到后端服务的接入,为了提高代码的重用性和可维护性,我们通常会将服务端返回的信息进行统一的错误处理。而在错误处理过程中,我们需要关注的主要是对错误信息处...

    3 年前
  • npm 包 hotshell-docker 使用教程

    前言 在前端开发中,经常需要使用 Docker 容器来进行环境搭建和应用部署。然而,每次手动输入复杂的命令开启和关闭 Docker 容器,非常繁琐和浪费时间。为了提高效率,我们可以使用 hotshel...

    3 年前
  • npm 包 generator-metaljs-component 使用教程

    简介 generator-metaljs-component 是一个 Yeoman Generator 基于 Metal.js 提供的快速生成 Metal.js 组件的 npm 包, Metal.js...

    3 年前
  • npm 包 eslint-config-angular-security 使用教程

    如果你正在开发基于 Angular 框架的前端应用,并希望在开发过程中保证代码的安全性,那么你可以考虑使用 eslint-config-angular-security 这个 npm 包。

    3 年前
  • npm 包 botbuilder-telemetry 使用教程

    简介 botbuilder-telemetry 是微软官方发布的一个 npm 包,用于集成 botbuilder 框架以记录用户行为并进行监测和分析。本文将详细介绍 botbuilder-teleme...

    3 年前
  • npm 包 mailjet-fluent-util 使用教程

    前言 在前端开发过程中,经常需要发送邮件,比如用户注册,找回密码等业务场景。使用第三方邮件服务商能够快速地实现邮件发送功能,mailjet 是一款常用的邮件服务商。

    3 年前
  • npm 包 op-ngx-chips 使用教程

    前言 随着前端技术的不断发展,我们已经不再只是过去写几个简单的 HTML、CSS、JS 页面的时代了,而是逐渐进入了组件化、模块化、工程化的时代。而作为前端开发人员,经常需要使用各种第三方库和工具来辅...

    3 年前
  • npm 包 atscntrb-sdstring 使用教程

    什么是 atscntrb-sdstring ? atscntrb-sdstring 是一个 npm 包,它提供了一组处理字符串的函数,可以用来解析、格式化和转换字符串。

    3 年前
  • npm 包 prettyconsole 使用教程

    前言 在前端开发中,控制台信息输出是非常重要的一部分,它有助于我们快速调试代码以及找到问题所在。然而,控制台输出的内容通常都是单调的黑白文字,很难在大量输出中快速找到关注点,特别是在使用 Node.j...

    3 年前
  • npm 包 pretty-web-console 使用教程

    在进行前端开发的过程中,我们经常需要在浏览器控制台中查看输出信息。但是默认的控制台的显示效果并不能满足我们的需求,这个时候就可以使用 npm 包 pretty-web-console。

    3 年前
  • npm 包 wreact 使用教程

    介绍 wreact 是一个基于 React 的组件库,旨在提供一系列高度复用性的组件,使得开发者可以快速地构建各种类型的 Web 应用。wreact 拥有丰富的组件库,可以用于创建单页应用,管理数据等...

    3 年前
  • npm 包 server-mapping 使用教程

    概述 在前端开发中,我们经常需要与后端服务器进行数据交互。在不同的开发环境中,服务器地址会有所不同,为了方便开发和部署,我们需要一个工具来管理不同环境下的服务器地址。

    3 年前
  • npm 包 react-native-font-loader 使用教程

    React Native 是近年来非常流行的开源移动端框架,它以“Write once, run anywhere”为口号,可以让开发者用 JavaScript 语言一次开发,就可以在 iOS 和 A...

    3 年前
  • npm 包 ambienx 使用教程

    简介 ambienx 是一个 JavaScript 库,它可以根据用户所处环境的亮度来自动调整颜色。对于有强烈感光性的人来说,ambienx 可以提供更加舒适的使用体验。

    3 年前
  • npm 包 dynamic-styled-buttons 使用教程

    前言 在前端开发的过程中,我们经常需要使用一些样式按钮来美化界面,但如果每次都手动写 CSS 样式,会浪费很多时间。如果能有一个能够快速创建不同样式按钮的工具就会十分方便了。

    3 年前

相关推荐

    暂无文章