{
  "url": "https://unifast.dev/docs/packages/node/img-lazy-loading/",
  "locale": "en",
  "title": "imgLazyLoading()",
  "description": "Add loading=\"lazy\" attribute to images for deferred loading.",
  "section": "packages",
  "body": "```ts\nimport { imgLazyLoading } from \"@unifast/node\";\n```\n\n## Signature\n\n```ts\nfunction imgLazyLoading(options?: ImgLazyLoadingPluginOptions): UnifastPlugin\n```\n\n## Parameters\n\n### options?\n\nConfiguration for lazy loading behavior\n\n| Property | Type | Default | Description |\n|----------|------|---------|-------------|\n| `skipFirst` | `number` | `0` | Number of images to skip (e.g. skip hero image) |\n\nThe plugin adds both `loading=\"lazy\"` and `decoding=\"async\"` attributes to matched `<img>` elements, including images nested inside other elements.\n\n## Usage\n\n```ts\nimport { compile, imgLazyLoading } from \"@unifast/node\";\n\nconst md = `\n![Photo 1](photo1.jpg)\n\n![Photo 2](photo2.jpg)\n\n![Photo 3](photo3.jpg)\n`;\n\nconst result = compile(md, {\n  plugins: [imgLazyLoading()],\n});\n\n// All images get loading=\"lazy\" and decoding=\"async\":\n// <img src=\"photo1.jpg\" alt=\"Photo 1\" loading=\"lazy\" decoding=\"async\">\n// <img src=\"photo2.jpg\" alt=\"Photo 2\" loading=\"lazy\" decoding=\"async\">\n// <img src=\"photo3.jpg\" alt=\"Photo 3\" loading=\"lazy\" decoding=\"async\">\n```\n\n## Examples\n\n### Skip first image (hero image pattern)\n\nThe first image on a page is often a hero or banner image that should load eagerly. Use `skipFirst` to exclude it from lazy loading:\n\n```ts\nimport { compile, imgLazyLoading } from \"@unifast/node\";\n\nconst md = `\n![Hero banner](hero.jpg)\n\nSome introductory content...\n\n![Diagram](diagram.jpg)\n\nMore content...\n\n![Screenshot](screenshot.jpg)\n`;\n\nconst result = compile(md, {\n  plugins: [\n    imgLazyLoading({\n      skipFirst: 1,\n    }),\n  ],\n});\n\n// First image loads eagerly (no loading attribute):\n// <img src=\"hero.jpg\" alt=\"Hero banner\">\n//\n// Remaining images are lazy loaded:\n// <img src=\"diagram.jpg\" alt=\"Diagram\" loading=\"lazy\" decoding=\"async\">\n// <img src=\"screenshot.jpg\" alt=\"Screenshot\" loading=\"lazy\" decoding=\"async\">\n```\n\n### Skip multiple above-the-fold images\n\n```ts\nimport { compile, imgLazyLoading } from \"@unifast/node\";\n\nconst result = compile(md, {\n  plugins: [\n    imgLazyLoading({\n      skipFirst: 3, // skip the first 3 images\n    }),\n  ],\n});\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/ja/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/ko/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/fr/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/it/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/es/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/de/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/ru/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/hi/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/id/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/tr/docs/packages/node/img-lazy-loading.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/node/img-lazy-loading/",
      "api": "https://unifast.dev//api/vi/docs/packages/node/img-lazy-loading.json"
    }
  ]
}