0.1.0 • Published 2 years ago

react-simple-before-after v0.1.0

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

React Simple Rating

A simple yet powerful react component for adding a nice before after image slider to your project.

NPM npm bundle size GitHub

Install

npm

npm i react-simple-before-after

Yarn

yarn add react-simple-before-after

Usage

import { BeforeAfter } from 'react-simple-before-after'

export default function MyComponent() {
  return (
    <div className='App'>
      <BeforeAfter
        beforeImage='https://picsum.photos/id/646/1920/1080?grayscale'
        afterImage='https://picsum.photos/id/646/1920/1080'
        /* Other Props */
      />
    </div>
  )
}

Available Props

PropTypeOptionsDescriptionDefault
beforeImagestringRequiredBefore image src-
afterImagestringRequiredAfter image src-
pointerMovebooleanOptionalEnables onPointerMove instead of input onChangefalse
onChangefunctionOptionalonChange callback using input type range method (default)-
onPointerMovefunctionOptionalonPointerMove callback available when pointerMove is enabled-
onPointerEnterfunctionOptionalonPointerEnter callback-
onPointerLeavefunctionOptionalonPointerLeave callback-
classNamestringOptionalMain div classNamebefore-after-slider
beforeClassNamestringOptionalBefore div classNamebefore
afterClassNamestringOptionalAfter div classNameafter
buttonClassNamestringOptionalButton div className (not availabe if pointerMove is enabled)resize-button
styleReact.CSSPropertiesOptionalMain div inline style-
beforeStyleReact.CSSPropertiesOptionalBefore div inline style-
afterStyleReact.CSSPropertiesOptionalAfter div inline style-
buttonStyleReact.CSSPropertiesOptionalButton div inline style (not availabe when pointerMove is enabled)-

Demo

See demo in action.

Edit react-before-after-slider

License

MIT © awran5