mirror of
https://gitee.com/baidu/amis.git
synced 2024-11-30 02:58:05 +08:00
647 lines
22 KiB
Markdown
Executable File
647 lines
22 KiB
Markdown
Executable File
---
|
|
title: Image 图片
|
|
description:
|
|
type: 0
|
|
group: ⚙ 组件
|
|
menuName: Image 图片
|
|
icon:
|
|
order: 52
|
|
---
|
|
|
|
## 基本使用
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
}
|
|
}
|
|
```
|
|
|
|
也可以配置`name`属性关联上下文数据
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"data": {
|
|
"imageUrl": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
"body": {
|
|
"type": "image",
|
|
"name": "imageUrl"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 配置标题和说明
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"title": "这是标题",
|
|
"imageCaption": "这是一段说明"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 配置缩略图
|
|
|
|
### 显示模式
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"mode": "horizontal",
|
|
"data": {
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
"body": [
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "宽度占满",
|
|
"thumbMode": "w-full"
|
|
},
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "高度占满",
|
|
"thumbMode": "h-full"
|
|
},
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "颜色",
|
|
"label": "默认",
|
|
"thumbMode": "contain"
|
|
},
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "覆盖",
|
|
"thumbMode": "cover"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### 显示比例
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"mode": "horizontal",
|
|
"data": {
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
"body": [
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "1比1",
|
|
"thumbRatio": "1:1",
|
|
"thumbMode": "cover"
|
|
},
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "4比3",
|
|
"thumbRatio": "4:3",
|
|
"thumbMode": "cover"
|
|
},
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "颜色",
|
|
"label": "16比9",
|
|
"thumbRatio": "16:9",
|
|
"thumbMode": "cover"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 放大功能
|
|
|
|
配置`"enlargeAble": true`，鼠标移动到图片上会显示可点击图标，点击可放大展示
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"enlargeAble": true
|
|
}
|
|
}
|
|
```
|
|
|
|
在列表中，图片组件的放大模式下默认展示所有行的图片信息，设置`"enlargeWithGallary": true`效果相同。
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"data": {
|
|
"imageList": [
|
|
{
|
|
"name": "amis",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "amis",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692942/d8e4992057f9.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "tom",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395693148/1314a2a3d3f6.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "jack",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395693379/8f2e79f82be0.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
}
|
|
]
|
|
},
|
|
"body": {
|
|
"type": "crud",
|
|
"source": "${imageList}",
|
|
"syncLocation": false,
|
|
"columns": [
|
|
{
|
|
"name": "name",
|
|
"label": "名称"
|
|
},
|
|
{
|
|
"type": "image",
|
|
"name": "image_url",
|
|
"label": "图片",
|
|
"enlargeAble": true
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
在列表中，图片组件配置`"enlargeWithGallary": false`可以关闭放大模式下图片集列表的展示。
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"data": {
|
|
"imageList": [
|
|
{
|
|
"name": "amis",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "amis",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692942/d8e4992057f9.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "tom",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395693148/1314a2a3d3f6.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"name": "jack",
|
|
"image_url": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395693379/8f2e79f82be0.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
}
|
|
]
|
|
},
|
|
"body": {
|
|
"type": "crud",
|
|
"source": "${imageList}",
|
|
"syncLocation": false,
|
|
"columns": [
|
|
{
|
|
"name": "name",
|
|
"label": "名称"
|
|
},
|
|
{
|
|
"type": "image",
|
|
"name": "image_url",
|
|
"label": "图片",
|
|
"enlargeAble": true,
|
|
"enlargeWithGallary": false
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
可以配置`originalSrc`，来指定原图资源地址，作为放大预览的图片地址
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"originalSrc": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg",
|
|
"enlargeAble": true
|
|
}
|
|
}
|
|
```
|
|
|
|
`enlargeTitle`和`enlargeCaption`可以配置放大预览中的标题和描述
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"originalSrc": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg",
|
|
"enlargeAble": true,
|
|
"enlargeTitle": "这是一个标题",
|
|
"enlargeCaption": "这是一段描述"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 设置高宽
|
|
|
|
通过 `width` 和 `height` 可以设置缩率图显示的高宽
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"width": "200px",
|
|
"height": "200px",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_400,l_1,f_jpg,q_80"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 原图模式
|
|
|
|
> 1.2.3 及以上版本
|
|
|
|
默认图片为缩略图模式，可以通过配置 imageMode: "original" 修改为原图模式，原图模式为块状展示，宽度尽可能占满。
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"data": {
|
|
"imageUrl": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg"
|
|
},
|
|
"body": {
|
|
"type": "image",
|
|
"imageMode": "original",
|
|
"name": "imageUrl",
|
|
"title": "这是标题",
|
|
"imageCaption": "这是一段说明"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 打开外部链接
|
|
|
|
> 1.3.3 及以上版本
|
|
|
|
可以设置 href 属性来支持图片点击打开链接，需要注意这和放大功能是冲突的，只能二选一。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"href": "https://github.com/baidu/amis"
|
|
}
|
|
```
|
|
|
|
href 也可以是模板
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"data": {
|
|
"imageUrl": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg",
|
|
"imageHref": "https://github.com/baidu/amis"
|
|
},
|
|
"body": {
|
|
"type": "image",
|
|
"name": "imageUrl",
|
|
"href": "${imageHref}"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 用作 Field 时
|
|
|
|
当用在 Table 的列配置 Column、List 的内容、Card 卡片的内容和表单的 Static-XXX 中时，可以设置`name`属性，映射同名变量
|
|
|
|
### Table 中的列类型
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "table",
|
|
"data": {
|
|
"items": [
|
|
{
|
|
"id": "1",
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"id": "2",
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
{
|
|
"id": "3",
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
}
|
|
]
|
|
},
|
|
"columns": [
|
|
{
|
|
"name": "id",
|
|
"label": "Id"
|
|
},
|
|
|
|
{
|
|
"name": "image",
|
|
"label": "图片",
|
|
"type": "image"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
List 的内容、Card 卡片的内容配置同上
|
|
|
|
### Form 中静态展示
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "form",
|
|
"data": {
|
|
"image": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80"
|
|
},
|
|
"body": [
|
|
{
|
|
"type": "static-image",
|
|
"name": "image",
|
|
"label": "颜色",
|
|
"innerClassName": "no-border"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 自定义点击行为
|
|
|
|
> 1.5.0 及以上版本
|
|
|
|
可以通过 `clickAction` 设置点击触发行为。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"class": "cursor-pointer",
|
|
"clickAction": {
|
|
"actionType": "dialog",
|
|
"dialog": {
|
|
"title": "弹框标题",
|
|
"body": "这是一个弹框"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## 工具栏
|
|
|
|
> 2.2.0 及以上版本
|
|
|
|
配置`"showToolbar": true`使图片在放大模式下开启图片工具栏。配置`"toolbarActions"`属性可以自定义工具栏的展示方式，具体配置参考[ImageAction](./image#imageaction)
|
|
|
|
```schema
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"enlargeAble": true,
|
|
"showToolbar": true
|
|
}
|
|
}
|
|
```
|
|
|
|
## 属性表
|
|
|
|
| 属性名 | 类型 | 默认值 | 说明 | 版本 |
|
|
| ------------------ | ------------------------------------------------ | --------- | --------------------------------------------------------------------------------------------- | ------- |
|
|
| type | `string` | | 如果在 Table、Card 和 List 中，为`"image"`；在 Form 中用作静态展示，为`"static-image"` |
|
|
| className | `string` | | 外层 CSS 类名 |
|
|
| innerClassName | `string` | | 组件内层 CSS 类名 |
|
|
| imageClassName | `string` | | 图片 CSS 类名 |
|
|
| thumbClassName | `string` | | 图片缩率图 CSS 类名 |
|
|
| height | `string` | | 图片缩率高度 |
|
|
| width | `string` | | 图片缩率宽度 |
|
|
| title | `string` | | 标题 |
|
|
| imageCaption | `string` | | 描述 |
|
|
| placeholder | `string` | | 占位文本 |
|
|
| defaultImage | `string` | | 无数据时显示的图片 |
|
|
| src | `string` | | 缩略图地址 |
|
|
| href | [模板](../../docs/concepts/template) | | 外部链接地址 |
|
|
| originalSrc | `string` | | 原图地址 |
|
|
| enlargeAble | `boolean` | | 支持放大预览 |
|
|
| enlargeTitle | `string` | | 放大预览的标题 |
|
|
| enlargeCaption | `string` | | 放大预览的描述 |
|
|
| enlargeWithGallary | `string` | `true` | 在表格中，图片的放大功能会默认展示所有图片信息，设置为`false`将关闭放大模式下图片集列表的展示 |
|
|
| thumbMode | `string` | `contain` | 预览图模式，可选：`'w-full'`, `'h-full'`, `'contain'`, `'cover'` |
|
|
| thumbRatio | `string` | `1:1` | 预览图比例，可选：`'1:1'`, `'4:3'`, `'16:9'` |
|
|
| imageMode | `string` | `thumb` | 图片展示模式，可选：`'thumb'`, `'original'` 即：缩略图模式 或者 原图模式 |
|
|
| showToolbar | `boolean` | `false` | 放大模式下是否展示图片的工具栏 | `2.2.0` |
|
|
| toolbarActions | `ImageAction[]` | | 图片工具栏，支持旋转，缩放，默认操作全部开启 | `2.2.0` |
|
|
| maxScale | `number` 或 [模板](../../docs/concepts/template) | | 执行调整图片比例动作时的最大百分比 | `3.4.4` |
|
|
| minScale | `number` 或 [模板](../../docs/concepts/template) | | 执行调整图片比例动作时的最小百分比 | `3.4.4` |
|
|
|
|
#### ImageAction
|
|
|
|
```typescript
|
|
interface ImageAction {
|
|
/* 操作key */
|
|
key: 'rotateRight' | 'rotateLeft' | 'zoomIn' | 'zoomOut' | 'scaleOrigin';
|
|
/* 动作名称 */
|
|
label?: string;
|
|
/* 动作icon */
|
|
icon?: string;
|
|
/* 动作自定义CSS类 */
|
|
iconClassName?: string;
|
|
/* 动作是否禁用 */
|
|
disabled?: boolean;
|
|
}
|
|
```
|
|
|
|
## 事件表
|
|
|
|
当前组件会对外派发以下事件，可以通过`onEvent`来监听这些事件，并通过`actions`来配置执行的动作，在`actions`中可以通过`${事件参数名}`或`${event.data.[事件参数名]}`来获取事件产生的数据，详细查看[事件动作](../../docs/concepts/event-action)。
|
|
|
|
| 事件名称 | 事件参数 | 说明 |
|
|
| ---------- | ---------- | -------------- |
|
|
| click | 上下文数据 | 点击图片时触发 |
|
|
| mouseenter | 上下文数据 | 鼠标移入时触发 |
|
|
| mouseleave | 上下文数据 | 鼠标移入时触发 |
|
|
|
|
### click / mouseenter / mouseleave
|
|
|
|
点击图片 / 鼠标移入图片 / 鼠标移出图片，可以尝试通过${event.context.nativeEvent}获取鼠标事件对象。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "image",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"onEvent": {
|
|
"click": {
|
|
"actions": [
|
|
{
|
|
"actionType": "toast",
|
|
"args": {
|
|
"msg": "图片被点击了"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"mouseenter": {
|
|
"actions": [
|
|
{
|
|
"actionType": "toast",
|
|
"args": {
|
|
"msg": "鼠标移入图片"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"mouseleave": {
|
|
"actions": [
|
|
{
|
|
"actionType": "toast",
|
|
"args": {
|
|
"msg": "鼠标移出图片"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## 动作表
|
|
|
|
当前组件对外暴露以下特性动作，其他组件可以通过指定`actionType: 动作名称`、`componentId: 该组件id`来触发这些动作，动作配置可以通过`args: {动作配置项名称: xxx}`来配置具体的参数，详细请查看[事件动作](../../docs/concepts/event-action#触发其他组件的动作)。
|
|
|
|
| 动作名称 | 动作配置 | 说明 |
|
|
| -------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
|
|
| preview | - | 预览图片 |
|
|
| zoom | `scale: number` 或 `scale: `[模板](../../docs/concepts/template)，定义每次放大或缩小图片的百分比大小，正值为放大，负值为缩小，默认 50 | 调整图片比例，将图片等比例放大或缩小 |
|
|
|
|
### preview
|
|
|
|
预览图片，可以通过配置`originalSrc`来指定预览的原图地址。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "container",
|
|
"body": [
|
|
{
|
|
"type": "container",
|
|
"body": [
|
|
{
|
|
"type": "image",
|
|
"className": "mb-1",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"originalSrc": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg",
|
|
"id": "previewImage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "action",
|
|
"label": "预览图片",
|
|
"onEvent": {
|
|
"click": {
|
|
"actions": [
|
|
{
|
|
"actionType": "preview",
|
|
"componentId": "previewImage"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### zoom
|
|
|
|
调整图片比例，将图片等比例放大或缩小。可以通过配置图片的`maxScale`和`minScale`来限制调整的比例。
|
|
|
|
```schema: scope="body"
|
|
{
|
|
"type": "page",
|
|
"body": {
|
|
"type": "container",
|
|
"body": [
|
|
{
|
|
"type": "flex",
|
|
"items": [
|
|
{
|
|
"type": "image",
|
|
"innerClassName": "no-border",
|
|
"className": "mt-5 mb-5",
|
|
"src": "https://internal-amis-res.cdn.bcebos.com/images/2020-1/1578395692722/4f3cb4202335.jpeg@s_0,w_216,l_1,f_jpg,q_80",
|
|
"maxScale": 200,
|
|
"minScale": 20,
|
|
"id": "zoomImage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "action",
|
|
"label": "放大图片",
|
|
"onEvent": {
|
|
"click": {
|
|
"actions": [
|
|
{
|
|
"actionType": "zoom",
|
|
"args": {
|
|
"scale": 50,
|
|
},
|
|
"componentId": "zoomImage"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "action",
|
|
"label": "缩小图片",
|
|
"className": "mx-1",
|
|
"onEvent": {
|
|
"click": {
|
|
"actions": [
|
|
{
|
|
"actionType": "zoom",
|
|
"args": {
|
|
"scale": -50,
|
|
},
|
|
"componentId": "zoomImage"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|