mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-13 15:49:10 +08:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity
729f568723
ant-design/components/image/index.en-US.md
Haniel Cui 1e2946ac3e
feat: bump rc-image version, Image add preview.scaleStep prop (#37340) 
* feat: bump rc-image version, Image add preview.scaleStep prop

* test(image): update test demos

* fix(image): fix image demo lint error
2022-09-24 19:51:26 +08:00

1.6 KiB
Raw Blame History

category type title cols cover
Components Data Display Image 2 https://gw.alipayobjects.com/zos/antfincdn/D1dXz9PZqa/image.svg

Previewable image.

When To Use

  • When you need to display pictures.
  • Display when loading a large image or fault tolerant handling when loading fail.

API

Property Description Type Default Version
alt Image description string - 4.6.0
fallback Load failure fault-tolerant src string - 4.6.0
height Image height string | number - 4.6.0
placeholder Load placeholder, use default placeholder when set true ReactNode - 4.6.0
preview preview config, disabled when false boolean | previewType true 4.6.0 previewType:4.7.0
src Image path string - 4.6.0
width Image width string | number - 4.6.0
onError Load failed callback (event: Event) => void - 4.12.0
rootClassName add custom className for image root DOM and preview mode root DOM 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 Only support PreviewGroup
  countRender?: (current: number, total: number) => string  // v4.20.0 Only support PreviewGroup
  scaleStep?: number;
}

Other attributes <img>