react-lazy-img-observer 1.0.0

package/LICENCE.md

@@ -0,0 +1,21 @@
+ISC License (ISC)
+
+Copyright (c) 2023 Percy Saul Rondan Chuzon
+
+Se concede permiso, de forma gratuita, a cualquier persona que obtenga una copia
+de este software y de los archivos de documentación asociados (el "Software"),
+para tratar el Software sin restricción, incluidos, entre otros, los derechos de
+uso, copia, modificación, fusión, publicación, distribución, sublicencia y/o
+venta de copias del Software y para permitir a las personas a las que se les
+proporcione el Software a hacerlo, sujeto a las siguientes condiciones:
+
+El aviso de copyright anterior y este aviso de permisos se incluirán en todas
+las copias o partes sustanciales del Software.
+
+EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O
+IMPLÍCITA, INCLUYENDO PERO NO LIMITADO A LAS GARANTÍAS DE COMERCIABILIDAD,
+IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS
+AUTORES O TITULARES DE DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGUNA
+RECLAMACIÓN, DAÑO U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN DE CONTRATO,
+AGRAVIO O DE OTRO MODO, DERIVADA DE, FUERA DE O EN CONEXIÓN CON EL SOFTWARE
+O EL USO U OTROS TRATOS EN EL SOFTWARE.

package/README.md

@@ -0,0 +1,125 @@
+# ImageLazy Component
+
+The `ImageLazy` component is a React component designed for lazy loading images. It leverages the Intersection Observer API to load images only when they are within the viewport, optimizing the loading performance of your web application.
+
+## Installation
+
+```bash
+npm install react-lazy-img-observer
+```
+
+# Usage
+
+```javascript
+import ImageLazy from "react-lazy-img-observer";
+
+const Example = () => {
+  return (
+    <ImageLazy
+      src="path/to/your/image.jpg"
+      alt="Description of the image"
+      width={600}
+      height={400}
+      className="your-class-name"
+      id="unique-image-id"
+      title="Image Title"
+      extraData={{ "data-custom-attribute": "value" }}
+    />
+  );
+};
+```
+
+## Props
+
+The ImageLazy component accepts the following props:
+
+| Prop        | Type                                        | Default | Description                                         |
+| ----------- | ------------------------------------------- | ------- | --------------------------------------------------- |
+| `src`       | `string`                                    | -       | The source URL of the image.                        |
+| `alt`       | `string`                                    | -       | The alt text for the image.                         |
+| `width`     | `number`                                    | -       | The width of the image.                             |
+| `height`    | `number`                                    | -       | The height of the image.                            |
+| `id`        | `number \| string`                          | -       | The ID of the image element.                        |
+| `className` | `string`                                    | -       | Additional class names for the image element.       |
+| `title`     | `string`                                    | -       | The title attribute for the image element.          |
+| `extraData` | `React.ImgHTMLAttributes<HTMLImageElement>` | -       | Additional attributes to pass to the image element. |
+
+
+## Example 
+
+```javascript
+import React from 'react';
+import ImageLazy from 'your-library-name';
+
+const App = () => {
+  return (
+    <div>
+      <h1>Lazy Loaded Images</h1>
+      <ImageLazy
+        src="https://example.com/image1.jpg"
+        alt="Image 1"
+        width={600}
+        height={400}
+        className="image-class"
+        id="image1"
+        title="First Image"
+      />
+      <ImageLazy
+        src="https://example.com/image2.jpg"
+        alt="Image 2"
+        width={600}
+        height={400}
+        className="image-class"
+        id="image2"
+        title="Second Image"
+      />
+    </div>
+  );
+};
+
+export default App;
+
+```
+
+## How it works
+
+The `ImageLazy` component uses the IntersectionObserver API to detect when the image enters the viewport. When the image is about to enter the viewport (50% visibility by default), the component sets the `src` attribute of the image element to load the actual image.
+
+## Intersection Observer Options
+
+- **`root`**: The element that is used as the viewport for checking visibility of the target. Defaults to `null` (the browser viewport).
+- **`rootMargin`**: Margin around the root. Can be used to grow or shrink the area used for intersection. Defaults to `"0px"`.
+- **`threshold`**: A single number or an array of numbers which indicate at what percentage of the target's visibility the observer's callback should be executed. Defaults to `0.5`.
+
+
+## Styling
+
+The `ImageLazy` component applies a blur filter to the image until it is fully loaded. You can customize the transition effect and blur amount through the `style` prop or CSS class.
+
+```css
+.image-class {
+  filter: blur(10px);
+  transition: filter 0.9s;
+}
+
+.image-class[data-src] {
+  filter: none;
+}
+
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any bugs or feature requests.
+
+## Author
+
+Percy Chuzon
+
+## Acknowledgments
+
+Thanks to the React and Intersection Observer API documentation for guidance.

package/dist/cjs/ImageLazy.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const ImageLazy = ({ src, alt, width, height, className, id, extraData, title, }) => {
+    const imageRef = (0, react_1.useRef)(null);
+    const [isIntersecting, setIsIntersecting] = (0, react_1.useState)(false);
+    (0, react_1.useEffect)(() => {
+        const observer = new IntersectionObserver((entries) => {
+            entries.forEach((entry) => {
+                if (entry.isIntersecting) {
+                    setIsIntersecting(true);
+                    if (imageRef.current) {
+                        imageRef.current.src = imageRef.current.dataset.src || "";
+                    }
+                    observer.unobserve(entry.target);
+                }
+            });
+        }, { root: null, rootMargin: "0px", threshold: 0.5 });
+        if (imageRef.current) {
+            observer.observe(imageRef.current);
+        }
+        return () => {
+            if (imageRef.current) {
+                observer.unobserve(imageRef.current);
+            }
+        };
+    }, [src]);
+    return ((0, jsx_runtime_1.jsx)("img", { title: title, className: className, loading: "lazy", ref: imageRef, "data-src": src, alt: alt, width: width, height: height, style: {
+            filter: isIntersecting ? "none" : "blur(20px)",
+            transition: "filter 0.9s",
+        }, id: id?.toString(), ...extraData }));
+};
+exports.default = ImageLazy;

package/dist/cjs/ImageLazy.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const jsx_runtime_1=require("react/jsx-runtime"),react_1=require("react"),ImageLazy=({src:e,alt:t,width:r,height:s,className:a,id:n,extraData:c,title:i})=>{const u=(0,react_1.useRef)(null),[o,l]=(0,react_1.useState)(!1);return(0,react_1.useEffect)((()=>{const e=new IntersectionObserver((t=>{t.forEach((t=>{t.isIntersecting&&(l(!0),u.current&&(u.current.src=u.current.dataset.src||""),e.unobserve(t.target))}))}),{root:null,rootMargin:"0px",threshold:.5});return u.current&&e.observe(u.current),()=>{u.current&&e.unobserve(u.current)}}),[e]),(0,jsx_runtime_1.jsx)("img",{title:i,className:a,loading:"lazy",ref:u,"data-src":e,alt:t,width:r,height:s,style:{filter:o?"none":"blur(20px)",transition:"filter 0.9s"},id:n?.toString(),...c})};exports.default=ImageLazy;

package/dist/esm/ImageLazy.js

@@ -0,0 +1,32 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useEffect, useRef, useState } from "react";
+const ImageLazy = ({ src, alt, width, height, className, id, extraData, title, }) => {
+    const imageRef = useRef(null);
+    const [isIntersecting, setIsIntersecting] = useState(false);
+    useEffect(() => {
+        const observer = new IntersectionObserver((entries) => {
+            entries.forEach((entry) => {
+                if (entry.isIntersecting) {
+                    setIsIntersecting(true);
+                    if (imageRef.current) {
+                        imageRef.current.src = imageRef.current.dataset.src || "";
+                    }
+                    observer.unobserve(entry.target);
+                }
+            });
+        }, { root: null, rootMargin: "0px", threshold: 0.5 });
+        if (imageRef.current) {
+            observer.observe(imageRef.current);
+        }
+        return () => {
+            if (imageRef.current) {
+                observer.unobserve(imageRef.current);
+            }
+        };
+    }, [src]);
+    return (_jsx("img", { title: title, className: className, loading: "lazy", ref: imageRef, "data-src": src, alt: alt, width: width, height: height, style: {
+            filter: isIntersecting ? "none" : "blur(20px)",
+            transition: "filter 0.9s",
+        }, id: id?.toString(), ...extraData }));
+};
+export default ImageLazy;

package/dist/esm/ImageLazy.min.js

@@ -0,0 +1 @@
+import{jsx as _jsx}from"react/jsx-runtime";import{useEffect,useRef,useState}from"react";const ImageLazy=({src:e,alt:t,width:r,height:s,className:a,id:n,extraData:c,title:i})=>{const o=useRef(null),[u,l]=useState(!1);return useEffect((()=>{const e=new IntersectionObserver((t=>{t.forEach((t=>{t.isIntersecting&&(l(!0),o.current&&(o.current.src=o.current.dataset.src||""),e.unobserve(t.target))}))}),{root:null,rootMargin:"0px",threshold:.5});return o.current&&e.observe(o.current),()=>{o.current&&e.unobserve(o.current)}}),[e]),_jsx("img",{title:i,className:a,loading:"lazy",ref:o,"data-src":e,alt:t,width:r,height:s,style:{filter:u?"none":"blur(20px)",transition:"filter 0.9s"},id:n?.toString(),...c})};export default ImageLazy;

package/dist/types/ImageLazy.d.ts

@@ -0,0 +1,12 @@
+type ImagesLazy = {
+    src: string;
+    alt: string;
+    width?: number;
+    height?: number;
+    id?: number | string;
+    className?: string;
+    title?: string;
+    extraData?: React.ImgHTMLAttributes<HTMLImageElement>;
+};
+declare const ImageLazy: ({ src, alt, width, height, className, id, extraData, title, }: ImagesLazy) => import("react/jsx-runtime").JSX.Element;
+export default ImageLazy;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "react-lazy-img-observer",
+  "version": "1.0.0",
+  "description": "A React component for lazy loading images with Intersection Observer",
+  "main": "dist/cjs/ImageLazy.min.js",
+  "module": "dist/esm/ImageLazy.min.js",
+  "types": "dist/types/ImageLazy.d.ts",
+  "scripts": {
+    "build": "tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json && terser dist/cjs/ImageLazy.js -o dist/cjs/ImageLazy.min.js --compress --mangle && terser dist/esm/ImageLazy.js -o dist/esm/ImageLazy.min.js --compress --mangle"
+  },
+  "keywords": [
+    "react",
+    "lazy-load",
+    "image",
+    "intersection-observer"
+  ],
+  "author": "Percy Chuzon <contacto@percychuzon.com>",
+  "license": "ISC",
+  "homepage": "https://github.com/perch33/react-lazy-img-observer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/perch33/react-lazy-img-observer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/perch33/react-lazy-img-observer/issues"
+  },
+  "dependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "terser": "^5.31.3"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "typescript": "^5.5.4"
+  }
+}

package/src/ImageLazy.tsx

@@ -0,0 +1,74 @@
+import { useEffect, useRef, useState } from "react";
+
+type ImagesLazy = {
+  src: string;
+  alt: string;
+  width?: number;
+  height?: number;
+  id?: number | string;
+  className?: string;
+  title?: string;
+  extraData?: React.ImgHTMLAttributes<HTMLImageElement>;
+};
+
+const ImageLazy = ({
+  src,
+  alt,
+  width,
+  height,
+  className,
+  id,
+  extraData,
+  title,
+}: ImagesLazy) => {
+  const imageRef = useRef<HTMLImageElement>(null);
+  const [isIntersecting, setIsIntersecting] = useState<boolean>(false);
+
+  useEffect(() => {
+    const observer = new IntersectionObserver(
+      (entries) => {
+        entries.forEach((entry) => {
+          if (entry.isIntersecting) {
+            setIsIntersecting(true);
+            if (imageRef.current) {
+              imageRef.current.src = imageRef.current.dataset.src || "";
+            }
+            observer.unobserve(entry.target);
+          }
+        });
+      },
+      { root: null, rootMargin: "0px", threshold: 0.5 }
+    );
+
+    if (imageRef.current) {
+      observer.observe(imageRef.current);
+    }
+
+    return () => {
+      if (imageRef.current) {
+        observer.unobserve(imageRef.current);
+      }
+    };
+  }, [src]);
+
+  return (
+    <img
+      title={title}
+      className={className}
+      loading="lazy"
+      ref={imageRef}
+      data-src={src}
+      alt={alt}
+      width={width}
+      height={height}
+      style={{
+        filter: isIntersecting ? "none" : "blur(20px)",
+        transition: "filter 0.9s",
+      }}
+      id={id?.toString()}
+      {...extraData}
+    />
+  );
+};
+
+export default ImageLazy;

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "dist/cjs"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+      "target": "ES2020",
+      "module": "ESNext",
+      "declaration": true,
+      "jsx": "react-jsx",
+      "declarationDir": "dist/types",
+      "removeComments": true,
+      "strict": true,
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "forceConsistentCasingInFileNames": true,
+      "outDir": "dist",
+      "moduleResolution": "node"
+  
+    },
+    "include": ["src"],
+    "exclude": ["node_modules"]
+  }