Skip to content

Latest commit

History

36 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

react-native-slide-button

Customizable slide button component for React Native.

Installation

npm i --save react-native-slide-button

Usage

import { SlideButton, SlideDirection } from 'react-native-slide-button';
<View style={{backgroundColor: 'blue'}}> <!-- Outer wrapper -->
<SlideButton
onSlideSuccess={this.onSlide.bind(this)}
slideDirection={SlideDirection.LEFT}
width={500}
height={50}>
<View style={height: 50, width: 500}> <!-- Inner wrapper -->
<Text style={styles.button}>Slide Button</Text>
</View>
</SlideButton>
</View>
  • Inner wrapper: Contents that will move when swiped. Eg: Button text, image etc.
  • Outer wrapper: Contents that are static and will not move. Eg: Button's background, other styles

API

SlideButton

PropTypeDefaultDescription
widthnumberWidth of button
heightnumberHeight of button
slideDirectionstringSlideDirection.RIGHTDetermines which direction to slide. Either SlideDirection.LEFT, SlideDirection.RIGHT, SlideDirection.BOTH.
onSlideSuccessfunctionFired when slide succeeds
onSlidefunctionFired on every movement. Distance of movement is passed as argument.
successfulSlidePercentnumberPercent of total button width needed to slide before movement is seen as a successful slide. Default is 40.

TODO

  • Implement onSlide prop to let components listen to slide events.
  • Write testcases.
  • Write separate convenience component tailored to meet the most common usecase; button with text inside.

About

Slide to proceed button for React Native

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages