mirror of
https://github.com/zhigang1992/react-navigation.git
synced 2026-05-24 01:09:40 +08:00
reactjs/react-navigation -> react-community/react-navigation
This commit is contained in:
@@ -120,7 +120,7 @@ All `navigationOptions` for the `StackNavigator`:
|
||||
|
||||
### Examples
|
||||
|
||||
See the examples [SimpleStack.js](https://github.com/reactjs/react-navigation/tree/master/examples/NavigationPlayground/js/SimpleStack.js) and [ModalStack.js](https://github.com/reactjs/react-navigation/tree/master/examples/NavigationPlayground/js/ModalStack.js) which you can run locally as part of the [NavigationPlayground](https://github.com/reactjs/react-navigation/tree/master/examples/NavigationPlayground) app.
|
||||
See the examples [SimpleStack.js](https://github.com/react-community/react-navigation/tree/master/examples/NavigationPlayground/js/SimpleStack.js) and [ModalStack.js](https://github.com/react-community/react-navigation/tree/master/examples/NavigationPlayground/js/ModalStack.js) which you can run locally as part of the [NavigationPlayground](https://github.com/react-community/react-navigation/tree/master/examples/NavigationPlayground) app.
|
||||
|
||||
|
||||
### Navigator Props
|
||||
|
||||
@@ -68,11 +68,11 @@ _configureTransition(transitionProps, prevTransitionProps) {
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current navigation state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous navigation state and props
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current navigation state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous navigation state and props
|
||||
|
||||
#### Returns
|
||||
- An object of type [NavigationTransitionSpec](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L316) that will be fed into an Animated timing function as its config
|
||||
- An object of type [NavigationTransitionSpec](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L316) that will be fed into an Animated timing function as its config
|
||||
|
||||
|
||||
### `navigationState` object
|
||||
@@ -99,7 +99,7 @@ export type NavigationState = {
|
||||
};
|
||||
```
|
||||
|
||||
For more information about the `NavigationRoute` type, check out its [flow definition](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L32).
|
||||
For more information about the `NavigationRoute` type, check out its [flow definition](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L32).
|
||||
|
||||
### `render` function
|
||||
Invoked from `Transitioner.render()`. This function performs the actual rendering delegated from `Transitioner`. In this function, we can use the information included in the `transitionProps` and `prevTransitionProps` parameters to render scenes, create animations and handle gestures.
|
||||
@@ -110,7 +110,7 @@ There are a few important properties of the `transitionProps` and `prevTransitio
|
||||
- `position: NavigationAnimatedValue` - the progressive index of the transitioner's navigation state
|
||||
- `progress: NavigationAnimatedValue` - the value that represents the progress of the transition when navigation state changes from one to another. Its numberic value will range from 0 to 1.
|
||||
|
||||
For the complete list of properties of `NavigationTransitionProps`, check out its [flow definition](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273).
|
||||
For the complete list of properties of `NavigationTransitionProps`, check out its [flow definition](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273).
|
||||
|
||||
#### Examples
|
||||
|
||||
@@ -157,8 +157,8 @@ render: (transitionProps: NavigationTransitionProps, prevTransitionProps: ?Navig
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous state and props
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous state and props
|
||||
|
||||
#### Returns
|
||||
- A ReactElement, which will be used to render the Transitioner component
|
||||
@@ -171,8 +171,8 @@ Invoked when the transition animation is about to start.
|
||||
onTransitionStart: (transitionProps: NavigationTransitionProps, prevTransitionProps: ?NavigationTransitionProps) => void,
|
||||
```
|
||||
#### Parameters
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/reactjs/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous state and props
|
||||
- `transitionProps`: the current [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the current state and props
|
||||
- `prevTransitionProps`: the previous [NavigationTransitionProps](https://github.com/react-community/react-navigation/blob/master/src/TypeDefinition.js#L273) created from the previous state and props
|
||||
|
||||
#### Returns
|
||||
- none.
|
||||
|
||||
@@ -6,11 +6,11 @@ Navigation views are controlled React components that can present the current na
|
||||
|
||||
## Built in Views
|
||||
|
||||
- [CardStack](https://github.com/reactjs/react-navigation/blob/master/src/views/CardStack.js) - Present a stack that looks suitable on any platform
|
||||
+ [Card](https://github.com/reactjs/react-navigation/blob/master/src/views/Card.js) - Present one card from the card stack, with gestures
|
||||
+ [Header](https://github.com/reactjs/react-navigation/blob/master/src/views/Header.js) - The header view for the card stack
|
||||
- [Tabs](https://github.com/reactjs/react-navigation/blob/master/src/views/TabView) - A configurable tab switcher / pager
|
||||
- [Drawer](https://github.com/reactjs/react-navigation/tree/master/src/views/Drawer) - A view with a drawer that slides from the left
|
||||
- [CardStack](https://github.com/react-community/react-navigation/blob/master/src/views/CardStack.js) - Present a stack that looks suitable on any platform
|
||||
+ [Card](https://github.com/react-community/react-navigation/blob/master/src/views/Card.js) - Present one card from the card stack, with gestures
|
||||
+ [Header](https://github.com/react-community/react-navigation/blob/master/src/views/Header.js) - The header view for the card stack
|
||||
- [Tabs](https://github.com/react-community/react-navigation/blob/master/src/views/TabView) - A configurable tab switcher / pager
|
||||
- [Drawer](https://github.com/react-community/react-navigation/tree/master/src/views/Drawer) - A view with a drawer that slides from the left
|
||||
|
||||
## [Transitioner](/docs/views/transitioner)
|
||||
|
||||
|
||||
@@ -222,7 +222,7 @@ Based on the state URI we may decide to return an action. If an action is return
|
||||
|
||||
## Reference Implementations
|
||||
|
||||
A library to that helps easily produce navigation-aware components: https://github.com/reactjs/react-navigation . (Also uses a HOC to provide navigation containers when needed.)
|
||||
A library to that helps easily produce navigation-aware components: https://github.com/react-community/react-navigation . (Also uses a HOC to provide navigation containers when needed.)
|
||||
|
||||
A simple navigation container: https://gist.github.com/ericvicenti/77d190e2ec408012255937400e34bdb1
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ React navigation was initially developed on macOS 10.12, with node 7+, and react
|
||||
### 0. Basic Install
|
||||
|
||||
```
|
||||
git clone git@github.com:reactjs/react-navigation.git
|
||||
git clone git@github.com:react-community/react-navigation.git
|
||||
cd react-navigation
|
||||
npm install
|
||||
```
|
||||
@@ -57,7 +57,7 @@ Flow is not yet passing, but your code should be flow checked and we expect that
|
||||
|
||||
### 4. Developing Docs
|
||||
|
||||
The docs are indexed in [App.js](https://github.com/reactjs/react-navigation/blob/master/website/src/App.js), where all the pages are declared alongside the titles. To test the docs, follow the above instructions for running the website. Changing existing markdown files should not require any testing.
|
||||
The docs are indexed in [App.js](https://github.com/react-community/react-navigation/blob/master/website/src/App.js), where all the pages are declared alongside the titles. To test the docs, follow the above instructions for running the website. Changing existing markdown files should not require any testing.
|
||||
|
||||
The markdown from the `docs` folder gets generated and dumped into a json file as a part of the build step. To see updated docs appear in the website, re-run the build step by running `npm run build-docs` from the `react-navigation` root folder.
|
||||
|
||||
|
||||
@@ -4,11 +4,11 @@ React navigation routers work on web and allow you to share navigation logic wit
|
||||
|
||||
## Example App
|
||||
|
||||
[This website](https://github.com/reactjs/react-navigation/blob/master/website/) is built with react navigation, specifically using `createNavigator` and `TabRouter`.
|
||||
[This website](https://github.com/react-community/react-navigation/blob/master/website/) is built with react navigation, specifically using `createNavigator` and `TabRouter`.
|
||||
|
||||
See the source code of the site here: [App.js](https://github.com/reactjs/react-navigation/blob/master/website/src/App.js).
|
||||
See the source code of the site here: [App.js](https://github.com/react-community/react-navigation/blob/master/website/src/App.js).
|
||||
|
||||
To see how the app gets rendered on the server, see [Server.js](https://github.com/reactjs/react-navigation/blob/master/website/src/Server.js). On the browser, the App wakes up and gets rendered with [BrowserAppContainer.js](https://github.com/reactjs/react-navigation/blob/master/website/src/BrowserAppContainer.js).
|
||||
To see how the app gets rendered on the server, see [Server.js](https://github.com/react-community/react-navigation/blob/master/website/src/Server.js). On the browser, the App wakes up and gets rendered with [BrowserAppContainer.js](https://github.com/react-community/react-navigation/blob/master/website/src/BrowserAppContainer.js).
|
||||
|
||||
|
||||
## More Coming Soon
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
},
|
||||
"webpack": "lib/react-navigation.web.js",
|
||||
"repository": {
|
||||
"url": "git@github.com:reactjs/react-navigation.git",
|
||||
"url": "git@github.com:react-community/react-navigation.git",
|
||||
"type": "git"
|
||||
},
|
||||
"author": "Adam Miskiewicz <adam@sk3vy.com>",
|
||||
|
||||
@@ -22,7 +22,7 @@ const NavigationLinks = ({navigation, className, reverse}) => {
|
||||
);
|
||||
}),
|
||||
|
||||
<a href="https://github.com/reactjs/react-navigation" key="github">
|
||||
<a href="https://github.com/react-community/react-navigation" key="github">
|
||||
GitHub
|
||||
</a>,
|
||||
];
|
||||
|
||||
@@ -4,11 +4,11 @@ const Footer = () => (
|
||||
<div className="footer"><div className="inner-footer">
|
||||
|
||||
<section className="copyright">
|
||||
<a href="https://github.com/reactjs/react-navigation">
|
||||
<a href="https://github.com/react-community/react-navigation">
|
||||
React Navigation
|
||||
</a>
|
||||
·
|
||||
<a href="https://github.com/reactjs/react-navigation/blob/master/LICENSE">
|
||||
<a href="https://github.com/react-community/react-navigation/blob/master/LICENSE">
|
||||
Distributed under BSD License
|
||||
</a>
|
||||
</section>
|
||||
|
||||
@@ -105,7 +105,7 @@ class PageWithSidebar extends Component {
|
||||
<div className="main-section">
|
||||
<ActiveScreen navigation={this.props.navigation} />
|
||||
<hr />
|
||||
{state.routeName === 'Docs' && <Link href={`https://github.com/reactjs/react-navigation/tree/master/docs/${docPath}`} className="editLink"> Edit on GitHub</Link>}
|
||||
{state.routeName === 'Docs' && <Link href={`https://github.com/react-community/react-navigation/tree/master/docs/${docPath}`} className="editLink"> Edit on GitHub</Link>}
|
||||
{prevAction && <Link to={prevAction}>Previous: {prevName}</Link>}
|
||||
{nextAction && <Link to={nextAction} className="nextLink">Next: {nextName}</Link>}
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user