useImage

类别

Browser

导出体积

1.19 kB

上次更改

7 months ago

响应式加载浏览器中的图像，你可以等待结果以显示它，或显示一个备用图像。

示例

源码 playground (beta)

使用方法

vue

<script setup lang="ts">
import { useImage
 } from '@vueuse/core'

const avatarUrl
 = 'https://place.dog/300/200'
const { isLoading
 } = useImage
({ src
: avatarUrl
 })
</script>

<template>
  <span
 v-if="isLoading
">加载中</span
>
  <img
 v-else :src
="avatarUrl
">
</template>

组件使用

vue

<template>
  <UseImage src
="https://place.dog/300/200">
    <template #loading>
      加载中..
    </template>

    <template #error>
      加载失败
    </template>
  </UseImage>
</template>

类型声明

显示类型声明

export interface UseImageOptions {
  /** 资源的地址 */
  src
: string
  /** 不同情况下使用的图片，例如高分辨率显示器、小型监视器等 */
  srcset
?: string
  /** 不同页面布局的图片尺寸 */
  sizes
?: string
  /** 图片的替代信息 */
  alt
?: string
  /** 图片的类名 */
  class
?: string
  /** 图片的加载方式 */
  loading
?: HTMLImageElement["loading"]
  /** 图片的跨域设置 */
  crossorigin
?: string
  /** 获取者策略用于获取资源 */
  referrerPolicy
?: HTMLImageElement["referrerPolicy"]
  /** Image width */
  width
?: HTMLImageElement["width"]
  /** Image height */
  height
?: HTMLImageElement["height"]
  /** https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#decoding */
  decoding
?: HTMLImageElement["decoding"]
  /** Provides a hint of the relative priority to use when fetching the image */
  fetchPriority
?: HTMLImageElement["fetchPriority"]
  /** Provides a hint of the importance of the image */
  ismap
?: HTMLImageElement["isMap"]
  /** The partial URL (starting with #) of an image map associated with the element */
  usemap
?: HTMLImageElement["useMap"]
}
/**
 * Reactive load an image in the browser, you can wait the result to display it or show a fallback.
 *
 * @see https://vueuse.org/useImage
 * @param options Image attributes, as used in the <img> tag
 * @param asyncStateOptions
 */
export declare function useImage
<Shallow
 extends true>(
  options
: MaybeRefOrGetter
<UseImageOptions>,
  asyncStateOptions
?: UseAsyncStateOptions
<Shallow
>,
): UseAsyncStateReturn
<HTMLImageElement | undefined, any[], true>
export type UseImageReturn
 = ReturnType
<typeof useImage
>