npm 包 khoaijs-component 使用教程

阅读时长 8 分钟读完

前言

khoaijs-component 是一款前端组件库,通过 npm 安装即可使用各种常见组件。在本篇文章中,我们将详细介绍如何安装和使用该库,并提供一些实例代码供参考。

安装

在开始使用 khoaijs-component 之前,您需要在本地安装它。以 React 为例,您可以使用以下命令:

该命令将会自动安装 React 和 khoaijs-component。

使用

导入组件

在您的项目中,导入您需要的组件即可开始使用。以下是使用 Button 组件的示例代码:

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

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

API

本部分将介绍 khoaijs-component 的一些常用 API。

Button

属性 类型 描述 默认值
type string 按钮类型,可选值为 primary、default、dashed、text、link -
size string 按钮大小,可选值为 default、large、small -
icon React.Element|string 按钮图标 -
block boolean 是否展示为块级元素 -
disabled boolean 是否禁用状态 false
htmlType string 按钮的原生 type 值,可选值为 button、submit、reset button
loading boolean 按钮是否处于加载中状态,按钮文字不可点击 false

Table

属性 类型 描述 默认值
columns ColumnProps 表格列的配置描述,详情见下 -
dataSource any[] 数据数组 -
bordered boolean 是否展示外边框和列边框 false
loading boolean 是否展示加载中 false
pagination boolean|object 分页器,配置项参考 rc-pagination 的 Options 配置 false
size string 表格大小,可选值为 default、middle、small default
onExpand (expanded: boolean, record: any) => void 点击展开图标触发的回调 -
rowSelection object 表格行是否可选择,配置项见下 -

Form

属性 类型 描述 默认值
fields object 包含表单内容的数据对象 -
onSubmit (values: object) => void 提交表单时回调,表单值对象为参数 -
onCancel () => void 取消按钮点击回调 -
formItemLayout object 表单项布局配置,详情见下 -
validateMessages object 校验信息配置,详情见下 -

Modal

属性 类型 描述 默认值
visible boolean 对话框是否可见 -
title React.Node|string 对话框标题 -
footer React.Node 对话框底部,可以自定义页脚按钮 -
onCancel (e?: any) => void 点击遮罩层或右上角叉或取消按钮的回调,参数为 event -
onOk (e?: any) => void 点击确认按钮的回调,参数为 event -

实例

以下是一个包含 Button 和 Table 组件的使用示例:

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

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

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

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

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

常见问题

在使用 khoaijs-component 过程中如何定制主题?

使用 antd 的主题定制方案 即可。

如何扩展组件?

您可以使用 babel-plugin-import 扩展 khoaijs-component 并去除额外的样式,具体细节请参考该插件的文档。

结语

khoaijs-component 是一款非常实用的前端组件库,可以帮助您快速开发出有现代感的前端页面。希望本篇文章能够帮助您更好地理解和使用该库。

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

纠错
反馈