Skip to content

Commit 56e4ce1

Browse files
Harsh KumarHarsh Kumar
Harsh Kumar
authored and
Harsh Kumar
committed
Updated readme
1 parent bac8f12 commit 56e4ce1

File tree

1 file changed

+9
-45
lines changed

1 file changed

+9
-45
lines changed

README.md

+9-45
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,20 @@
11

2-
## react-native-scrollable-tab-view
3-
[![npm version](https://badge.fury.io/js/react-native-scrollable-tab-view.svg)](https://badge.fury.io/js/react-native-scrollable-tab-view)
2+
## react-native-top-tab-view
3+
[![npm version](https://badge.fury.io/js/react-native-top-tab-view.svg)](https://badge.fury.io/js/react-native-top-tab-view)
44

5-
This is probably my favorite navigation pattern on Android, I wish it
6-
were more common on iOS! This is a very simple JavaScript-only
7-
implementation of it for React Native. For more information about how
8-
the animations behind this work, check out the Rebound section of the
9-
[React Native Animation Guide](https://facebook.github.io/react-native/docs/animations.html)
5+
It's a react native top tab navigator for both Android and IOS with the scrollview in each tab and sliding between the tabs. For more information about how the animations behind this work, check out the Rebound section of the
6+
[React Native Animation Guide](https://reactnative.dev/docs/animations)
107

118

129
## Add it to your project
1310

14-
1. Run `npm install react-native-scrollable-tab-view --save`
15-
2. `var ScrollableTabView = require('react-native-scrollable-tab-view');`
16-
17-
## Demo
18-
<a href="https://appetize.io/embed/6qfv7eydjtm34mhn6qwj2nt3xm?embed=true&screenOnly=false&xdocMsg=true&debug=true&scale=100&deviceColor=black&orientation=portrait&device=iphone6s&osVersion=9.3&deviceId=RGV2aWNlOjU2Y2FjNTExZWQwOTM2MTEwMGRhYTNlNg&platform=ios&width=375&height=668&phoneWidth=416&phoneHeight=870&screenOffsetLeft=21&screenOffsetTop=100&params=%7B%7D" target="_blank"><strong>Run this example</strong></a>
19-
20-
<a href="https://raw.githubusercontent.com/brentvatne/react-native-scrollable-tab-view/master/demo_images/demo.gif"><img src="https://raw.githubusercontent.com/brentvatne/react-native-scrollable-tab-view/master/demo_images/demo.gif" width="350"></a>
21-
<a href="https://raw.githubusercontent.com/brentvatne/react-native-scrollable-tab-view/master/demo_images/demo-fb.gif"><img src="https://raw.githubusercontent.com/brentvatne/react-native-scrollable-tab-view/master/demo_images/demo-fb.gif" width="350"></a>
11+
1. Run `npm install react-native-top-tab-view --save`
12+
2. `var ScrollableTabView = require('react-native-top-tab-view');`
2213

2314
## Basic usage
2415

2516
```javascript
26-
var ScrollableTabView = require('react-native-scrollable-tab-view');
17+
var ScrollableTabView = require('react-native-top-tab-view');
2718

2819
var App = React.createClass({
2920
render() {
@@ -44,7 +35,7 @@ Suppose we had a custom tab bar called `CustomTabBar`, we would inject
4435
it into our `ScrollableTabView` like this:
4536

4637
```javascript
47-
var ScrollableTabView = require('react-native-scrollable-tab-view');
38+
var ScrollableTabView = require('react-native-top-tab-view');
4839
var CustomTabBar = require('./CustomTabBar');
4940

5041
var App = React.createClass({
@@ -59,18 +50,6 @@ var App = React.createClass({
5950
}
6051
});
6152
```
62-
To start you can just copy [DefaultTabBar](https://github.com/skv-headless/react-native-scrollable-tab-view/blob/master/DefaultTabBar.js).
63-
64-
## Examples
65-
66-
[SimpleExample](https://github.com/skv-headless/react-native-scrollable-tab-view/blob/master/Example/SimpleExample.js).
67-
68-
[ScrollableTabsExample](https://github.com/skv-headless/react-native-scrollable-tab-view/blob/master/Example/ScrollableTabsExample.js).
69-
70-
[OverlayExample](https://github.com/skv-headless/react-native-scrollable-tab-view/blob/master/Example/OverlayExample.js).
71-
72-
[FacebookExample](https://github.com/skv-headless/react-native-scrollable-tab-view/blob/master/Example/FacebookExample.js).
73-
7453
## Props
7554

7655
- **`renderTabBar`** _(Function:ReactComponent)_ - accept 1 argument `props` and should return a component to use as
@@ -94,19 +73,4 @@ To start you can just copy [DefaultTabBar](https://github.com/skv-headless/react
9473
- **`style`** _([View.propTypes.style](https://facebook.github.io/react-native/docs/view.html#style))_
9574
- **`contentProps`** _(Object)_ - props that are applied to root `ScrollView`/`ViewPagerAndroid`. Note that overriding defaults set by the library may break functionality; see the source for details.
9675
- **`scrollWithoutAnimation`** _(Bool)_ - on tab press change tab without animation.
97-
- **`prerenderingSiblingsNumber`** _(Integer)_ - pre-render nearby # sibling, `Infinity` === render all the siblings, default to 0 === render current page.
98-
99-
## Contribution
100-
**Issues** are welcome. Please add a screenshot of bug and code snippet. Quickest way to solve issue is to reproduce it on one of the examples.
101-
102-
**Pull requests** are welcome. If you want to change API or making something big better to create issue and discuss it first. Before submiting PR please run ```eslint .``` Also all eslint fixes are welcome.
103-
104-
Please attach video or gif to PR's and issues it is super helpful.
105-
106-
<a href="http://www.abeautifulsite.net/recording-a-screencast-with-quicktime/" target="_blank">How to make video</a>
107-
108-
<a href="https://github.com/jclem/gifify" target="_blank">How to make gif from video</a>
109-
110-
---
111-
112-
**MIT Licensed**
76+
- **`prerenderingSiblingsNumber`** _(Integer)_ - pre-render nearby # sibling, `Infinity` === render all the siblings, default to 0 === render current page.

0 commit comments

Comments
 (0)