0.8.1 • Published 6 years ago

react-compare-component v0.8.1

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

React Compare Component

npm Travis Codecov David License

React component to compare two components side-by-side using the slider (responsive, without css width or clip)

It can be used to compare before-after images, compression quality and any other elements (video, text)

Demo

demo image

Website

For more examples: storybook WIP

Features

  • Any components to compare (images, video (native or youtube) or even plain text) example WIP
  • Doesn't use width or clip
  • Responsive (native, without JS listeners) example WIP
  • Dependencies free
  • Custom slider component example WIP
  • Full control programmatically
    • Default slider position example WIP
    • Set custom slider position from a script example WIP
    • Callback for all actions (onDragStart, onDragEnd, onPositionChange (also you can prevent this action)) example WIP
  • Web accessibility more WIP
  • Native animations example WIP, more WIP
  • Four different behaviors (move, click, drag, static) example WIP, more WIP
  • Mobile friendly more WIP
  • Well tested with 100% coverage WIP
  • Code quality by tslint and eslint WIP
  • Strong typed by TypeScript

Docs

<Compare
	 left={<img src="path/to/image.jpg" style={{display: 'block', width: '100%'}} />}
	 right={<img src="path/to/image.jpg" style={{display: 'block', width: '100%'}} />}
	 slider={<div style={{backgroundColor: 'white', width: '3px', height: '100%'}}>}
	 label="Compare Images"
/>

Compare

NameRequiredTypeDefaultDescription
leftyesReact.ComponentType | React.ReactElement-
rightyesReact.ComponentType | React.ReactElement-
slidernoReact.ComponentType | React.ReactElementundefined
labelyesstring-
behaviornoBehaviorBehavior.Move
defaultPositionnonumber50
animationnoAnimationTypeundefined
onDragStartnoOnDragStartCallbackTypeundefined
onDragEndnoOnDragEndCallbackTypeundefined
onPositionChangenoOnPositionChangeCallbackTypeundefined
tabIndexnonumber0
sliderModenoSliderModeSliderMode.Normal
clickDragModenoClickDragModeClickDragMode.Global
alwaysCovernobooleanfalse
keyboardStepnonumber5

For other types check the ~~website WIP~~ WIP

Create Component WIP

WIP

Create Slider WIP

WIP

Component Behaviors WIP

WIP

Web accessibility WIP

WIP

Native Animation WIP

WIP

Mobile WIP

WIP

Compare Component

This package is a part of compare-component which is also available for other libraries:

  • React
  • Vue WIP
  • Angular WIP
  • Polymer WIP
  • AngularJS WIP
  • jQuery WIP
  • VanillaJS (no libraries) WIP
  • Ember WIP
  • Mithril WIP

License

MIT

0.8.1

6 years ago

0.8.0

6 years ago

0.7.0

6 years ago

0.6.1

6 years ago

0.6.0

6 years ago

0.5.0

6 years ago

0.4.0

6 years ago

0.3.0

6 years ago

0.2.0

6 years ago

0.1.0

6 years ago

0.0.1

6 years ago

0.0.2

6 years ago