rokugan v1.0.9

Rokugan

A simple IntersectionObserver amd MutationObserver implementation to achieve lazy loading and dynamically show elements on screen.

This also a tribute to the Honored One.

Getting Started

1. Import Rokugan (types and interfaces are optional).

import { Rokugan } from './path/to/rokugan';

2. Create a list of elements that will be observed (NodeListOf<Element | ImageElement | HTMLElement>).

// Example
elements = document.querySelectorAll('body .card')

3. Create your own setting object using the RokuganInit interface

const rokuganOptions: RokuganInit = {
    root: null,
    rootMargin: "0px",
    threshold: 0.75,
    unobserveOnShow: false // This must be false to lazy loading works
}

4. Create a function to be triggered when the user reachs the last loaded element on the viewport.

// Example

const imageURL = 'random/image/address';

async function generateImage(): Promise<void> {
    const parentRoot = document.querySelector('your-parent-element');

    for (let i = 0; i < 10; i++) {
        await new Promise(resolve => setTimeout(resolve, 2000));
        
        const newImg = document.createElement('img');
        newImg.src = imageURL;
        newImg.id = 'gojo ' + i
        newImg.loading = "lazy";
        
        parentRoot?.appendChild(newImg);
    }
}

"Throughout Heaven and Earth, I Alone Am The Honored One"