taolin/docs_vue2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update docs

Browse Source 
Change-Id: Ia7978d5e7fb726c5fd888d80b571ebda6a52c912
This commit is contained in:
xiaodemen 2021-05-07 10:57:45 +08:00 committed by GU Yiling
parent d6a3bcbb16
commit bbcea6f5e9
10 changed files with 38 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
one/docs/components/cascader.md
View File

@ -102,7 +102,7 @@
+++枚举值
| 值 | 描述 |
| -- | -- |
| `hover` | hover展开下一级。 |
| `hover` | 光标悬浮展开下一级。 |
| `click` | 点击展开下一级。 |
+++
^^^
@ -130,8 +130,8 @@
+++枚举值
| 值 | 描述 |
| -- | -- |
| `complete` | 完整展示选中值的父子路径，如`中国 > 上海`。 |
| `simple` | 仅仅展示选中值。 |
| `complete` | 完整展示选中值的路径，如“中国 > 上海”。 |
| `simple` | 仅仅展示选中值文本。 |
+++
^^^
@ -159,13 +159,13 @@
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `value` | `*` | 已选项值。 |
| `selected` | `object` | 已选项 |
| `selected` | `Object` | 已选项对象。 |
| `expanded` | `boolean` | 下拉菜单是否展开。 |
| `keyword` | `string` | 搜索值。 |
| `select` | `function(value: *): void` | 用于设置已选项。 |
| `updateExpanded` | `function(expanded: boolean): void` | 用于切换下拉菜单展开状态。 |
| `clearSelected` | `function(): void` | 用于清除已选项。 |
| `removeSelected` | `function(option: object): void` | 用于删除某个已选项，参数 `option` 是该已选项。 |
| `select` | `function(option: Object): void` | 用于设置已选项。 |
| `toggle` | `function(force: boolean): void` | 用于切换下拉菜单展开状态。 |
| `clear` | `function(): void` | 用于清除已选项。 |
| `remove` | `function(option: Object): void` | 用于删除某个已选项，参数 `option` 是该已选项。 |
| `updateKeyword` | `function(keyword: string): void` | 用于修改搜索值。 |
+++
^^^
@ -176,7 +176,7 @@
+++作用域参数
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `option` | `object` | 该列的父选项，其中 `options` 属性可以拿到当前列的数据。 |
| `option` | `Object` | 该列的父选项，其中 `options` 属性可以拿到当前列的数据。 |
+++
^^^
@ -206,10 +206,10 @@
+++作用域参数
| 名称 | 类型 | 描述 |
| -- | -- | -- |
| `option` | `object` | 当前选项。 |
| `select` | `function(option: object): void` | 选中当前选项。 |
| `expand` | `function(option: object): void` | 展开当前选项。 |
| `click` | `function(option: object): void` | 点击当前选项内容区，会按情况选中和(或)展开当前选项。 |
| `option` | `Object` | 当前选项。 |
| `select` | `function(option: Object): void` | 选中当前选项。 |
| `expand` | `function(option: Object): void` | 展开当前选项。 |
| `click` | `function(option: Object): void` | 点击当前选项内容区，会按情况选中和(或)展开当前选项。 |
+++
^^^

2
one/docs/components/column.md
View File

@ -52,7 +52,7 @@
^^^
^^^allowed-orders
指定该列的排序范围。
指定该列的排序范围。用户点击时将按设定的顺序进行切换。
+++值范围
| 值 | 描述 |

4
one/docs/components/lightbox.md
View File

@ -21,7 +21,7 @@
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | [^before-close] |
| `overlay-class` | `string|Array|Object=` | - | 浮层根元素类名，参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props) 属性。 |
| `indicator` | `string=` | `'number'` | [^indicator] |
| `options` | `object=` | `{video: {muted: true, autoplay: true, controls: true}}` | 额外配置。 |
| `options` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true } }` | 额外配置。 |
^^^open
:::badges
@ -32,7 +32,7 @@
^^^
^^^datasource
灯箱数据源，项目类型为：`{src, alt, type}`。
灯箱数据源，项目类型为：`{ src, alt, type, desc }`。
+++字段详情
| 名称 | 类型 | 描述 |

2
one/docs/components/select.md
View File

@ -213,7 +213,7 @@
^^^slot-selected
选中值渲染区域。
默认内容：单选时渲染选中项目的标签；多选时将每个选中项目的标签渲染成`Tag`。
默认内容：单选时渲染选中项目的标签；多选时将每个选中项目的标签渲染为 `Tag` 组件。
+++单选时的作用域参数
| 名称 | 类型 | 描述 |

2
one/docs/components/transfer.md
View File

@ -112,7 +112,7 @@ function (keyword, { label }) {
^^^merge-checked
选中值的合并策略。
选中值的合并策略。当某个节点下的所有子节点都被选中时，可以选择只保留父节点、只保留子节点或都保留。
+++枚举值
| 值 | 描述 |

2
one/docs/components/uploader.md
View File

@ -211,7 +211,7 @@
^^^
^^^entries
控制每个上传文件的操作项，如删除，预览等，会传递默认的操作项数组作为参数，返回实际生效的操作项数组。操作项对象一般是 `{name, icon, label}`。
控制每个上传文件的操作项，如删除，预览等，会传递默认的操作项数组作为参数，返回实际生效的操作项数组。操作项对象参考 `controls` 属性的字段详情。
^^^
### 插槽

19
one/docs/demo/cascader/multiple.vue
View File

@ -1,25 +1,27 @@
<template>
<article>
<section class="cascader-config">
<veui-checkbox v-model="clearable2">Clearable</veui-checkbox>
<veui-checkbox v-model="showSelectAll2">有全选</veui-checkbox>
<veui-checkbox ui="s" v-model="clearable2">Clearable</veui-checkbox>
<veui-checkbox ui="s" v-model="showSelectAll2">ShowSelectAll</veui-checkbox>
<veui-radio
v-model="trigger2"
ui="s"
value="click"
name="columnTrigger2"
>点击展开</veui-radio>
>click to expand</veui-radio>
<veui-radio
v-model="trigger2"
ui="s"
value="hover"
name="columnTrigger2"
>hover展开</veui-radio>
>hover to expand</veui-radio>
<label>
Max:
<veui-number-input v-model="max2"/>
<veui-number-input ui="s" v-model="max2"/>
</label>
<label>
列宽度:
<veui-input v-model="columnWidth2"/>
columnWidth:
<veui-input ui="s" v-model="columnWidth2"/>
</label>
</section>
<veui-cascader
@ -182,7 +184,8 @@ export default {
align-items: center;
height: 32px;
& > * {
margin-right: 32px;
margin-right: 8px;
font-size: 12px;
}
.veui-input {
width: 80px;

4
one/docs/demo/directives/drag/sort-x.vue
View File

@ -118,9 +118,11 @@ export default {
font-size: 1.2em;
}
}
</style>
<style lang="less" scoped>
.list-move {
// UE 给出的动画曲线是 0.25, 0.1, 0.25, 1，就是 ease
// 动画曲线是 0.25, 0.1, 0.25, 1，就是 ease
transition: transform 200ms ease;
}
</style>

4
one/docs/demo/directives/drag/sort-y.vue
View File

@ -124,9 +124,11 @@ export default {
border-color: peachpuff;
}
}
</style>
<style lang="less" scoped>
.list-move {
// UE 给出的动画曲线是 0.25, 0.1, 0.25, 1，就是 ease
// 动画曲线是 0.25, 0.1, 0.25, 1，就是 ease
transition: transform 200ms ease;
}
</style>

4
one/docs/directives/v-drag.md
View File

@ -49,7 +49,7 @@
| `axis` | `string` | - | 限制所有目标元素只能在水平或者垂直方向上做变换。取值为：`x`、`y`。 |
| `dragstart` | `function(): Object` | `function() {}` | [^dragstart] |
| `drag` | `function(): Object` | `function() {}` | [^drag] |
| `disabled` | `boolean` | `false` | 动态开关该指令 |
| `disabled` | `boolean` | `false` | 该指令是否被禁用。 |
| `dragend` | `function(): Object` | `function() {}` | 鼠标拖拽结束事件的回调函数。回调参数同 `drag`。 |
| `ready` | `function` | `function() {}` | 指令初始化完成的回调函数，会传出一个句柄对象参数，该对象上有一个 `reset()` 方法，用于将所有目标元素重置为变换之前的样子。 |
@ -120,7 +120,7 @@
## 拖拽排序（v-drag.sort）
可以通过 `v-drag.sort` 或 `v-drag="{type: 'sort', ...}"` 来实现拖拽排序
可以通过 `v-drag.sort` 或 `v-drag="{type: 'sort', ...}"` 来实现拖拽排序。
### 绑定值