npm 包 worstui 使用教程

阅读时长 7 分钟读完

在前端开发中,我们通常会使用许多的 UI 组件库来快速搭建界面,比如常用的 Bootstrap、Ant Design 等。那么,今天我要介绍的是一款 npm 包,它的名字叫 worstui。

worstui 是一款基于 React 技术栈的 UI 组件库,它的设计初衷是提高开发效率和减少开发者在 UI 设计上的工作量。该组件库的设计简洁明了,易于定制,同时支持 TypeScript 和 CSS Modules。

接下来,我会从以下几个方面详细讲解 worstui 的使用方法:

  1. 安装 worstui;
  2. 使用 worstui 组件;
  3. 自定义 worstui 样式;
  4. 最佳实践。

1. 安装 worstui

使用 worstui 前需要安装它。worstui 是一款 npm 包,可以通过 npm 或 yarn 安装。

npm 安装

yarn 安装

2. 使用 worstui 组件

安装完成后,就可以使用 worstui 的组件了。worstui 目前提供了丰富的组件,包括:

  • Button: 按钮组件;
  • Icon: 图标组件;
  • Input: 输入框组件;
  • Radio: 单选框组件;
  • Checkbox: 复选框组件;
  • Table: 表格组件;
  • Modal: 模态框组件;
  • ...

以 Button 组件为例,我们可以这样使用:

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

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

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

上述代码中,我们引入了 Button 组件,并在页面中使用。在 Button 组件中,我们传入了两个参数:type 和 onClick。type 表示按钮的类型,可以取值为 primary、secondary、dashed、link、text 等,分别表示主按钮、次按钮、虚线按钮、链接按钮以及文本按钮。onClick 是一个函数,当用户点击按钮时,该函数会被触发。

3. 自定义 worstui 样式

worstui 组建库中提供了一些默认样式,但是,如果你想要进行样式的自定义,也非常简单。worstui 支持定制主题和局部样式。

定制主题

worstui 的主题定制非常简单,它提供了一个工具函数 makeTheme,该函数可以接收主题对象作为参数,返回一个完整的主题对象。例如:

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

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

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

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

上述代码中,我们使用 makeTheme 函数生成了一个主题,该主题的主要颜色设置为 #1890ff。然后,在 Button 组件中,我们传入了该主题对象,并显示了一个按钮。

局部样式

worstui 的组件都使用了 CSS Modules,并提供了一个 className prop,可以用来定制组件局部样式。例如:

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

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

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

上述代码中,我们给 Button 组件加了一个 className 属性,值为 my-button。然后,在 CSS 文件中,我们可以使用 .my-button 样式类来定制该按钮的样式:

4. 最佳实践

最后,让我们来总结一下如何将 worstui 应用到你的项目中。

提前准备

在使用 worstui 之前,需要先安装一些前置依赖,包括:

  • React:worstui 是基于 React 构建的;
  • CSS Modules:worstui 组件使用了 CSS Modules 技术;
  • TypeScript:worstui 支持 TypeScript。

组件按需加载

由于 worstui 提供的组件非常丰富,而我们在使用时,不会用到所有的组件。因此,我们可以使用 babel-plugin-import 插件进行按需加载组件。示例配置如下:

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

使用时,直接引入需要的组件即可,例如:

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

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

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

使用主题定制样式

worstui 的主题定制非常简单,可以针对不同业务需求定制不同主题。在主题中,我们可以设置一些颜色、字体和间距等,完成统一风格的设计。示例:

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

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

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

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

样式定制

worstui 提供了非常方便的 CSS Modules 技术,可以很方便地完成局部样式的定制。示例:

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

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

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

以上,就是 worstui 的使用详解。worstui 的使用非常简单明了,个人认为该组件库是很棒的,值得一试。

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

纠错
反馈