1.6.11 • Published 2 years ago

@invyo/react-images-viewer v1.6.11

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-images-viewer

Build Status

jest

A react library that view photos list easily, and a simple, responsive viewer component for displaying an array of images.

中文文档

Quick start

# recommended
yarn add react-images-viewer

or

npm install react-images-viewer --save
import React from "react";
import ImgsViewer from "react-images-viewer";

export default class Demo extends React.Component {
  render() {
    return (
      <ImgsViewer
        imgs={[
          { src: "http://example.com/img1.jpg" },
          { src: "http://example.com/img2.png" },
        ]}
        currImg={this.state.currImg}
        isOpen={this.state.viewerIsOpen}
        onClickPrev={this.gotoPrevious}
        onClickNext={this.gotoNext}
        onClose={this.closeViewer}
      />
    );
  }
}

Demo & Example

Live Demo: guonanci.github.io/react-images-viewer

yarn install
yarn
yarn start

Then open localhost:8000 in a browser.

Using srcSet

Example using srcSet:

<ImgsViewer
  imgs={IMG_SET}
  ...
/>
const IMG_SET = [
  {
    src: "http://example.com/img1.svg",
    caption: "A forest",
    // As an array
    srcSet: [
      "http://example.com/img1_1024.jpg 1024w",
      "http://example.com/img1_800.jpg 800w",
      "http://example.com/img1_500.jpg 500w",
      "http://example.com/img1_320.jpg 320w",
    ],
  },
  {
    src: "http://example.com/img2.svg",
    // As a string
    srcSet:
      "http://example.com/img2_1024.jpg 1024w, http://example.com/img2_800.jpg 800w, http://example.com/img2_500.jpg 500w, http://example.com/img2_320.jpg 320w",
  },
];

Options

PropertyTypeDefaultDescription
backdropCloseableboolfalseAllow users to exit the viewer by clicking the backdrop
closeBtnTitlestrundefinedCustomize close esc title
enableKeyboardInputbooltrueSupports keyboard input - space, esc, arrow left, arrow up, and arrow right, arrow down
currImgnum0Required if you want to navigate the imgsViewer, The index of the image to display initially
customControlsarrundefinedAn array of elements to display as custom controls on the top of viewer
imgsarrundefinedRequired. Array of image objects, See img opts table below
imgCountSeparatorstr' / 'Customize separator in the image count
isOpenboolfalseRequired if you want to navigate the imgsViewer, Whether or not the viewer is displayed
leftArrowTitlestrundefinedCustomize of left arrow title
onClickPrevfuncundefinedRequired if you want to navigate the imgsViewer, and fired on request of the previous image
onClickNextfuncundefinedRequired if you want to navigate the imgsViewer, and fired on request of the next image
onClosefuncundefinedRequired if you want to close the imgsViewer, and handle closing of the viewer
onClickImgfuncundefinedHandle click on current image
onClickThumbnailfuncundefinedHandle click on thumbnail
preloadNextImgbooltrueWhether to preload the next available image
rightArrowTitlestrundefinedCustomize right arrow title
showCloseBtnbooltrueOptionally display a close 'X' button in top right corner
showImgCountbooltrueOptionally display image index, e.g., "2 of 20"
widthnumber1024Maximum width of the carousel; defaults to 1024px
spinnerDisabledboolfalseDisable Spinner
spinnerfuncDefaultSpinnerSpinner component class
spinnerColorstr'#fff'Color of spinner
spinnnerSizenum50Size of spinner
preventAutoScrollbooltrueDetermines whether auto-scrolling is prevented

Imgs Object

PropertyTypeDefaultDescription
srcstrundefinedRequired
srcSetarr of str or strundefinedOptional
captionstrundefinedOptional
altstrundefinedOptional