npm 包 fis-preprocessor-components 使用教程

阅读时长 8 分钟读完

前言

在前端开发中,我们经常需要将一个页面拆分成很多组件进行开发,而且这些组件往往都是可复用的。如何将这些组件进行管理和打包,就成为了一个很重要的问题。

在这里,我们将介绍一个 npm 包 fis-preprocessor-components,它可以帮助我们将前端页面中的组件打包并管理起来。下面是使用教程。

安装

首先我们需要安装 fis-preprocessor-components。

使用

配置 fis-conf.js

在使用 fis-preprocessor-components 前,我们需要在 fis-conf.js 中进行如下配置:

上述代码是在 fis 中定义一个 components 路径的组件,并将 isComponent 属性设置为 true。这样在后续的操作中,我们就能够在页面中直接引用这个组件。需要注意的是,组件必须要符合独立的模块化结构,才能被 fis-preprocessor-components 自动识别和打包。

引用组件

在页面中引用组件的方法和引用 js、css 文件的方法是一样的。

-- -------------------- ---- -------
--------- -----
------
  ------
    ----- ----------------
    -------------------
  -------
  ------
    ---- ---------------
      ------ --
      ---- -------------------
    ------
    ---- ----------------
      ------- --
    ------
    ---- ---------------
      ------ --
    ------
    ------- ---------------------- --------------------------------------
    ------- ---------------------- ---------------------------------------
    ------- ---------------------- --------------------------------------
  -------
-------
展开代码

在引用组件的时候,我们并没有引用组件的样式文件,因为我们使用了 webpack,所以 webpack 可以自动打包我们的样式文件。

接下来我们需要编写组件样式文件。

编写组件样式

在组件样式文件中,我们需要将组件中需用到的样式进行编写。

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

----- -
  ------ ------
  ------- -----
  ----------- ------------------- ----------
  ---------------- --------
-
展开代码

在上述代码中,我们定义了 header 和 logo 两个组件的样式。

配置 webpack.config.js

接下来我们需要将组件样式打包成一个 css 文件,然后使用一个 html 文件来引入这个 css 文件和 js 文件。

这里我们使用 webpack 来进行 css 的打包。

首先需要配置 webpack.config.js 文件:

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

-------------- - -
  ------ -
    ------- -------------------------
    -------- --------------------------
    ------- -------------------------
    ----- ----------------------
  --
  ------- -
    --------- ------------
    ----- --------- - --------
    -------------- ------
    -------- --------
  --
  ------- -
    ------ -
      -
        ----- ---------
        ---- ---------------------------
          --------- ---------------
          ---- --
            ------- -------------
            -------- -
              ---------- ----
            -
          --
        --
      -
    -
  --
  -------- -
    --- -------------------------------
  -
-
展开代码

webpack.config.js 可以进行本地打包和线上打包操作。

在上述代码中,我们指定了入口文件和出口文件,同时定义了 css 的打包方法。这里我们将 css 打包成了一个独立的文件。

编写组件页面

接下来我们在组件页面中引入组件的 css 和打包后的 js 文件。

首先需要编写一个 index.html 文件:

-- -------------------- ---- -------
--------- -----
------
  ------
    ----- ----------------
    -------------------
    ----- ---------------- --------------- --------------------
    ----- ---------------- --------------- ---------------------
    ----- ---------------- --------------- --------------------
  -------
  ------
    ---- ------------------
      ---- ------------------
      ---- -------------------
      ---- ------------------
    ------
    ------- ---------------------- ---------------------------
    ------- ---------------------- ----------------------------
    ------- ---------------------- ---------------------------
  -------
-------
展开代码

在上述代码中,我们分别使用了 link 标签引用了三个组件的 css,使用 script 标签引用了三个组件的 js。同时在 body 中还定义了三个 div,用于展示三个组件。

接下来需要在组件的 js 中进行相应配置:

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

----------------------- --- -----------------------------------
------------------------ --- ------------------------------------
----------------------- --- -----------------------------------
展开代码

在上述代码中,我们分别引入了三个组件的 jsx 文件,并将这三个组件渲染到了各自对应的 div 中。

配置 fis-conf.js

最后,在 fis-conf.js 中进行如下配置:

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

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

------------------------------------- -
  ----------- -----
  -------------- ----
--
展开代码

在上述代码中,我们通过 fis-conf.js 配置了组件的样式和 js 文件,在运行过程中,fis-preprocessor-components 会将组件按顺序打包成应用的样式文件和 js 文件。同时,我们还可以在页面中进行引用。

结语

通过以上步骤,我们就可以使用 fis-preprocessor-components 工具来将组件进行管理和打包了。这对于前端开发来说是一个非常好的辅助。

附注:完整示例代码请关注个人 GitHub,链接:Fis-Preprocessor-Components-Demo

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/63498

纠错
反馈

纠错反馈