1.0.0 • Published 4 years ago

movue-ui v1.0.0

Weekly downloads
1
License
ISC
Repository
github
Last release
4 years ago

movue-ui

移动端 UI 组件库。在线示例

使用

安装

npm i movue-ui -S

完全引用

import MoUi from 'movue-ui';

Vue.use(MoUi);

按需引用

  1. 安装 babel-plugin-component 插件
  2. .babelrc配置
plugins: [
  [
    "component",
    {
      libraryName: "movue-ui", //插件名称
      styleLibraryName: "css", //插件样式目录
      libDir: "dist/lib" //插件库路径
    }
  ]
]
  1. import需要使用的组件
import { Base, Datepicker, Input } from "movue-ui";

Vue.use(Base);
Vue.use(Datepicker);
Vue.use(Input);

其中Base为组件基础支撑项,必须引入项,否则组件会不生效。

组件列表

API

mo-text

文本显示组件,用于显示单行文本,表单文本,或者 list 内容。

基础用法

<mo-text label="使用value属性" value="无问"></mo-text>

<mo-text label="使用slot">
    <div>无问</div>
</mo-text>

Attributes

参数说明类型可选值默认值
value绑定值string--
label标题string--
border显示的边框类型stringtop, bottom, all, nonebottom
placeholder占位文本string--
disabled禁用boolean-false

Slots

name说明
default显示内容,替换显示value的值

优先级:slot > value > placeholder

按需引入

import { Text } from "movue-ui";
Vue.use(Text);

mo-button

常用的操作按钮,提供多种样式主题。

基础用法

默认按钮:

<mo-button>默认</mo-button>

独占一行:block

<mo-button block>block</mo-button>

各种主题:type

<mo-button type="primary">primary</mo-button>
<mo-button type="error">error</mo-button>
<mo-button type="warning">warning</mo-button>
<mo-button type="link">link</mo-button>
<mo-button type="success">success</mo-button>

无填充按钮:plain

<mo-button type="primary" plain>plain</mo-button>

不同大小按钮:size

<mo-button type="primary" size="min">size=min</mo-button>
<mo-button type="primary">size=normal</mo-button>
<mo-button type="primary" size="max">size=max</mo-button>

圆角按钮:round

<mo-button type="primary" round>round</mo-button>

圆形按钮:circle

<mo-button type="primary" circle>1</mo-button>

带图标按钮:icon

<mo-button type="error" icon="mo-icon-delete">delete</mo-button>

Attributes

参数说明类型可选值默认值
plain是否不填充背景色boolean-false
round是否圆角按钮boolean-false
circle是否圆形按钮boolean-false
icon图标类名string--
type类型,不同类型对应不同主题stringdefault, primary, error, warning, success, linkdefault
size尺寸stringmax, normal, min-
block是否独占一行boolean-false
disabled禁用boolean-false
marginstyle 属性 margin 的值string--
border是否显示边框boolean-true

Slots

name说明
default按钮显示的内容

Events

事件名称说明参数
click点击事件未提供参数,默认传(event: Event),否则传递提供的参数

按需引入

import { Button } from "movue-ui";
Vue.use(Button);

mo-line

对边框进行统一规范,移动端 1px 粗细线条。

基础用法

<mo-line direction="top">上边框</mo-line>
<mo-line direction="left">左边框</mo-line>
<mo-line direction="right">右边框</mo-line>
<mo-line direction="bottom">下边框</mo-line>

Attributes

参数说明类型可选值默认值
direction哪个方向的线条stringtop, bottom, right, lefttop
type线条颜色主题,同mo-buttonstringdefault,primary, error, warning, success, linkdefault

Slots

name说明
default线条内的内容

按需引入

import { Line } from "movue-ui";
Vue.use(Line);

mo-input

input文本输入框,通过鼠标或键盘输入字符。

基础用法

<mo-input placeholder="文本框" v-model="value"></mo-input>
<mo-input label="密码框" placeholder="密码框" type="password" v-model="password"></mo-input>

Attributes

参数说明类型可选值默认值
type类型string原生可输入 input 的 type 值text
value / v-model绑定值string / number--
maxlength原生属性,最大输入长度number--
placeholder原生属性,输入框占位文本string--
clearable是否可清空boolean-true
disabled禁用boolean-false
name原生属性string--
label标题string--
border显示的边框类型stringtop, bottom, all, nonebottom
switchablepassword 时是否显示切换密码图标boolean- 待开发true

Events todo 确认参数

事件名称说明参数
focus获取焦点时触发value
blur失去焦点时触发value
clear点击清空时触发value
change失去焦点且值改变时触发value

按需引入

import { Input } from "movue-ui";
Vue.use(Input);

mo-radio

单选框,在一组备选项中进行单选。

基础用法

<template>
  <mo-radio label="性别" v-model="sex" :options="options"></mo-radio>
	<mo-radio label="性别" v-model="sex" :options="options1"></mo-radio>
</template>

<script>
export default {
    data(){
      sex: "0",
      options: {
        0: "男",
        1: "女"
      }, 
      options1: [
          {title: "男", value: '0'},
          {title: "女", value: '1'}
		]
    }
}
</script>

Attributes

参数说明类型可选值默认值
options选项列表array, object--
value / v-model绑定值string, number--
label标题string--
border显示边框方向stringtop, bottom, all, nonebottom
disabled禁用boolean-false
name原生属性string--

options为Array且数组中的每一项为Object时,项的配置:

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, boolean--

Events

事件名称说明参数
change值改变时触发value

按需引入

import { Radio } from "movue-ui";
Vue.use(Radio);

mo-checkbox

多选框,在一组备选项中进行多选。

基础用法

<template>
	<mo-checkbox label="星期" v-model="day" :options="options"></mo-checkbox>
	<mo-checkbox label="星期" v-model="day" :options="weekday"></mo-checkbox>
</template>

<script>
	export default {
        data(){
            day: '1',
      		options: ['1','2','3','4','5','6','7'],
            weekday: [
        		{ title: "星期一", value: 1 },
            	{ title: "星期二", value: 2, disabled: true },
        		{ title: "星期三", value: 3 },
        		{ title: "星期四", value: 4 },
        		{ title: "星期五", value: 5, disabled: true },
        		{ title: "星期六", value: 6 },
        		{ title: "星期日", value: 7 }
      		]
        }
    }
</script>

Attributes

参数说明类型可选值默认值
options选项列表array, object--
value / v-model绑定值string--
label标题string--
border显示边框方向stringtop, bottom, all, nonebottom
disabled禁用boolean-false
splitKey多个值的连接符string-,
name原生属性string--

options为Array且数组中的每一项为Object时,项的配置:

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, boolean--

Events

事件名称说明参数
change值改变时触发value

按需引入

import { Checkbox } from "movue-ui";
Vue.use(Checkbox);

mo-select

选择器,当选项过多时,使用下拉菜单展示并选择内容。

基础用法

<template>
	<mo-select label="星期" v-model="day" :options="options"></mo-select>
	<mo-select label="星期" v-model="day" :options="weekday">
    </mo-select>
</template>

<script>
	export default {
        data(){
            day: '1',
      		options: ['1','2','3','4','5','6','7'],
            weekday: [
        		{ title: "星期一", value: 1 },
            	{ title: "星期二", value: 2, disabled: true },
        		{ title: "星期三", value: 3 },
        		{ title: "星期四", value: 4 },
        		{ title: "星期五", value: 5, disabled: true },
        		{ title: "星期六", value: 6 },
        		{ title: "星期日", value: 7 }
      		]
        }
    }
</script>

Attributes

参数说明类型可选值默认值
options选项列表array, object--
value / v-model绑定值string, number--
label标题string--
border显示边框方向stringtop, bottom, all, nonebottom
disabled禁用boolean-false
name原生属性string--

options为Array且数组中的每一项为Object时,项的配置:

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, boolean--

Events

事件名称说明参数
change值改变时触发value

按需引入

import { Select } from "movue-ui";
Vue.use(Select);

mo-switch

开关,表示两种相互对立的状态间的切换,多用于触发「开/关」。

基础用法

<mo-switch label="开关" v-model="val"></mo-switch>
<mo-switch :activeValue="1" :negativeValue="0" v-model="val1" ></mo-switch>

Attributes

参数说明类型可选值默认值
value / v-model绑定值string, number, boolean--
activeValue开启时对应的值string, number, boolean-true
negativeValue关闭时对应的值string, number, boolean-false
label标题string--
border显示边框方向stringtop, bottom, all, nonebottom
disabled禁用boolean-false
name原生属性string--

Events

事件名称说明参数
change值改变时触发value

按需引入

import { Switch } from "movue-ui";
Vue.use(Switch);

mo-range

滑块,通过拖动滑块在一个固定区间内进行选择。

基础用法

<mo-range v-model="value"></mo-range>
<mo-range v-model="value" :step="10"></mo-range>
<mo-range v-model="value" :min="10" :max="80"></mo-range>

Attributes

参数说明类型可选值默认值
value / v-model绑定值number--
min最小值number-0
max最大值number-100
step步长,max-minstep的整数倍number-1
barHeight拖动栏高,单位 pxnumber1
label标题string--
border显示边框方向stringtop, bottom, all, nonebottom
disabled禁用boolean-false
name 待开发原生属性string--

Events

事件名称说明参数
change值改变时触发value

按需引入

import { Range } from "movue-ui";
Vue.use(Range);

mo-collapse

折叠面板,通过折叠面板收纳内容区域。

基础用法

<mo-collapse label="无问" border="none">
	<div>
        你问风为什么托着候鸟飞翔 
        却又吹的让他慌张 
        你问雨为什么滋养万物生长
        却也湿透他的衣裳 
        你问他为什么亲吻他的伤疤 
        却又不能带他回家
        你问我为什么还是不敢放下 
        明知听不到回答
	</div>
</mo-collapse>

Attributes

参数说明类型可选值默认值
active选项列表boolean-false
label标题string--
border显示边框方向stringtop, bottom, all, nonetop
disabled禁用boolean-false

Slots

name说明
default面板内容

Events

事件名称说明参数
change展开或收起时触发value

按需引入

mo-collapse默认依赖mo-collapse-transition组件,需要同时引入mo-collapse-transition组件。

import {Transition, Collapse } from "movue-ui";
Vue.use(Transition);
Vue.use(Collapse);

mo-dropdown

从底部往上弹出单列单选列表。

基础用法

<template>
  <div>
    <mo-dropdown label="选框一(非Object)" v-model="value" :options="array"></mo-dropdown>
    <mo-dropdown label="选框二(Object)" v-model="value" :options="arrayObject"></mo-dropdown>
  </div>
</template>

<script>
export default {
    data(){
      value: 1,
      array: [1, 2, 3, 4, 5, 6, 7],
      arrayObject: [
        { title: "星期一", value: 1 },
        { title: "星期二", value: 2 },
        { title: "星期三", value: 3 },
        { title: "星期四", value: 4 },
        { title: "星期五", value: 5 },
        { title: "星期六", value: 6 },
        { title: "星期日", value: 7 }
      ]
    }
}
</script>

Attributes

参数说明类型可选值默认值
options选项列表array--
value / v-model绑定值string, number, boolean--
label标题string--
title弹出框标题stringtop, bottom, all, none-
disabled禁用boolean-false
confirmText确认按钮文本string-确定
cancelText取消按钮文本string-取消
titleColor弹出框标题颜色string-#333
confirmColor确认按钮颜色string-#ff642b
cancelColor取消按钮颜色string-#8c8c8c

options为Array且数组中的每一项为Object时,项的配置:

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, boolean--

Events

事件名称说明参数
cancel点击取消时触发待确认
confirm点击确认时触发待确认

按需引入

mo-dropdown组件继承自mo-picker,需要同时引入mo-picker组件。

import { Picker, Dropdown } from "movue-ui";
Vue.use(Picker);
Vue.use(Dropdown);

mo-date-picker

日期选择器,选择年月日时间。

基础用法

<template>
  <mo-date-picker label="今天" v-model="today"></mo-date-picker>
  <mo-date-picker label="2020年6月1日" v-model="value"></mo-date-picker>
</template>

<script>
export default {
    data(){
        today: '',
        value: '2020-6-1'
    }
}
</script>

Attributes

参数说明类型可选值默认值
value / v-model绑定值,为空默认为今天string--
start开始年份number-1950
end结束年份number-2050
splitKey年月日连接符string--
format数据格显示规则function--
label标题string--
title弹出框标题stringtop, bottom, all, none-
disabled禁用boolean-false
confirmText确认按钮文本string-确定
cancelText取消按钮文本string-取消
titleColor弹出框标题颜色string-#333
confirmColor确认按钮颜色string-#ff642b
cancelColor取消按钮颜色string-#8c8c8c

Events

事件名称说明参数
cancel点击取消时触发待确认
confirm点击确认时触发待确认

按需引入

import { Datepicker } from "movue-ui";
Vue.use(Datepicker);

mo-picker

多列选择器,联动选择器,可以配置地区选择等。

基础用法

非联动选择器:

<template>
  <mo-picker label="多列选框" v-model="value" :options="array"></mo-picker>
</template>

<script>
export default {
    data() {
      	value: [1, "早上"],
      	array: [
        	[1, 2, 3, 4, 5, 6, 7],
        	["早上", "中午", "晚上"]
      	],
    }
}
</script>

联动选择器:

<template>
  <mo-picker label="地址选择器" v-model="value" :options="array"></mo-picker>
</template>

<script>
export default {
    data() {
      value: ["110000", "110100"],
      array: [
        {
          title: "北京市",
          value: "110000",
          children: [
            { title: "北京市", value: "110100" }
          ]
        },
        {
          title: "上海市",
          value: "310000",
          children: [
            { title: "上海市", value: "310100" }
          ]
        },
        {
          title: "广东省",
          value: "440000",
          children: [
            { title: "广州市", value: "440100" },
            { title: "深圳市", value: "440300" }
          ]
        },
        {
          title: "江苏省",
          value: "320000",
          children: [
            { title: "南京市", value: "320100" },
            { title: "苏州市", value: "320500" }
          ]
        }
      ]
    }
}
</script>
参数说明类型可选值默认值
options选项列表array--
value / v-model绑定值string, number--
splitKey显示文本连接符string-,
label标题string--
title弹出框标题stringtop, bottom, all, none-
disabled禁用boolean-false
confirmText确认按钮文本string-确定
cancelText取消按钮文本string-取消
titleColor弹出框标题颜色string-#333
confirmColor确认按钮颜色string-#ff642b
cancelColor取消按钮颜色string-#8c8c8c

options为Array且数组中的每一项为Object时,项的配置:

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, boolean--
children后代选项

当为联动列表时children必填,且后代的格式与父类一致。

Events

事件名称说明参数
cancel点击取消时触发待确认
confirm点击确认时触发待确认

按需引入

import { Picker } from "movue-ui";
Vue.use(Picker);

mo-scroll

ios回弹效果滚动容器,对Better-Scroll封装了一层,减少配置。

基础使用

<mo-scroll>
	<div>
    假装有很多内容!
    内容高度必须超过容器高度才能滚动喔!
  </div>
</mo-scroll>

Attributes

参数说明类型可选值默认值
height选项列表array, object--
scrollY绑定值string, number--
scrollX标题string--
startX显示边框方向stringtop, bottom, all, nonebottom
startY禁用boolean-false
scroll滚动过程中触发string--
scrollEnd滚动结束触发function--
scrollStart滚动开始时触发function--
beforeScrollStart滚动开始之前触发function--
refreshrefresh 方法调用完成后function--
destroydestroy 方法调用完成后function--

方法具体参数参考better-scroll文档

Slots

name说明
default容器内容

按需引入

import { Scroll } from "movue-ui";
Vue.use(Scroll);

mo-tab

导航按钮组,多个按钮可进行滚动和自动定位。

基础用法

<mo-tab :buttons="buttons" v-model="value2"></mo-tab>

Attributes

参数说明类型可选值默认值
type风格类型stringlink, buttonlink
buttons按钮组array--
value激活状态按钮的值string, number, boolean--
disabledKeys禁用的按钮array--
disabled禁用boolean-false

buttons数组项为Object时,项配置

参数说明类型可选值默认值
title显示文本string, number, boolean--
valuestring, number, booleanmo-button-

Events

事件名称说明参数
change激活按钮项改变时触发value

按需引入

import { Tab } from "movue-ui";
Vue.use(Tab);

Toast消息提示

基础用法

默认消息提醒

this.$message('唱一首简单的歌!');

2秒后消失:

this.$message({
    message: '你问风,为什么托着候鸟飞翔。',
    duration: 2000
});

错误提醒

this.$message({
    message: '输入有误,请重新输入!',
    type: 'error'
});

加载中

this.$message({
    type: 'loading',
    duration: 10000
});

Attributes

参数说明类型可选值默认值
durationtoast显示时长,0表示一直显示,不关闭,单位毫秒(ms)number-1000
typetoast类型stringtoast, loading, success, error, warningtoast
icon消息图标类string--
message消息内容string--
onClose消息关闭后的回调function--

Methods

名称说明参数
close立即关闭消息提示框-

以下是封装的几种类型快速调用的接口:

$toast(message | options)

普通消息提醒,默认1s后自动关闭。

this.$toast('你问雨为什么滋养万物生长!');

参数

message: string

消息提示框的消息体。

options: object

Message消息体的配置信息,配置项见上表Attributes。其中配置的type字段会被忽略。

$error(message | options)

错误消息提醒,自带错误大图标显示。

this.$error('输入有误,请重新输入!');

参数

message: string

错误消息提示框的消息体。

options: object

Message消息体的配置信息,配置项见上表Attributes。其中配置的type字段会被忽略。

$success(message | options)

成功消息提醒,自带成功大图标显示。

this.$success('保存成功!');

参数

message: string

成功消息提示框的消息体。

options: object

Message消息体的配置信息,配置项见上表Attributes。其中配置的type字段会被忽略。

$warning(message | options)

警告消息提醒,自带警告大图标显示。

this.$warning('修改配置,将会重启,请知悉。');

$loading(message | options)

加载中消息提醒,自带加载中菊花图标显示。

自动消失:

this.$loading({
    message: '加载中',
    duration: 5000
});

手动消失:

let loading = this.$loading('加载中');
setTimeout(() => {
   loading.close();
}, 5000);

参数

message: string

警告消息提示框的消息体。

options: object

Message消息体的配置信息,配置项见上表Attributes。其中配置的type字段会被忽略。

按需引入

import { Toast } from "movue-ui";
Vue.use(Toast);
Vue.prototype.$loading = Toast.loading;
Vue.prototype.$toast = Toast.toast;
Vue.prototype.$success = Toast.success;
Vue.prototype.$warning = Toast.warning;
Vue.prototype.$error = Toast.error;
Vue.prototype.$message = Toast.message;

Dialog

对话框组件,用于弹窗交互。

基础用法

组件使用:

<template>
	<mo-button type="primary" @click="visible = true">内容弹框</mo-button>
	<mo-dialog v-model="visible" :title="title" :buttons="buttons">
      <div>文本内容</div>
    </mo-dialog>
</template>

<script>
	export default {
        data(){
            visible: false
        	title: 'Dialog 弹窗',
        	buttons: [
           	 	{ title: "取消" }, 
            	{ title: "知道了", type: "primary" }
        	]
        }
    }
</script>

命令使用:

// confirm 弹窗
this.$confirm("确定要删除嘛?")
    .then(() => {
         this.$toast("click ok");
    })
    .catch(() => {
         this.$toast("click cancel");
    });

// alert 弹窗
 this.$alert("alert 弹窗")
     .then(() => {
        this.$toast("click ok");
      });

Attributes

参数说明类型可选值默认值
visible / v-model绑定值boolean-false
title标题string, number--
message内容string--
buttons底部按钮,对象数组array (object)-{ title: "确定", type: "primary" }
css自定义样式类string--
closeOnClickModal点击蒙版关闭弹窗boolean-false
modalAppendToBody将弹窗内容添加到document.bodyboolean-true
showClose显示关闭按钮boolean-true
openDelay打开延时,单位毫秒number-0
closeDelay关闭延时,单位毫秒number-0

buttons数组项配置

参数说明类型可选值默认值
title按钮文本string--
type按钮主题stringmo-button-

Mehtods

方法名称说明参数
close关闭弹窗-
open打开弹窗-

Slots

事件名称说明
default内容区域,不提供可以通过设置message也是一样的

按需引入

mo-dialog中的按钮使用的是mo-button组件,故需同时引入。

import { Button, Dialog } from "movue-ui";
Vue.use(Button);
Vue.use(Dialog);

以下是封装的几种快速调用的接口:**

$alert(title, buttonText)

类似原生alert对话框,只有一个按钮。

 this.$alert("alert 弹窗")
     .then(() => {
        this.$toast("click ok");
      });

参数

title: string

alert对话框显示的内容。必填。

buttonText: string

alert对话框按钮的文本信息,默认为确定。非必填。

返回值

返回一个Promise实例,通过实例的then方法可以进行后续操作。

$confirm(title, message)

类似原生alert对话框,只有一个按钮。

 this.$alert("alert 弹窗")
     .then(() => {
        this.$toast("click ok");
      });

参数

title: string

confirm对话框标题。必填。

message: string

confirm对话内容,可以是html代码段。非必填。

返回值

返回一个Promise实例,点击确定切换到resolve,点击取消切换到reject

按需引入

message中的按钮使用的是mo-button组件,故需同时引入。

import { Button, Message } from "movue-ui";
Vue.use(Button);
Vue.use(Message);
Vue.prototype.$alert = Message.alert;
Vue.prototype.$confirm = Message.confirm;