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

marko-lazy

v1.0.5

Published

Marko based lazy loader

Downloads

87

Readme

marko-lazy

A simple lazy loader for marko components that will only load the component when it's in view
To use: npm install marko-lazy
Create a lazy-renderers.js file at your project root that looks something like this:

export default async function (componentName) {
  switch (componentName) {
    case "myAwesomeWidget":
      return await import("./path/to/myAwesomeWidget.marko"); //client side rendering is better for complex items with state
    case "myAwesomeWidget2":
      return "/path/to/ssr/of/myAwesomeWidget2.marko"; //server side rendering is better for simple items
  }
}

Then, inside a marko file you can use it like this:
lazy-loader component="myAwesomeWidget" model={foo:"bar"}

@skeleton (optional)

If you want a placeholder loading widget to display you can supply a skeleton like this:

lazy-loader component="myAwesomeWidget" model={foo:"bar"}
    @skeleton
        div -- loading...

renderMethod (optional)

Alternatively you can use the renderMethod prop to pass in a function that resolves to the component. (Note: this may not work as expected in the root component)

$ let renderMethod = async () => {
  return await import('./path/to/myAwesomeWidget.marko')
}
lazy-loader component="myAwesomeWidget" model={foo:"bar"} renderMethod=renderMethod
  @skeleton
    div -- loading...

enhanceModel (optional)

Pass a url to the enhanceModel property to have the lazy-loader fetch data from your server that gets appended to the model before attempting to render it.

lazy-loader component="myAwesomeWidget" model={foo:"bar"} enhanceModel="/path/to/data"

customLoadEvent (optional)

If the customLoadEvent property is set, then view-based lazy loading will be disabled and it will instead attach a listener to the custom load event.
Example:

lazy-loader component="pop-up" customLoadEvent="myFormSubmit" model={foo:"bar"}

//^that would only render when the myFormSubmit event is fired elsewhere in code like this:

document.dispatchEvent(new CustomEvent("myFormSubmit"));

vite config note

To allow lazy loaded components to hot-reload, exclude marko-lazy from the optimized dependency list in your vite config.

import { defineConfig } from "vite";
export default defineConfig({
    ...
    optimizeDeps: {
        exclude: ["marko-lazy"],
    }
});

example code for server-side rendering of a single marko component in express

import icon from '../path/to/icon.marko'
const lazyComponents = {
    "icon":icon
}
export const getHTMLComponent = async(req,res)=>{
  let model = req.body || {};
	let componentName = String(req.params.componentName).replace(/[^0-9A-Za-z\-\_\/\?\.]/g,'');
    if(typeof lazyComponents[componentName] == "undefined") return res.json({error:"invalid component"});
    let html = await new Promise((resolve) => {
        lazyComponents[componentName].renderToString(model, (err, result) => {
            if(err) console.log(err);
            resolve(result)
        });
    });
    res.set('Content-Type', 'text/html');
    res.send(html);
}

note:
this project seemed to work best with node v18, your mileage may vary with older node versions.