JSPM

markdown-it-img-lazy

1.0.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 273
  • Score
    100M100P100Q89790F
  • License MIT

a markdown-it plugin to better supporting image lazy loading

Package Exports

  • markdown-it-img-lazy

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown-it-img-lazy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

markdown-it-img-lazy

a markdown-it plugin to better supporting image lazy loading

The plugin will preferentially use native image lazy-loading, if the browser does not support it, it will be implemented through lozad


Installation

yarn add markdown-it-img-lazy
# or
npm i markdown-it-img-lazy

Usage

md.use(require('markdown-it-img-lazy'), /* Options */)

then you need

load Lozad.js in the head tag of your page

load imgLazy.js closer the </body> tag of your page

![img](/img.jpg)

Options

useNative

  • Type: Boolean
  • Default: true
  • Required: false

Use the native image lazy-loading for the web

if useNative = true
![img](img.jpg) -> <p><img alt="img" data-src="img.jpg" loading="lazy" class="lazy"></p>

if useNative = false
![img](img.jpg) -> <p><img alt="img" data-src="img.jpg" class="lazy"></p>

selector

  • Type: string
  • Default: lazy
  • Required: false

Default class name for image

prefix

  • Type: string Function
  • Default: ''
  • Required: false

Config prefix for src in images