Code Monkey home page Code Monkey logo

react-image's Introduction

React-Image ๐Ÿ–ผ

Lightweight React Component To Lazy Load Images.

bundle size license npm release zero dependency

Features

  • Super Lightweight (Less than 1KB) ๐Ÿ”ฅ
  • Easy Setup โš™
  • Easy Customization โ›
  • Zero Dependencies! ๐Ÿคฏ

Installation

Install React-Image with npm

  npm install @kunalukey/react-image

Usage/Examples

  • React 16.8.0 and higher is required.
  • You should have a placeholder image saved locally in your project. You can create one and download it from HERE
import { LazyImage } from "@kunalukey/react-image";
import placeholderImage from "../assets/placeholder.png";

const MyComponent = () => {

  return (
    <div>
          <LazyImage
            placeholderSrc={placeholderImage}
            placeholderStyle={{ width: "100%" }}
            placeholderClassName="placeholderClassName"
            src="https://source.unsplash.com/random/1920x1080"
            alt="my-image"
            className="imageClassName"
            style={{ width: "100%" }}
          />
    </div>
  );
};

export default MyComponent;

Props

Props Required Description
placeholderSrc true Placeholder image src (locally saved image is recommended).
placeholderClassName - className for placeholder image.
placeholderStyle - style for placeholder image.
src true src for an actual image.
alt - alt tag for an actual image.
className - className for an actual image.
style - style for an actual image.

License

license

react-image's People

Contributors

helloukey avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.