ant-design/components/image/index.zh-CN.md
afc163 e027cbec1c
docs: format all markdown (#38629)
* chore: add prettier-ignore in markdown demo

* docs: format markdown api table

* docs: format markdown api table
2022-11-17 17:31:26 +08:00

2.2 KiB

category subtitle group title cols cover
Components 图片 数据展示 Image 2 https://gw.alipayobjects.com/zos/antfincdn/D1dXz9PZqa/image.svg

可预览的图片。

何时使用

  • 需要展示图片时使用。
  • 加载大图时显示 loading 或加载失败时容错处理。

代码演示

基本用法 容错处理 渐进加载 多张图片预览 相册模式 自定义预览图片 受控的预览 自定义预览文本 多图预览时顶部进度自定义

API

参数 说明 类型 默认值 版本
alt 图像描述 string - 4.6.0
fallback 加载失败容错地址 string - 4.6.0
height 图像高度 string | number - 4.6.0
placeholder 加载占位, 为 true 时使用默认占位 ReactNode - 4.6.0
preview 预览参数,为 false 时禁用 boolean | previewType true 4.6.0 previewType:4.7.0
src 图片地址 string - 4.6.0
width 图像宽度 string | number - 4.6.0
onError 加载错误回调 (event: Event) => void - 4.12.0
rootClassName 为展示图片根 DOM 和预览大图根 DOM 提供自定义 className string - 4.20.0

previewType

{
  visible?: boolean;
  onVisibleChange?: (visible, prevVisible) => void;
  getContainer?: string | HTMLElement | (() => HTMLElement); // v4.8.0
  src?: string; // v4.10.0
  mask?: ReactNode; // v4.9.0
  maskClassName?: string; // v4.11.0
  current?: number; // v4.12.0 仅支持 PreviewGroup
  countRender?: (current: number, total: number) => string  // v4.20.0 仅支持 PreviewGroup
  scaleStep?: number;
  forceRender?: boolean;
}

其他属性见 <img>