@nuxt-modules/lazy-load
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

@nuxt-modules/lazy-load

@nuxt-modules/lazy-load

npm version npm downloads Github Actions CI Codecov License

Lazy Loading Images module for Nuxt 3

Features

  • Nuxt 3 ready
  • Easy Lazy Loading Images, Pictures, and other HTML elements
  • Advanced configuration using Lozad.js
  • Handy composable useLazyLoad
  • TypeScript support

📖  Read the documentation

Setup

yarn add @nuxt-modules/lazy-load # yarn
npm i @nuxt-modules/lazy-load # npm

Basic usage

Firstly, you need to add @nuxt-modules/lazy-load to your Nuxt config.

// nuxt.config.js

{
  buildModules: [
    ['@nuxt-modules/lazy-load']
  ]
}

Then you can start using @nuxt-modules/lazy-load in your setup function!

<script setup lang="ts">
const { init } = useLazyLoad();

onMounted(() => {
  init()
})
</script>

Lastly, let's add a lazy class and change src attribute to data-src

<img class="lazy" data-src="https://path-to-image.jpg"/>

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using yarn dev or npm run dev

License

MIT License

Package Sidebar

Install

npm i @nuxt-modules/lazy-load

Weekly Downloads

67

Version

0.2.0

License

MIT

Unpacked Size

11.9 kB

Total Files

15

Last publish

Collaborators

  • baroshem