@unlazy/vue

unlazy is not only framework-agnostic, but also provides a Vue component that you can use in your Vue application.

Installation

Install the @unlazy/vue package using your favorite package manager:

pnpm

pnpm add -D @unlazy/vue

yarn

yarn add -D @unlazy/vue

npm

npm install -D @unlazy/vue

Local Import

Import the UnLazyImage component in your Vue single file component and use it in your template:

<script setup lang="ts">
import { UnLazyImage } from '@unlazy/vue/components'
</script>

<template>
  <UnLazyImage
    blurhash="LKO2:N%2Tw=w]~RBVZRi};RPxuwH"
    src-set="image-320w.jpg 320w, image-640w.jpg 640w"
    auto-sizes
  />
</template>

Global Registration

If you prefer to make the LazyImage component globally available, you can register it in your main.ts file across your entire Vue application:

// src/main.ts
import { createApp } from 'vue'
import Unlazy from '@unlazy/vue'
import App from './App.vue'

const app = createApp(App)
app.use(Unlazy)
app.mount('#app')

UnLazyImage Component

The UnLazyImage component allows you to easily implement unlazy in your Vue application, providing a smoother image loading experience. The component supports automatic calculation of the sizes attribute with the autoSizes prop. It also enables you to specify a blurhash for the blurry placeholder image.

Props

The UnLazyImage component accepts the following props:

Prop	Type	Description
autoSizes	Boolean	A flag to indicate whether the sizes attribute should be automatically calculated.
blurhash	String	A BlurHash string representing the blurry placeholder image.
thumbhash	String	A ThumbHash string representing the blurry placeholder image.
placeholderSrc	String	Optional image source URL for a custom placeholder image. Will be ignored if a BlurHash or ThumbHash is provided.
placeholderSize	Number	The size of the longer edge (width or height) of the BlurHash image to be decoded, depending on the aspect ratio. This option only applies when the blurhash prop is used.
preload	Boolean	A flag to indicate whether the image should be preloaded, even if it's not in the viewport yet.

Emitted Events

Event	Description
loaded	Emitted when the image has been loaded. The event payload is the image element itself.

Examples

BlurHash

<UnLazyImage
  blurhash="LKO2:N%2Tw=w]~RBVZRi};RPxuwH"
  src-set="image-320w.jpg 320w, image-640w.jpg 640w"
  auto-sizes
/>

ThumbHash

<UnLazyImage
  thumbhash="1QcSHQRnh493V4dIh4eXh1h4kJUI"
  src-set="image-320w.jpg 320w, image-640w.jpg 640w"
  auto-sizes
/>

Inlined placeholder image

<UnLazyImage
  placeholder-src="data:image/svg+xml, ..."
  src-set="image-320w.jpg 320w, image-640w.jpg 640w"
  auto-sizes
/>

TIP

In each example, the sizes attribute is automatically calculated given the auto-sizes prop.

Preload Image

Useful if the UnLazyImage is part of e.g. a slider, and you want to preload the next image.

<template>
  <UnLazyImage
    :blurhash="blurhash"
    src-set="image-320w.jpg 320w, image-640w.jpg 640w"
    auto-sizes
    preload
  />
</template>