Installations

npm install rehype-imgload

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

14.21.3

NPM Version

6.14.18 Pull Requests

Open

0

Total

6

Closed

0

Merged

6

Issues

Open

0

Total

1

Closed

1

Releases

8

v2.0.1

Updated on Oct 13, 2023

v2.0.0

Updated on Oct 11, 2023

v1.1.1

Updated on Oct 04, 2021

1.1.0

Updated on Aug 28, 2021

1.0.6

Updated on Aug 28, 2021

1.0.5

Updated on Aug 28, 2021

View All 8 releases

Languages

1

TypeScript

TypeScript (100%)

Developer

plastic041

Download Statistics

Total Downloads

1,284

Last Day

1

Last Week

5

Last Month

18

Last Year

191

GitHub Statistics

MIT License

1 Stars

50 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Aug 23, 2024

Bundle Size

765.00 B

Minified

452.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

2.0.1

Package Id

rehype-imgload@2.0.1

Unpacked Size

4.78 kB

Size

2.35 kB

File Count

5

NPM Version

6.14.18

Node Version

14.21.3

Published on

Oct 13, 2023

Total Downloads

Cumulative downloads

Total Downloads

1,284

Last Day

-66.7%

1

Compared to previous day

Last Week

-37.5%

5

Compared to previous week

Last Month

-43.8%

18

Compared to previous month

Last Year

-53.8%

191

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

unist-util-visit

Dev Dependencies

6

@types/hast bun-types rehype-parse rehype-stringify rimraf typescript

rehype-imgload

GitHub Workflow Status npm bundle size

Rehype plugin to add loading property into <img> tags.

Installation

1# use yarn
2$ yarn add rehype-imgload
3
4# use npm
5$ npm install rehype-imgload

Usage

General Use

Adds loading property to your <img>s.

1import rehypeImgLoad from "rehype-imgload";
2import rehypeParse from "rehype-parse";
3import rehypeStringify from "rehype-stringify";
4import { unified } from "unified";
5
6const processor = unified()
7  .use(rehypeParse)
8  .use(rehypeImgLoad)
9  .use(rehypeStringify);
10
11const output = processor.processSync(
12  '<img src="/example.jpg"><img src="/example.jpg" loading="eager">'
13);
14console.log(output.toString());
15// '<img src="/example.jpg" loading="lazy"><img src="/example.jpg" loading="eager">'
16// Latter `img` is not changed because `overwrite` is `false` by default.
17// Pass { overwrite: true } option to overwrite existing loading property.

API

This package exports no identifiers. Default export is rehypeImgLoad.

`unified().use(rehypeImgLoad[, options])`

All options are optional.

`options.overwrite`

boolean. default=false

If false, existing loading properties will remain unchanged.
If true, all loading properties will be overwritten to loading=options.mode(see below).

`options.mode`

"lazy" | "eager", default="lazy"

Indicates how the browser should load the image. MDN Reference

LICENSE

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-04-28

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More