react-navigation-stack/README.md

38 lines
910 B
Markdown
Raw Permalink Normal View History

2018-08-03 21:59:12 +00:00
# React Navigation Stack
[![CircleCI badge](https://circleci.com/gh/react-navigation/react-navigation-stack/tree/master.svg?style=shield)](https://circleci.com/gh/react-navigation/react-navigation-stack/tree/master)
Stack navigator for use on iOS and Android.
## Installation
Open a Terminal in your project's folder and run,
```sh
yarn add react-navigation-stack
```
## Usage
```js
import { createStackNavigator } from 'react-navigation-stack';
export default createStackNavigator({
Inbox: InboxScreen
Drafts: DraftsScreen,
}, {
initialRouteName: 'Inbox',
});
```
2019-02-05 02:06:03 +00:00
## Development workflow
- Clone this repository
- Run `yarn` in the root directory and in the `example` directory
- Run `yarn dev` in the root directory
- Run `yarn start` in the `example` directory
2018-08-03 21:59:12 +00:00
## Docs
Documentation can be found on the [React Navigation website](https://reactnavigation.org/docs/en/stack-navigator.html).