Skip to content

luisfuertes/react-native-slide-button

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 

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

Prop Type Default Description
width number Width of button
height number Height of button
slideDirection string SlideDirection.RIGHT Determines which direction to slide. Either SlideDirection.LEFT, SlideDirection.RIGHT, SlideDirection.BOTH.
onSlideSuccess function Fired when slide succeeds
onSlide function Fired on every movement. Distance of movement is passed as argument.
successfulSlidePercent number Percent 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

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%