updated documentation

hasukmistry · Nov 21, 2017 · fa6864d · fa6864d
1 parent 8ea951d
commit fa6864d
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/CardStack.js b/CardStack.js
@@ -246,7 +246,7 @@ export default class CardStack extends Component {
     this._nextCard('top', 0, -height, duration);
   }
 
-  swipedBottom(){
+  swipeBottom(){
     this._nextCard('bottom', 0, height, duration);
   }
 

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ import CardStack, { Card } from 'react-native-card-stack-swiper';
 ```
 
 ```javascript
-  <CardStack style={styles.content} >
+  <CardStack style={styles.content} ref={swiper => { this.swiper = swiper }}>
     <Card style={[styles.card, styles.card1]}><Text style={styles.label}>A</Text></Card>
     <Card style={[styles.card, styles.card2]}><Text style={styles.label}>B</Text></Card>
     <Card style={[styles.card, styles.card1]}><Text style={styles.label}>C</Text></Card>
@@ -49,6 +49,30 @@ import CardStack, { Card } from 'react-native-card-stack-swiper';
 | onSwipedBottom    | func           | function to be called when a card is swiped bottom. it receives the swiped card index |
 
 
+## CardStack actions
+| Props             | type          |
+| ----------------- | ------------- |
+| swipeLeft         | func          |
+| swipeRight        | func          |
+| swipeBottom       | func          |
+| swipeTop          | func          |
+| goBackFromLeft    | func          |
+| goBackFromRight   | func          |
+| goBackFromBottom  | func          |
+| goBackFromTop     | func          |
+
+```javascript
+  <CardStack style={styles.content} ref={swiper => { this.swiper = swiper }}>
+    <Card style={[styles.card, styles.card1]}><Text style={styles.label}>A</Text></Card>
+    <Card style={[styles.card, styles.card2]}><Text style={styles.label}>B</Text></Card>
+  </CardStack>
+
+  <TouchableOpacity onPress={ () => { this.swiper.swipeLeft() }}>
+    <Text>Left</Text>
+  </TouchableOpacity>
+```
+
+
 # Card
 
 ## Card props

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-native-card-stack-swiper",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Tinder like react-native card stack swiper",
   "main": "index.js",
   "scripts": {