2019-05-14 antd-design-vue 组件文档2

Posted 2023-05-03

参考技术A 基本使用

title 设置标题 string|slot|vNode

content 设置主要内容 string|slot|vNode

placement 可以设置十二个方向

trigger 设置触发方式 'focus|click|hover'

arrowPointAtCenter 设置箭头是否指向组件中心 boolean

shape 头像形状 Enum 'circle', 'square'

icon 制定头像图标 string

size 指定头像大小 number|Enum 'large', 'small', 'default'

src 指定头像链接地址

alt 指定头像无法显示时替代文本

loadError 图片加载失败返回的事件，返回boolean

count 需要显示的数字

numberStyle 自定义显示的样式

overflowCount 超出某个数字时显示 +

status 小点表示状态

offset 偏移状态 [x, y]

title 标题 string | slot

loading 显示加载状态 boolean

cover 封面 slot

extra 右上角可操作区域 slot| string

bodered 是否有边框 boolean

actions 底部可操作区域

tabList 页签标题列表, 可以通过scopedSlots属性自定义tab Array<key: string, tab: any, scopedSlots: tab: 'XXX'>

activeTabKey 当前标签页激活的key

defaultActiveKey 默认的tabkey

list 作为列表渲染使用

itemLayout 列表元素的渲染方向

dataSource 主数据源

bordered 是否带边框

header 列表头部 string|slot

footer 列表尾部 string|slot

split 是否带分割线

loading 首次加载时填充

renderItem 作为渲染列表子元素的插槽 slot

grid 用于itemLayout 为 horizontial 时使用 gutter: 20, column: 2, 用于渲染多列列表

rowKey key的取值 item => string|number

pagination 和 loadMore 有些冲突，需要再次验证

List.Item

extra 额外内容, 通常用在 itemLayout 为 vertical 的情况下, 展示右侧内容; horizontal 展示在列表元素最右侧

actions 列表操作组，根据 itemLayout 的不同, 位置在卡片底部或者最右侧

2019-05-10 antd-design-vue 组件文档

参考技术A

NOTICE

基本使用

value 选中参数值

checked 是否选中

defaultChecked 是否默认选中

通过配合 a-radio-group 组建获取和赋值

a-radio-group 的change事件获取event事件
e.target

如果a-radio-group的子元素是a-radio-button
可以设置 buttonStyle 和 size 属性

基本使用

checkbox 通过change属性获取event事件

通过checked值判断是否选中

defaultChecked 初始状态

disabled 选中失效

change 回调函数

配合 a-checkbox-group 进行使用时，进行一组选框渲染

options 选框数组

onChange事件会返回数组中 选中的元素的value值数组， 直接返回的是value值组成的数组，按选中顺序

基本使用

options 用来传入select下拉的数据，数据以数组形式传入，数组结构， 当传入的数据过大，要进行截取渲染，不然会卡顿

其中组建的宽度必须要设定，不然组建不能被撑开

defaultValue 组建显示的默认值

onChange 组建操作回调函数, 返回操作选择的value，当labelInValue为true时，同时返回节点文本信息

a-select-option 组建的子组建，表示子选项

mode 设置select选择模式，可选值 \'default\' | \'multiple\' | \'tags\' | \'combobox\'

disabled 是否禁用

dropdownClassName 下拉菜单的类名，方便自定义下拉菜单

open 是否展开下拉菜单

defaultOpen 是否默认展开下拉菜单

labelInValue boolean 获取节点文本信息， 必要情况下需要取得的数据，需注意

基本使用

onChange 操作回调函数，返回一个moment对象和日期字符串 返回‘2019-05-06’

disabled 禁用选择

onChange 回调函数 返回string 例 2019-05

回调函数 返回数组 ["2019-05-18", "2019-05-21"]

回调函数 返回数组 2019-20周

placeholder 输入框提示的文字

suffixIcon 选择框后缀图标 例 <a-icon slot="suffixIcon" type="smile" />

defaultValue 用户初始化选择器，配合moment.js 一起使用, 默认是 YYYY-MM-DD

format 用于格式化前端显示，配合moment.js一起使用

showtime 日期选择器和周选择器显示出时间选择按钮

size 选择器大小，默认default

disabledTime 返回一个moment对象来阻止选择

showToday 增加选择今天按钮

基本使用

multiple 多文件上传

name 文件类型

action 上传地址

name 上传字段名称

headers 请求头部，加密参数

directory 上传文件夹

beforeUpload 上传之前的钩子，返回Promise对象, 通过在钩子函数里进行图片大小筛选, 图片尺寸限制

preview 预览回调函数，listType为picture-card时有效果，通过thumburl赋值img进行预览

withCredentials boolean 请求带cookie

remove 移除回调

基本使用

title string 弹窗标题

afterClose 弹窗完全关闭后的回调

cancelText 取消文本文字

closable 是否显示右上角关闭按钮

getContainer 指定挂载html节点

mask 是否显示遮罩

okText 按钮确定文字

okType 确认按钮类型

destoryOnClose 关闭时销毁弹窗里的子元素

visible 弹窗是否可见

zIndex 弹窗层级

ok function 弹窗确认回调

cancel function 弹窗取消回调

Notification 挂载在全局对象上，通过函数内调用

description string|vNode 描述 可以是组件

message string|vNode 描述 可以是组件

placement string 4个位置可选 topLeft topRight bottomLeft bottomRight

icon 自定义图标

onClose 关闭通知时的回调函数

onClick 点击通知时的回调函数

key 当前通知的唯一标示

duration 默认4.5秒关闭，设置为null为不关闭

主要方法：

success

error

info

warning

warn

open

close

destory

config参数

btn vNode|function(h)

class 自定义ClassName

descrition string|vNode

duration number

icon vNode|function

key string

message string|vNode

placement string topLeft topRight bottomLeft bottomRight

style 自定义样式

onClose 自定义关闭按钮

onClick 点击通知时触发回调函数

使用方法和api和notification大同小异

基本使用

separator 用作自定义分隔符

itemRender 自定义链接函数，配合vue-Router一起使用

routes 路由参数

基本使用

layout 布局 horizontal | vertical | inline

submit 提交回调函数

在beforeCreated生命周期里注册表单

以便后续在函数中进行调用

this.form api

getFieldsValue(string[]) 获取表单注册组件的输入值

getFieldValue(string) 获取单个控件的输入值

isFieldsTouched 判断任意控件是否经历过数据收集

resetFields(string[]) 重置控件的值

setFields( [filedName]: value: any, errors: [Error] ) 设置控件和错误状态

setFieldsValue(fieldName: value) 设置某一控件的值

validateFields([fieldNames: string[]], [options: object], callback: Function(errors)) 校验并获取一组输入域的值与 Error，若 fieldNames 参数为空，则校验全部组件

validateFieldsAndScroll 函数校验，不通过则滚动到不通过菜单

options参数

label input对应的名称

label-col label对应的宽度

wrapper-col input输入框对应的宽度

validateStatus 验证状态 可选 \'success\', \'warning\', \'error\', \'validating\'

help 输入栏的验证提示

has-feedback 输入框反馈提示

extra string|slot 额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。

required boolean 是否必填，如不设置，则会根据校验规则自动生成

colon boolean 配合 label 属性使用，表示是否显示 label 后面的冒号

placeholder 输入框填充

v-decorator 输入框对应的验证规则