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 包 login-signup-form-validations 使用教程

    在前端开发中,表单一直是不可避免的一个重要部分。而表单的验证也是其中非常重要的一部分。在这方面,npm 包 login-signup-form-validations 可以让我们的工作更加方便。

    3 年前
  • npm 包 streambuffer17 使用教程

    在前端开发中,处理流式数据是一项常见任务。streambuffer17 是一个以流的形式读写数据的 npm 包,可以极大地简化流式数据处理的工作流程。本文将为你介绍 streambuffer17 的使...

    3 年前
  • npm 包 xulogger 使用教程

    简介 在前端开发中,我们常常需要记录日志来帮助我们了解代码的运行情况和调试错误。xulogger 是一个基于浏览器控制台的日志记录库,它可以帮助我们在开发过程中方便地输出日志信息,并在生产环境下进行日...

    3 年前
  • npm 包 @hsuting/yeoman-generator 使用教程

    简介 在进行 Web 前端开发时,经常需要使用到各种工具和框架,而这些工具和框架的搭建过程通常是重复且费时的。为了减少这种重复工作的发生,Yeoman 提供了一个快速生成器的工具,可以帮助开发者快速生...

    3 年前
  • npm 包 dominot 使用教程

    简介 dominot 是一个轻量级的 JavaScript 库,用于将 DOM 元素转换为可以复制和粘贴的文本。它可以将特定的 DOM 元素及其子元素转换为文本字符串,也可以将纯文本转换为 DOM 元...

    3 年前
  • npm 包 ppprobe 使用教程

    什么是 ppprobe ppprobe 是一款基于 Node.js 和浏览器的性能监控工具。它可以帮助开发者监控页面响应时间、资源占用率、网络请求等指标,从而对页面性能进行优化。

    3 年前
  • npm 包 @pcmnac/react-wizard 使用教程

    什么是 @pcmnac/react-wizard? @pcmnac/react-wizard 是一个 React 组件库,旨在提供一种简单而又强大的方式来创建向导流程。

    3 年前
  • npm 包 @pcmnac/react-wizard-bootstrap3-renderer 使用教程

    简介 @pcmnac/react-wizard-bootstrap3-renderer 是一款基于 React 的前端开发工具,用于渲染 Bootstrap 3 风格的向导组件,让向导组件的样式更加美...

    3 年前
  • npm 包 findastic 使用教程

    前言 近年来,前端工程化越来越成为前端开发必备的技能之一。其中,npm 包在前端工程化中扮演着越来越重要的角色。npm 包是一个封装了特定功能的代码库,可以方便地被其他开发者在项目中使用。

    3 年前
  • npm 包 njavalscript 使用教程

    简介 njavascript 是一个简单易用的 JavaScript 代码评估器,可以在 Node.js 和浏览器中使用。它的主要功能是将字符串类型的 JavaScript 代码转换成可执行的代码,并...

    3 年前
  • npm 包 hobai-nodejs-tool 使用教程

    简介 hobai-nodejs-tool 是一款基于 Node.js 的实用工具类库,用于快速实现一些常见的前端开发任务。它包含了常用的字符串、日期、数组、对象、正则表达式等方面的工具方法。

    3 年前
  • npm 包 maintainancewebsite 使用教程

    简介 npm 是 Node.js 的包管理器,它提供了安装、更新、删除和查找 Node.js 模块的命令行工具。而 maintainancewebsite 则是一个 npm 包维护的 web 应用程序...

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

    前言 对于前端工程师来说,数据挖掘是一个比较常见的需求。而 node-miner 是一款方便在 Node.js 环境下使用的数据挖掘工具包,可以帮助我们快速地获取一些感兴趣的数据,例如爬取网页内容、定...

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

    在前端开发中,经常需要使用到各种提示框,如弹框提示、消息提示等。为了方便开发者快速实现这些功能,notice.js 库应运而生。本文将介绍如何使用 notice.js 库。

    3 年前
  • NPM 包 Vuet 使用教程

    Vuet 是一个基于 Vue.js 的状态管理解决方案。它可以帮助开发者更好地管理应用程序的状态,使其结构更清晰、更易于维护。在本文中,我们将介绍如何使用 Vuet,以及如何将其集成到您的 Vue.j...

    3 年前
  • npm 包 peerjs-nodejs 使用教程

    Peerjs 是一个 JavaScript 库,可以简化 web 应用程序和浏览器之间的 WebRTC 连接。Peerjs-nodejs 是一个 Node.js 模块,它可以让你在 Node.js 中...

    3 年前
  • npm 包 @dkunin/xkcd-pass 使用教程

    介绍 @dkunin/xkcd-pass 是一个由 Node.js 开发的 npm 包,它提供了一种生成易于记忆和安全的密码的方法。它基于 xkcd 网站上的一个经典漫画 https://xkcd.c...

    3 年前
  • npm 包 cosmodog-dl 使用教程

    在前端开发中,经常需要通过网络请求下载图片、视频、音频等资源。而 npm 包 cosmodog-dl 就是一个方便快捷地实现这种需求的工具。本文将介绍如何使用 cosmodog-dl 包进行资源下载,...

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

    前言 React 是一个非常流行的前端框架,其组件化的开发方式为前端开发者带来了很多便利。但是,在实际开发中,我们可能还需要一些可复用的 UI 组件来辅助我们开发。

    3 年前
  • npm 包 d3-tip-svg 使用教程

    简介 d3-tip-svg 是一个基于 D3.js 的工具库,用于生成 SVG 元素上的提示框。它提供了丰富的配置选项和可扩展性,使得用户能够灵活、自定义地创建自己想要的提示框。

    3 年前

相关推荐

    暂无文章