vuetify-lazy-image

This repository is a fork of v-lazy-image. I wanted this component to use v-img and maintain the aspect ratio

A Vue.js component to lazy load an image automatically when it enters the viewport using the Intersection Observer API.

Check out the fundaments on how it's built in this Alligator.io article.

Usage

npm install vuetify-lazy-image

Warning: You'll need to install the w3c Intersection Observer polyfill in case you're targeting a browser which doesn't support it.

You can register the component globally so it's available in all your apps:

import Vue from "vue";
import { VuetifyLazyImagePlugin } from "vuetify-lazy-image";

Vue.use(VuetifyLazyImagePlugin);

Or use it locally in any of your components:

import VuetifyLazyImage from "vuetify-lazy-image";

export default {
  components: {
    VuetifyLazyImage
  }
};

You must pass an src property with the link of the image:

<template>
  <vuetify-lazy-image src="http://lorempixel.com/400/200/" />
</template>

That image will be loaded as soon as the image enters the viewport.

Progressive Loading

You can use the src-placeholder property to define an image that is shown until the src image is loaded.

When the src image is loaded, a vuetify-lazy-image-loaded class is added, so you can use it to perform animations. For example, a blur effect:

<template>
  <vuetify-lazy-image
    src="https://cdn-images-1.medium.com/max/1600/1*xjGrvQSXvj72W4zD6IWzfg.jpeg"
    src-placeholder="https://cdn-images-1.medium.com/max/80/1*xjGrvQSXvj72W4zD6IWzfg.jpeg"
    aspectRatio=1.77
    />
</template>

<style scoped>
.vuetify-lazy-image {
  filter: blur(10px);
  transition: filter 0.7s;
}
.vuetify-lazy-image-loaded {
  filter: blur(0);
}
</style>

You could listen to the intersect and load events for more complex animations and state handling:

<template>
  <vuetify-lazy-image
    src="https://cdn-images-1.medium.com/max/1600/1*xjGrvQSXvj72W4zD6IWzfg.jpeg"
    src-placeholder="https://cdn-images-1.medium.com/max/80/1*xjGrvQSXvj72W4zD6IWzfg.jpeg"
    @intersect="..."
    @load="..."
    />
</template>

@jmperezperez has written about the progressive loading technique on his blog, in case you want a deeper explanation.

API

Aside from the following API, you can pass any img attribute, such as alt, and they'll be added to the rendered <img> tag.

Fields marked as (*) are required.

Props

| Name | Type | Description | | ----------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | src | String (*) | Image src to lazy load when it intersects with the viewport | | src-placeholder | String | If defined, it will be shown until the src image is loaded. Useful for progressive image loading, see demo | | aspectRatio | Number | Aspect Ratio to maintain(default: 1.777) |

Events

| Name | Description | | ----------- | -------------------------------------------------------- | | intersect | Triggered when the image intersects the viewport | | load | Triggered when the lazy image defined in src is loaded |