🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

react-image-wrapper

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-image-wrapper

Wrapper component for image wrapper

1.0.4
latest
Source
npm
Version published
Maintainers
1
Created
Source

React Image Wrapper

React Image is an image tag replacement for React.js with fallback image support. If fallback image also fails to load then an avatar renders in image tag.

Features

  • Support the simple image to load in tag
  • Support the fallback image to load if image in src prop fails to load.
  • Support the creation of avatar through title & avatarOptions

Install

npm install --save react-image-wrapper

Usage

Import package into your app

import ReactImage from 'react-image-wrapper';

Basic

<ReactImage
  src="https://preview.ibb.co/hqhoyA/lexie-barnhorn-1114350-unsplash.jpg"
  width={100}
  height={100}
/>
Output:

Generated Avatar

The Image can be styled with boxed or rounded images

<ReactImage
  src="https://preview.ibb.co/hqhoyA/lexie-barnhorn-1114350-unsplash.jpg"
  width={100}
  height={100}
  shape="round"
  title="Rounded Image"
/>
Output:

Generated Avatar

Image stretch due to image size props can be avoided through keepAspectRatio prop

<ReactImage
  src="https://preview.ibb.co/hqhoyA/lexie-barnhorn-1114350-unsplash.jpg"
  width={100}
  height={100}
  keepAspectRatio={true}
/>
Output:

Generated Avatar

If source image fails to load then fallback source will load in image tag

<ReactImage
  src="https://error-image.jpg"
  fallbackSrc="https://preview.ibb.co/nrQadA/andrii-podilnyk-1115162-unsplash.jpg"
  width={100}
  height={100}
/>
Output:

Generated Avatar

If source of image tag and fallback source both fails to load then avatar will render through the title of image. The avatar image is customizable through avatarOptions

<ReactImage
  src="https://error-image.jpg"
  fallbackSrc="https://dummyimage.jpg"
  width={100}
  height={100}
  title="Ahsan Bilal"
  id="react-image-id"
  className="react-image-class"
  avatarOptions={
    {
      color: '#FFFFFF',
      backgroundColor: '#4186e0',
      shape:"round"
    }
  }
/>
Output:

Generated Avatar

Props

NameTypeDescription
srcStringURL of Image which needs to render in image tag.
fallbackSrcStringURL of Image which needs to render if image URL in src tag fails to render in img tag.
widthIntegerThe width of the image you want to set.
heightIntegerThe height of the image you want to set.
shapeString('round','box')The shape of image.
keepAspectRatioBooleanSet keepAspect Ratio to true to avoid image stretch due to provided width/height of image
titleStringTitle of Image which appears in image tooltip and in case of failed/unavailable fallback source it render the avatar and shows 2 letters of title in it for example, if the title is Ahsan Bilal the avatar will show AB and if the title is Ryan then it will show Ry.
idStringID attribute for image tag
classNameStringClass attribute for image tag
avatarOptionsObjectAdditional props to configure avatar properties

avatarOptions

NameTypeDescription
colorString(hex)URL of Image which needs to render in image tag.
backgroundColorString(hex)Background color of the avatar. The component assigns particular color to each letter. If you want to override the color then set this property.
shapeString('round','box')The shape of avatar.

License

ReactImageWrapper is released under MIT license

Keywords

React

FAQs

Package last updated on 20 Dec 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts