npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

st-lazy

v2.2.0

Published

Web components for lazy loading - you can use them everywhere, without any dependency. Contains also @Lazy decorator for Stenciljs to call annotated method when component is scrolled to viewport. Web components are based on @Lazy

Downloads

378

Readme

st-lazy

Built With Stencil

What is it?

st-lazy is a collection of tools (web components) for lazy loading. You can use them everywhere (any framework: React, Angular, Vue etc.) without any dependency (doesn't matter if you use SSR with templating system like JSP or CSR). Beating heart of this library is a Stencil @Lazy decorator that allows you to call component method as the user scrolls component into the viewport. For Stencil devs: @Lazy is being exported in this module so you can easily use it in your Stencil projects. On supported browsers (Chrome and chrome based browsers, Firefox and Edge) st-lazy uses IntersectionObserver to accomplish this functionality. For Safari and IE it simply falls back to setTimeout unless you use polyfill. Inspired by st-img

Polyfilling

If you want st-lazy to work everywhere (also on IE and Safari) use polyfill. You can pop this script tag:

<script src="https://polyfill.io/v3/polyfill.min.js?features=IntersectionObserver"></script>

in index.html and that's it:) Polyfill is not included in st-lazy not to increase the bundle size and to leave the decision to you: either you go with setTimeout fallback or if you prefer, go with polyfill

Installing

Outside of Stencil world you can use web components. To do that you can either

  • put st-lazy as dependency in your package.json and import web component that is relevant for you in your js/ts
  • or if outside of npm you can pop this script tag:
<script async defer src='https://unpkg.com/[email protected]/dist/stlazy.js'></script>

into your index.html Then you can just use web components in your html/jsx

In Stencil project, additionaly you can use @Lazy, just add st-lazy to your package.json:

npm i st-lazy

Module contains

1. @Lazy

@Lazy is a decorator that allows you to call component method as the user scrolls component into the viewport.

How to use it?

It's very simple: you just need to anotate your method with @Lazy and it will be called when host component is scrolled to viewport. Method will be called once - the first time you scroll to component. Additionally you need to pass host's @Element. You can do it in two ways:

Option 1: passing host element with @LazyHost


import { Component, Element } from '@stencil/core';
import { Lazy, LazyHost } from 'st-lazy';

@Component({ tag: 'lazy-component', shadow: true })
export class LazyComponent {

  @LazyHost() @Element() host;

  @Lazy()
  someMethod() { console.log("someMethod was called because user scrolled to LazyComponent"); }

  render() { return <div>Hello, World!</div>; }
}

Option 2: passing host element manually


import { Component, Element } from '@stencil/core';
import { Lazy } from 'st-lazy';

@Component({ tag: 'lazy-component', shadow: true })
export class LazyComponent {

  @Element() host;

  @Lazy({ hostProperty: "host" })
  someMethod() { console.log("someMethod was called because user scrolled to LazyComponent"); }

  render() { return <div>Hello, World!</div>; }
}

Margin

You can also set margin for @Lazy. It determines how far from the viewport lazy loading starts. Can have values similar to the CSS margin property, e.g. "10px 20px 30px 40px" (top, right, bottom, left). The values can be percentages.

  @Lazy({ margin: "50%" })
  someMethod() { console.log("someMethod was called because user scrolled to margin of LazyComponent extended by 50%"); }

or if you want to have it dynamic (as web component @Prop)

  @LazyMargin() @Prop() margin?: string;

All web components here have optional margin prop.

When use it?

Basically you can think of every action that you would normally do with the load of the page/component. Maybe some of those actions are time consuming, generating not needed network traffic and not giving any benefit to most of users? Good example is calling an API to get data to be presented by component. Maybe most of users are not even checking some forgotten carousel on the bottom of every page in your app? Or you need an easy way to implement a listing page with infinie scrolling?

Example

Following component

import { Component, State, Element } from '@stencil/core';
import { Lazy, LazyHost } from 'st-lazy';


@Component({
    tag: 'test-st-lazy'
})
export class TestStLazy {
    @State() name: string;
    @LazyHost() @Element() host;

    @Lazy()
    getName() {
        console.log("fetching user data...");
        setTimeout(() => {
            fetch("https://jsonplaceholder.typicode.com/users/1")
                .then(res => res.json())
                .then(data => {
                    this.name = data.name
                    console.log(this.name);
                })
          }, 300);
    }
    

    render() {
        return (
            <div><p>Hello {this.name}</p></div>
        );
    }
}

...on the page

<body>
    <div style="height: 1000px"></div>
    <test-st-lazy></test-st-lazy>
</body>

gives

lazy api call

2. lazy-cmp

Published on webcomponents.org

lazy-cmp is a web component to lazy load other components while its scrolled to viewport. Take a look at API

Why?

Stencil (and also some other web components compilers or frameworks) is lazy loading components by default. It loads only the ones that are actually used on the page not to add not needed js to be evaluated by the browser. Here we lift it. lazy-cmp component is using IntersectionObserver to load the component by name only if it is in the viewport. It means no html will be rendered by the browser and no js will be evaluated until you actually scroll to lazy-cmp. Then you dynamically render your component, it can have a complicated view, it can call the API to initialize... Great way to optimize your page, perfect for infinite scroll pages. On non supported browsers (IE, Safari) it falls back to setTimeout unless you use polyfill.

Example

having a simple component

import { Component } from '@stencil/core';

@Component({
    tag: 'my-component'
})
export class MyComponent {
    @Prop() name: string;
    @Prop() surname: string;

    componentWillLoad() {
        console.log('The MyComponent is about to be rendered');
    }

    componentDidLoad() {
        console.log('The MyComponent has been rendered');
    }
    
    render() {
        return (
            <div><p>Was I lazy loaded with lazy-cmp?</p></div>
        );
    }
}

and page

<body>
    <div style="height: 1000px"></div>
    <lazy-cmp
        component="my-component">
    </lazy-cmp>
</body>

gives

lazy component load

As you see component is not loaded untill it's scrolled onto viewport. Then full component lifecycle runs.

How to pass props to component?

Option 1: In JSX you can pass componentProps key/value object to lazy-cmp

  <lazy-cmp
    component="my-component"
    componentProps={{ name: 'Lazy', surname: 'Stencil' }}>
  </lazy-cmp>

Option 2: In html you can pass component-prop-? attributes to lazy-cmp

  <lazy-cmp
    component="my-component"
    component-prop-name='Lazy'
    component-prop-surname='Stencil'>
  </lazy-cmp>

or optionally you can pass the componentProps over javascript:

document.querySelector('lazy-cmp').componentProps = { name: 'Lazy', surname: 'Stencil' }

I just want to use lazy-cmp to be notifed about scrolling to some html

Sure just react on the event that lazy-cmp will throw. Will only be thrown if you pass event-value attribute

  <lazy-cmp
    event-value="contentId">
    some html...
  </lazy-cmp>

3. lazy-img

Published on webcomponents.org

lazy-img is a web component to lazy load image while its scrolled to viewport. Take a look at API

Example

<body>
    <div style="height: 1000px"></div>
    <lazy-img
        src="https://stenciljs.com/assets/img/logo.png"
        fallback-src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ5VWGwI_ToYUkeZjAxP16jZB94Yzus4Q5YErjzzB2C44rWKwL7"
        alt="Lazy image">
    </lazy-img>
</body>

gives

lazy image load

4. lazy-fetch

Published on webcomponents.org

lazy-fetch is a web component to make lazy API calls. Request is done after component is scrolled into viewport. You can set url, headers, http method and body over component params. Response will be given over events: either resolved or error. Take a look at API. You can also check stencil-fetch as lazy-fetch is based on it.

Example

<body>
    <div style="height: 1000px"></div>
    <lazy-fetch
        url="https://jsonplaceholder.typicode.com/users/1">
    </lazy-fetch>
</body>

gives

lazy fetch

How to pass headers?

In html you can use header-? attribute

  <lazy-fetch
    url="https://jsonplaceholder.typicode.com/users/1"
    header-keyid='authorization key'
    >
  </lazy-fetch>