Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 2.63 KB

README.md

File metadata and controls

109 lines (81 loc) · 2.63 KB

rc-swipeout


iOS-style swipeout buttons that appear from behind a component (web & react-native support)

NPM version build status Test coverage

Screenshots

rc-swipeout

Installation

npm install --save rc-swipeout

Development

web: 
npm install
npm start

rn:
tnpm run rn-start

Example

Usage

import Swipeout from 'rc-swipeout';

<Swipeout 
  left={[
    {
      text: 'reply',
      onPress:() => console.log('reply'),
      style: { backgroundColor: 'orange', color: 'white' }
    }
  ]} 
  right=[{
    {
      text: 'delete',
      onPress:() => console.log('delete'),
      style: { backgroundColor: 'red', color: 'white' }
    }
  }] 
  onOpen={() => console.log('open')}
  onClose={() => console.log('close')}
>
  <div style={{height: 44}}> swipeout demo </div>
</Swipeout>

API

props

name description type default
prefixCls className prefix String rc-swipeout
style swipeout style Object ``
left swipeout buttons on left Array null
right swipeout buttons on right Array null
autoClose auto close on button press Boolean function() {}
onOpen Function function() {}
onClose Function function() {}
disabled disabled swipeout Boolean false

button props

name description type default
text button text String Click
style button style Object ``
onPress button press function Function function() {}

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-swipeout is released under the MIT license.