react-image-browser
v1.2.1
Published
React imageBrowser is simple and easy to use pre-built component for react projects. RiB contains slide and grid view, automated slideshow, image-info-options and fullscreen mode.
Downloads
31
Maintainers
Readme
React imageBrowser
More preview images in preview-images folder.
New
v.1.2.1: propTypes removed (not needed) v.1.2.0: SVG icons for consistency and mediascreen update for small screens.
What is React imageBrowser?
React imageBrowser is a simple to use image browser component for React applications. It is designed to be easy to set up and use, while still being customizable and responsive. It can be used to display images in a grid or as a slideshow, with swipe-motion and automated slideshow features.
- Easy to set up
- Responsive
- Customizible
- Slide & Grid view
- Swipe-motion ready
- Automated slideshow
Installation
npm install react-image-browser
Install react-image-browser package from NPM.
Manual installation
Clone the repository from GitHub and copy react-image-browser.jsx and imageBrowser.css to your project.
Basic Setup
Import
import ImageBrowser from 'react-image-browser'
Add images (object array)
const images = [
{ url: 'imageURL', title: 'imageTitle', description: 'ImageALT', author: 'imageAuthor' },
{ url: 'imageURL', title: 'imageTitle', description: 'ImageALT', author: 'imageAuthor' }
];
Set up an array of objects, each containing image url, title, description, author, date, and location. Only url is mandatory, other info is optional. Images can be local or fetched from internet.
object options:
- url
- title (optional)
- description (optional)
- date (optional)
- location (otional)
- author (optional)
Component
<ImageBrowser images='images' />
Add componennt to your application where you want images to show.
Props
images
<ImageBrowser images='yourImgArray' />
Array of image objects. Each object must contain url -property. Optional properties are title, description, author, date, location.
open
<ImageBrowser images='yourImgArray' open='grid' />
Set to grid to open ImageBrowser in grid view. Default is slide.
button
<ImageBrowser images='yourImgArray' button='Open ImageBrowser' />
Set a string / node to open ImageBrowser with button. Button style can be modified from inside imageBrowser.css file.
actions
<ImageBrowser images='yourImgArray' actions={true} />
Set to true to display Like, Share, and Comment button on image info. Default is false. You need to create and pass your own functions to these buttons.
Read more about ImageBrowser from the website:
https://fakemanigh.github.io/rib-website/