-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
89,190 additions
and
119,317 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +0,0 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
### ImageViewer Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
closeBtn | Boolean / Slot / Function | true | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N | ||
deleteBtn | Boolean / Slot / Function | false | Typescript:`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N | ||
images | Array | [] | Typescript:`Array<string>` | N | ||
index | Number | - | `v-model:index` is supported | N | ||
defaultIndex | Number | - | uncontrolled property | N | ||
maxZoom | Number | 3 | Typescript:`Number` | N | ||
showIndex | Boolean | false | \- | N | ||
visible | Boolean | false | `v-model` and `v-model:visible` is supported | N | ||
onClose | Function | | Typescript:`(context: { trigger: 'overlay' \| 'close-btn', visible: Boolean, index: Number }) => void`<br/> | N | ||
onDelete | Function | | Typescript:`(index: Number) => void`<br/> | N | ||
onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' }) => void`<br/> | N | ||
|
||
### ImageViewer Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
close | `(context: { trigger: 'overlay' \| 'close-btn', visible: Boolean, index: Number })` | \- | ||
delete | `(index: Number)` | \- | ||
index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | \- | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +0,0 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
### ImageViewer Props | ||
|
||
名称 | 类型 | 默认值 | 说明 | 必传 | ||
-- | -- | -- | -- | -- | ||
closeBtn | Boolean / Slot / Function | true | 是否展示关闭按钮,值为 `true` 显示默认关闭按钮;值为 `false` 则不显示关闭按钮;也可以完全自定义关闭按钮。TS 类型:`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N | ||
deleteBtn | Boolean / Slot / Function | false | 是否显示删除操作,前提需要开启页码。TS 类型:`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N | ||
images | Array | [] | 图片数组。TS 类型:`Array<string>` | N | ||
index | Number | - | 当前预览图片所在的下标。支持语法糖 `v-model:index` | N | ||
defaultIndex | Number | - | 当前预览图片所在的下标。非受控属性 | N | ||
maxZoom | Number | 3 | 【开发中】最大放大比例。TS 类型:`Number` | N | ||
showIndex | Boolean | false | 是否显示页码 | N | ||
visible | Boolean | false | 隐藏/显示预览。支持语法糖 `v-model` 或 `v-model:visible` | N | ||
onClose | Function | | TS 类型:`(context: { trigger: 'overlay' \| 'close-btn', visible: Boolean, index: Number }) => void`<br/>关闭时触发 | N | ||
onDelete | Function | | TS 类型:`(index: Number) => void`<br/>点击删除操作按钮时触发 | N | ||
onIndexChange | Function | | TS 类型:`(index: number, context: { trigger: 'prev' \| 'next' }) => void`<br/>预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片 | N | ||
|
||
### ImageViewer Events | ||
|
||
名称 | 参数 | 描述 | ||
-- | -- | -- | ||
close | `(context: { trigger: 'overlay' \| 'close-btn', visible: Boolean, index: Number })` | 关闭时触发 | ||
delete | `(index: Number)` | 点击删除操作按钮时触发 | ||
index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | 预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片 | ||
Oops, something went wrong.