water_xcx/miniprogram_npm/tdesign-miniprogram/image-viewer/README.md

2.1 KiB

title description spline isComponent
ImageViewer 图片预览 图片全屏放大预览效果,包含全屏背景色、页码位置样式、增加操作等规范。 data true

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-image-viewer": "tdesign-miniprogram/image-viewer/image-viewer",
}

代码演示

基础图片预览

{{ base }}

有删除操作

{{ delete }}

图片超高情况

{{ over-height }}

图片超宽情况

{{ over-width }}

API

ImageViewer Props

名称 类型 默认值 说明 必传
background-color String / Number rgba(0, 0, 0, 1) 遮罩的背景颜色 N
images Array [] 图片数组。TS 类型:Array<string> N
initial-index Number 0 默认展示第几项 N
show-index Boolean false 是否显示页码 N
delete-btn Boolean false 是否显示删除操作,前提需要开启页码 N
close-btn Boolean false 是否显示关闭操作,前提需要开启页码 N
visible Boolean false 隐藏/显示预览 N
default-visible Boolean undefined 隐藏/显示预览。非受控属性 N

ImageViewer Events

名称 参数 描述
change (index: Number) 翻页时回调
close `(trigger: 'overlay' 'button' , visible: Boolean, index: Number)`
delete (index: Number) 点击删除操作按钮时触发