介绍
metronic-rabbit 是一个基于 metronic UI 框架的快速开发脚手架,提供了一套完善的UI组件,方便前端开发人员快速构建出符合公司标准的前端界面。通过使用 npm 包管理工具来安装,可直接使用其中提供的组件和工具。
安装
使用 npm 包管理器进行安装,打开你的终端,输入:
npm install metronic-rabbit --save
引用
在你的项目中需要引用以下组件
import { Input, Form, Button } from 'metronic-rabbit';
使用
Input 组件
Input 组件既可以作为一个输入框,又可以作为一个只读框。下面是 Input 组件的 API:
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
value | string | 无 | 输入框的值 |
type | string | text | 输入框的类型 |
placeholder | string | 无 | 输入框中默认显示的文本 |
disabled | boolean | false | 是否禁用输入框 |
onChange | function | 无 | 当输入框中的值被改变时触发 |
示例代码:
-- -------------------- ---- ------- ------ - ----- - ---- ------------------ -------- ----- - ----- ------ -------- - ------------- ----- ------------ - --- -- - ------------------------ -- ------ - ------ ------------ ----------------------- ------------------- -- -- -
Form 组件
Form 组件提供了一个封装好的表单控件组,通过该组件可以快速创建出符合标准的表单。下面是 Form 组件的 API:
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
initialValues | object | 无 | 表单中各输入框初始值 |
onFinish | function | 无 | 当表单被提交成功时触发 |
onFinishFailed | function | 无 | 当表单被提交失败时触发 |
示例代码:
-- -------------------- ---- ------- ------ - ----- ------ ------ - ---- ------------------ -------- ----- - ----- -------- - -------- -- - -------------------- -- ------ - ----- --------- ---------- --------------- --------- --------- ----- -------- -------- ---- ------ -------------------- -- ------------ ---------- --------------- --------- --------- ----- -------- ------- ---- --------------- ------------------- -- ------------ ------- -------------- ----------------------------- ------- -- -
Button 组件
Button 组件是一个基础组件,为用户提供了一个按钮区域,适用于采用了类似 Material Design 风格的产品中。下面是 Button 组件的 API:
属性 | 类型 | 默认值 | 说明 |
---|---|---|---|
type | string | primary | 按钮类型 |
size | string | default | 按钮大小 |
disabled | boolean | false | 是否禁用按钮 |
onClick | function | 无 | 点击按钮时触发的事件 |
示例代码:
-- -------------------- ---- ------- ------ - ------ - ---- ------------------ -------- ----- - ----- ----------- - -- -- - ------------------- ---------- -- ------ - ------- --------------------------- ------------ -- -
总结
在本文中,我们介绍了 metronic-rabbit npm 包的安装、引用和使用,并提供了 Input、Form 和 Button 三个组件的详细 API 以及相应的示例代码。使用 metronic-rabbit 能够让前端开发更为快捷和高效,希望这篇文章能够帮助到需要使用该 npm 包的开发者。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f451d8e776d08040f6d