npm 包 @advclb/design-system-viewer 使用教程

阅读时长 5 分钟读完

什么是 @advclb/design-system-viewer

@advclb/design-system-viewer 是一个用于展示设计系统的 npm 包,它可以通过预先定义好的 JSON 文件,构建出一个 UI 组件库展示页面,从而方便开发者和设计师之间的沟通和交流。

如何使用 @advclb/design-system-viewer

安装

通过 npm 安装 @advclb/design-system-viewer:

使用

  1. 创建一个 json 文件,定义您的组件库信息,比如组件分类、颜色、字体等信息,示例:
-- -------------------- ---- -------
-
  -------- ----------
  ------------- -
    -
      -------- -------
      ------------- -
        -
          -------- -----
          -------------- -----------
          ------- ---------------------
        --
        -
          -------- ------
          -------------- ------------
          ------- ------- ----------- -------------------
        -
      -
    --
    -
      -------- -------
      ------------- -
        -
          -------- --------
          -------------- ---------------
          ------- ------- ----------- --------------------
        --
        -
          -------- -----
          -------------- --------------
          ------- ---------------------
        -
      -
    -
  -
-
展开代码
  1. 在 React 中引入组件,示例:
-- -------------------- ---- -------
------ ----- ---- --------
------ ------------------ ---- -------------------------------
------ ---- ---- --------------

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

------ ------- ----
展开代码
  1. 在浏览器中查看组件展示页面,示例:

@advclb/design-system-viewer 的深入学习

如何自定义样式

通过 styles 属性可以自定义组件样式, 示例:

如何添加主题

通过自定义 CSS 样式表的方式添加主题,示例:

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

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

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

然后在 React 组件中使用

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

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

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

如何自定义组件

通过自定义 Renderer 属性,可以自定义组件的渲染方式,示例:

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

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

结论

@advclb/design-system-viewer 是一个极其方便的 npm 包,通过预定义的 JSON 文件,可以直观地展示出组件库信息。可以在实践中不断尝试,探索出更多功能,让设计系统更加完善。

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