From 8a0a7fc45d7ff82a2ca688069b56f6c0078c0d08 Mon Sep 17 00:00:00 2001 From: btea <2356281422@qq.com> Date: Sat, 5 Apr 2025 19:37:14 +0800 Subject: [PATCH] docs: [image] update prop and example (#20349) --- docs/en-US/component/image.md | 43 +++++++++++++------------- docs/examples/image/custom-toolbar.vue | 4 +++ 2 files changed, 26 insertions(+), 21 deletions(-) diff --git a/docs/en-US/component/image.md b/docs/en-US/component/image.md index 59b1ae3692..eb4f107a25 100644 --- a/docs/en-US/component/image.md +++ b/docs/en-US/component/image.md @@ -65,7 +65,7 @@ image/manually-preview ## Custom Toolbar ^(2.9.4) -:::demo Custom toolbar content by `slot = toolbar`, starting from version ^(2.9.7) , the slot has a new `setActiveItem` function, which can be switched according to the index. +:::demo Custom toolbar content by `toolbar` slot, starting from version ^(2.9.7) , the slot has a new `setActiveItem` function, which can be switched according to the index. image/custom-toolbar @@ -75,26 +75,27 @@ image/custom-toolbar ### Image Attributes -| Name | Description | Type | Default | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------- | -| src | image source, same as native. | ^[string] | '' | -| fit | indicate how the image should be resized to fit its container, same as [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). | ^[enum]`'' \| 'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | '' | -| hide-on-click-modal | when enabling preview, use this flag to control whether clicking on backdrop can exit preview mode. | ^[boolean] | false | -| loading ^(2.2.3) | Indicates how the browser should load the image, same as [native](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading). | ^[enum]`'eager' \| 'lazy'` | — | -| lazy | whether to use lazy load. | ^[boolean] | false | -| scroll-container | the container to add scroll listener when using lazy load. By default, the container to add scroll listener when using lazy load. | ^[string] / ^[object]`HTMLElement` | — | -| alt | native attribute `alt`. | ^[string] | — | -| referrerpolicy | native attribute [referrerPolicy](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/referrerPolicy). | ^[string] | — | -| crossorigin | native attribute [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin). | ^[enum]`'' \| 'anonymous' \| 'use-credentials'` | — | -| preview-src-list | allow big image preview. | ^[object]`string[]` | [] | -| z-index | set image preview z-index. | ^[number] | — | -| initial-index | initial preview image index, less than the length of `url-list`. | ^[number] | 0 | -| close-on-press-escape | whether the image-viewer can be closed by pressing ESC. | ^[boolean] | true | -| preview-teleported | whether to append image-viewer to body. A nested parent element attribute transform should have this attribute set to `true`. | ^[boolean] | false | -| infinite | whether the viewer preview is infinite. | ^[boolean] | true | -| zoom-rate | the zoom rate of the image viewer zoom event. | ^[number] | 1.2 | -| min-scale ^(2.4.0) | the min scale of the image viewer zoom event. | ^[number] | 0.2 | -| max-scale ^(2.4.0) | the max scale of the image viewer zoom event. | ^[number] | 7 | +| Name | Description | Type | Default | +| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------- | +| src | image source, same as native. | ^[string] | '' | +| fit | indicate how the image should be resized to fit its container, same as [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). | ^[enum]`'' \| 'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | '' | +| hide-on-click-modal | when enabling preview, use this flag to control whether clicking on backdrop can exit preview mode. | ^[boolean] | false | +| loading ^(2.2.3) | Indicates how the browser should load the image, same as [native](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading). | ^[enum]`'eager' \| 'lazy'` | — | +| lazy | whether to use lazy load. | ^[boolean] | false | +| scroll-container | the container to add scroll listener when using lazy load. By default, the container to add scroll listener when using lazy load. | ^[string] / ^[object]`HTMLElement` | — | +| alt | native attribute `alt`. | ^[string] | — | +| referrerpolicy | native attribute [referrerPolicy](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/referrerPolicy). | ^[string] | — | +| crossorigin | native attribute [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin). | ^[enum]`'' \| 'anonymous' \| 'use-credentials'` | — | +| preview-src-list | allow big image preview. | ^[object]`string[]` | [] | +| z-index | set image preview z-index. | ^[number] | — | +| initial-index | initial preview image index, less than the length of `url-list`. | ^[number] | 0 | +| close-on-press-escape | whether the image-viewer can be closed by pressing ESC. | ^[boolean] | true | +| preview-teleported | whether to append image-viewer to body. A nested parent element attribute transform should have this attribute set to `true`. | ^[boolean] | false | +| infinite | whether the viewer preview is infinite. | ^[boolean] | true | +| zoom-rate | the zoom rate of the image viewer zoom event. | ^[number] | 1.2 | +| min-scale ^(2.4.0) | the min scale of the image viewer zoom event. | ^[number] | 0.2 | +| max-scale ^(2.4.0) | the max scale of the image viewer zoom event. | ^[number] | 7 | +| show-progress ^(2.9.4) | whether to display the preview image progress content | ^[boolean] | false | ### Image Events diff --git a/docs/examples/image/custom-toolbar.vue b/docs/examples/image/custom-toolbar.vue index f327d95193..7277e38d54 100644 --- a/docs/examples/image/custom-toolbar.vue +++ b/docs/examples/image/custom-toolbar.vue @@ -5,7 +5,11 @@ :src="url" :preview-src-list="srcList" fit="cover" + show-progress > +