npm.io
1.3.3 • Published 4 years ago

react-before-after-slider-component-bousing

Licence
MIT
Version
1.3.3
Deps
0
Size
9 kB
Vulns
0
Weekly
0
Stars
55

React before after slider component

Simple slider component for comparing images. Before and after.

screencast demo

Demo

https://smeleshkin.github.io/react-before-after-slider-component/

Build

npm run build:npm

Basic usage

npm install react-before-after-slider-component --save

Then use it in your app:

import React from 'react';
import ReactBeforeSliderComponent from 'react-before-after-slider-component';
import 'react-before-after-slider-component/dist/build.css';

const FIRST_IMAGE = {
  imageUrl: 'https://example.com/.../some-image.jpg'
};
const SECOND_IMAGE = {
  imageUrl: 'https://example.com/.../some-image-2.jpg'
};
/* ... */
<ReactBeforeSliderComponent
    firstImage={FIRST_IMAGE}
    secondImage={SECOND_IMAGE}
/>
/* ... */

Props

Attribute Required Type Default Description
firstImage true Image Image object with source url.
secondImage true Image Image object with source url.
delimiterColor false string Custom delimiter background color.
currentPercentPosition false number 50 Start delimiter position. Or also the current position, if it will change in parent.
className false string Custom classname.
withResizeFeel false boolean true Feeling to window resizing.
onReady false function On slider ready callback.
onVisible false function On slider visible in viewport callback.
onChangePercentPosition false function On delimiter position update callback. Has new position parameter.

Specific Types

interface Image {
    imageUrl: string,
    alt?: string,
}

Keywords