0.2.51 • Published 5 years ago

omniview-ui v0.2.51

Weekly downloads
6
License
-
Repository
-
Last release
5 years ago

OmniView-UI

An out-of-box UI solution for enterprise applications.

Install

npm install omniview-ui --save --registry http://npm.omniview.pro

Features

Structure

OmniView UI 是基于 js 对象描述组件数据结构的方式来生成对应组件的。下例为一个标准的数据结构示例:

export default {
    name: {
        name: 'name', // 字段名称,可使用 i18n
        type: 'input', // 字段输入形式,input,select,password,cascader,datepicker,textarea 等
        key: 'name', // 唯一标识,用以匹配 data 和 layout 中的键值
        placeholder: 'type_the_customer_name', // 占位符文字,可使用 i18n
    },
    category: {
        name: 'category',
        type: 'select',
        key: 'category',
        valueText: 'categoryName', // 当某些情况下,表单需要传递的是 ID,而表格需要显示 ID 对应的文字时,可里用 valueText 来指向一个结果集中的文字字段
        options: [ // 对应选项结果
            {
                name: 'special',
                value: 1
            },
            {
                name: 'value',
                value: 2
            },
            {
                name: 'normal',
                value: 3
            }
        ],
        clearable: true,
        multiple: true,
        filterable: true,
    },
    state: {
        name: 'state',
        type: 'cascader',
        key: 'state',
        valueText: 'stateName',
        options: [
            {
                name: 'Taiyuan',
                value: 1,
                children: [ // 级联的二级选项
                    {
                        name: 'Hezhou',
                        value: 4
                    }
                ]
            },
            {
                name: 'Nanjing',
                value: 2
            },
            {
                name: 'Shanghai',
                value: 3
            }
        ]
    }
}

Helper > FormHepler

表单助手工具,通过无序数据结构(js 对象)来描述整个表单的内容

FormHelper 参数表

参数说明类型必填默认值
header表单名称String
refs表单 DOM 选择器String
form表单结构描述ObjectY
data表单数据描述Object{}
layout表单元素布局描述ArrayY
actions表单操作按钮描述Array[]
position表单 label 的对齐位置Stringright
localei18n 前缀String, Booleanfalse
rules表单验证规则,参考 asnyc-validatorObject, Array
labelWidth表单 label 宽度,仅在 position 不为 top 的情况下生效Number100

Helper > TableHelper

表格助手工具,通过无序数据结构(js 对象)来描述整个表格的内容

TableHelper 参数表

参数说明类型必填默认值
header表格名称String
columns表格表头结构描述Array, ObjectY
data表格数据描述Array[]
total表格数据总数,用以显示分页Number0
border是否显示表格边框线Booleantrue
filter是否显示搜索框,调用 FilterHelperBooleanfalse
showIndex是否显示列索引Booleanfalse
showCheckbox是否显示行选择框Booleanfalse
localei18n 前缀String, Booleanfalse
draggable表格列宽能否拖拽Booleanfalse

Helper > Editor

富文本编辑器助手工具,通过无序数据结构(js 对象)来描述整个富文本编辑器的内容

Editor 参数表

参数说明类型必填默认值
value编辑器html内容,可使用 v-model 双向绑定String
options编辑器配置项结构描述Object{}
height初始化编辑器高度Number, String300
dev-twice对于编辑器的二次开发,一般多为添加工具栏图标,下拉筐或者是添加一个dialogFunction
destory是否在组件的beforeDestroy钩子里销毁编辑器实例Booleantrue

Editor 事件表

事件名说明返回值
input编辑后返回html内容String
on-change编辑后返回html内容、纯文本和编辑器对象String, String, Object
on-ready编辑器初始化完成后返回编辑器对象,以便能手动初始化、销毁编辑器等Object

Editor 方法表

方法名说明参数类型
registerToolbar定制工具栏图标定制项的结构描述Object