mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-27 06:39:14 +08:00
130 lines
3.8 KiB
Markdown
130 lines
3.8 KiB
Markdown
# Image
|
||
|
||
### Intro
|
||
|
||
Enhanced img tag with multiple image fill modes, support for image lazy loading, loading hint, loading failure hint.
|
||
|
||
### Install
|
||
|
||
Register component globally via `app.use`, refer to [Component Registration](#/en-US/advanced-usage#zu-jian-zhu-ce) for more registration ways.
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
import { Image as VanImage } from 'vant';
|
||
|
||
const app = createApp();
|
||
app.use(VanImage);
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Basic Usage
|
||
|
||
```html
|
||
<van-image width="100" height="100" src="https://img.yzcdn.cn/vant/cat.jpeg" />
|
||
```
|
||
|
||
### Fit Mode
|
||
|
||
```html
|
||
<van-image
|
||
width="10rem"
|
||
height="10rem"
|
||
fit="contain"
|
||
src="https://img.yzcdn.cn/vant/cat.jpeg"
|
||
/>
|
||
```
|
||
|
||
### Round
|
||
|
||
Show round image, it may not works at `fit=contain` and `fit=scale-down`.
|
||
|
||
```html
|
||
<van-image
|
||
round
|
||
width="10rem"
|
||
height="10rem"
|
||
src="https://img.yzcdn.cn/vant/cat.jpeg"
|
||
/>
|
||
```
|
||
|
||
### Lazy Load
|
||
|
||
```html
|
||
<van-image
|
||
width="100"
|
||
height="100"
|
||
lazy-load
|
||
src="https://img.yzcdn.cn/vant/cat.jpeg"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
import { Lazyload } from 'vant';
|
||
|
||
const app = createApp();
|
||
app.use(Lazyload);
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| Attribute | Description | Type | Default |
|
||
| --- | --- | --- | --- |
|
||
| src | Src | _string_ | - |
|
||
| fit | Fit mode | _string_ | `fill` |
|
||
| alt | Alt | _string_ | - |
|
||
| width | Width | _number \| string_ | - |
|
||
| height | Height | _number \| string_ | - |
|
||
| radius | Border Radius | _number \| string_ | `0` |
|
||
| round | Whether to be round | _boolean_ | `false` |
|
||
| lazy-load | Whether to enable lazy load，should register [Lazyload](#/en-US/lazyload) component | _boolean_ | `false` |
|
||
| show-error | Whether to show error placeholder | _boolean_ | `true` |
|
||
| show-loading | Whether to show loading placeholder | _boolean_ | `true` |
|
||
| error-icon | Error icon | _string_ | `photo-fail` |
|
||
| loading-icon | Loading icon | _string_ | `photo` |
|
||
| icon-size `v3.0.11` | Icon size | _number \| string_ | `32px` |
|
||
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
|
||
|
||
### fit optional value
|
||
|
||
| name | desctription |
|
||
| --- | --- |
|
||
| contain | Keep aspect ratio, fully display the long side of the image |
|
||
| cover | Keep aspect ratio, fully display the short side of the image, cutting the long side |
|
||
| fill | Stretch and resize image to fill the content box |
|
||
| none | Not resize image |
|
||
| scale-down | Take the smaller of `none` or `contain` |
|
||
|
||
### Events
|
||
|
||
| Event | Description | Arguments |
|
||
| ----- | ------------------------------ | ------------------- |
|
||
| click | Emitted when image is clicked | _event: MouseEvent_ |
|
||
| load | Emitted when image loaded | - |
|
||
| error | Emitted when image load failed | - |
|
||
|
||
### Slots
|
||
|
||
| Name | Description |
|
||
| ------- | ---------------------------------- |
|
||
| default | Custom the content below the image |
|
||
| loading | Custom loading placeholder |
|
||
| error | Custom error placeholder |
|
||
|
||
### CSS Variables
|
||
|
||
The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).
|
||
|
||
| Name | Default Value | Description |
|
||
| ---------------------------------------- | ------------------- | ----------- |
|
||
| --van-image-placeholder-text-color | `@gray-6` | - |
|
||
| --van-image-placeholder-font-size | `@font-size-md` | - |
|
||
| --van-image-placeholder-background-color | `@background-color` | - |
|
||
| --van-image-loading-icon-size | `32px` | - |
|
||
| --van-image-loading-icon-color | `@gray-4` | - |
|
||
| --van-image-error-icon-size | `32px` | - |
|
||
| --van-image-error-icon-color | `@gray-4` | - |
|