Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.85 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.85 KB

vue-lazy-renderer

Lazily render Vue.js components for performance.

Feature

Installation

npm:

npm install vue-lazy-renderer

Yarn:

yarn add vue-lazy-renderer

Usage

Registration

Use a plugin to register a global component:

import VueLazyRenderer from 'vue-lazy-renderer';
import Vue from 'vue';

Vue.use(VueLazyRenderer);

Example

Customization

Options/Props

Parameter Description Type Default
tagName The tag name of the root node of <lazy-renderer> String 'div'
preLoad The proportion of a pre-loading height or width to window.innerHeight or window.innerWidth Number 1.5
observerOptions The Intersection Observer options Object { rootMargin: '0px 50% 50% 0px' }
listenedEvents The events you want window to listen for (used by getBoundingClientRect) Array ['scroll', 'resize', 'orientationChange']
throttledWait The number of milliseconds to throttle invocations to Number 100

Events

Name Description
load Start to load elements wrapped in <lazy-renderer>

License

MIT