Skip to content

Commit

Permalink
Fix example and add more info to README (#3295)
Browse files Browse the repository at this point in the history
* Fix example and add more info to README

* revert fix
  • Loading branch information
daviscabral authored and aksonov committed Sep 27, 2018
1 parent a48e718 commit 1848731
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 40 deletions.
38 changes: 25 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,31 @@

## [Unreleased](https://github.com/aksonov/react-native-router-flux/tree/HEAD)

[Full Changelog](https://github.com/aksonov/react-native-router-flux/compare/4.0.2...HEAD)
[Full Changelog](https://github.com/aksonov/react-native-router-flux/compare/4.0.4...HEAD)

**Closed issues:**

- typeError: navigationStore.getStateForAction is not a function [\#3296](https://github.com/aksonov/react-native-router-flux/issues/3296)

## [4.0.4](https://github.com/aksonov/react-native-router-flux/tree/4.0.4) (2018-09-27)
[Full Changelog](https://github.com/aksonov/react-native-router-flux/compare/4.0.3...4.0.4)

**Fixed bugs:**

- Actions.replace: There is no route defined for Key X [\#3258](https://github.com/aksonov/react-native-router-flux/issues/3258)
- after update to Release 4.0.2 props not working... [\#3206](https://github.com/aksonov/react-native-router-flux/issues/3206)

**Closed issues:**

- Error on ios platform [\#3294](https://github.com/aksonov/react-native-router-flux/issues/3294)
- Modal and nested Stack routing configuration [\#3277](https://github.com/aksonov/react-native-router-flux/issues/3277)
- Unable to access component instance in onRight/onLeft [\#3274](https://github.com/aksonov/react-native-router-flux/issues/3274)
- jump to create new page is failed [\#3271](https://github.com/aksonov/react-native-router-flux/issues/3271)
- Drawer doesn't show correctly on Actions.drawerOpen\(\) [\#3262](https://github.com/aksonov/react-native-router-flux/issues/3262)
- Actions.pop\(refresh:{}\) does not work for me [\#3172](https://github.com/aksonov/react-native-router-flux/issues/3172)

## [4.0.3](https://github.com/aksonov/react-native-router-flux/tree/4.0.3) (2018-09-24)
[Full Changelog](https://github.com/aksonov/react-native-router-flux/compare/4.0.2...4.0.3)

**Closed issues:**

Expand Down Expand Up @@ -310,7 +334,6 @@
- \[Question\] Why are invisible scenes back in the stack still rendered in iOS? [\#2788](https://github.com/aksonov/react-native-router-flux/issues/2788)
- Intermediate Tab's componentDidMount get called when switching tabs [\#2786](https://github.com/aksonov/react-native-router-flux/issues/2786)
- Drawer showing white line or border to left of the screen on some android phones [\#2785](https://github.com/aksonov/react-native-router-flux/issues/2785)
- RNRF V4 w/ \[FBsdk, Mobx-Persist, Node, AsyncStorage\] [\#2782](https://github.com/aksonov/react-native-router-flux/issues/2782)

**Merged pull requests:**

Expand Down Expand Up @@ -513,12 +536,6 @@
- Actions.SCENE\(\) re rendering all visited Scene [\#2794](https://github.com/aksonov/react-native-router-flux/issues/2794)
- Help With Drawer Menu [\#2793](https://github.com/aksonov/react-native-router-flux/issues/2793)
- Unable to pass function as a prop down to scene [\#2790](https://github.com/aksonov/react-native-router-flux/issues/2790)
- Duplicate scenes when using stack within stack [\#2784](https://github.com/aksonov/react-native-router-flux/issues/2784)
- How to import CardStackStyleInterpolator from router flux. [\#2781](https://github.com/aksonov/react-native-router-flux/issues/2781)
- Can someone show we an example how i can change the Animation while navigating. [\#2780](https://github.com/aksonov/react-native-router-flux/issues/2780)
- undefined is not a function \(evaluating '\_reactNativeRouterFlux.Actions.guideHomePage\(\)'\) \_onPress [\#2779](https://github.com/aksonov/react-native-router-flux/issues/2779)
- Public API for navigation history [\#2778](https://github.com/aksonov/react-native-router-flux/issues/2778)
- onLeft and onRight not firing [\#2777](https://github.com/aksonov/react-native-router-flux/issues/2777)

**Merged pull requests:**

Expand All @@ -528,7 +545,6 @@
- Update API.md to include rightButtonStyle in scene props [\#2877](https://github.com/aksonov/react-native-router-flux/pull/2877) ([noahhayes](https://github.com/noahhayes))
- Compatibility with RN 0.52.1 for RNRF v3 [\#2853](https://github.com/aksonov/react-native-router-flux/pull/2853) ([DavidPineda](https://github.com/DavidPineda))
- Move drawerLockMode prop up to the scene API documentation. [\#2792](https://github.com/aksonov/react-native-router-flux/pull/2792) ([mdcone](https://github.com/mdcone))
- Fix Stack link in API docs [\#2776](https://github.com/aksonov/react-native-router-flux/pull/2776) ([todorone](https://github.com/todorone))

## [4.0.0-beta.27](https://github.com/aksonov/react-native-router-flux/tree/4.0.0-beta.27) (2018-01-05)
[Full Changelog](https://github.com/aksonov/react-native-router-flux/compare/4.0.0-beta.25...4.0.0-beta.27)
Expand Down Expand Up @@ -3132,8 +3148,4 @@
- Add string names to avoid obfuscation [\#5](https://github.com/aksonov/react-native-router-flux/pull/5) ([mull](https://github.com/mull))



\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*


\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
4 changes: 0 additions & 4 deletions HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2589,7 +2589,3 @@
**Merged pull requests:**

- Add string names to avoid obfuscation [\#5](https://github.com/aksonov/react-native-router-flux/pull/5) ([mull](https://github.com/mull))



\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[Follow author @PAksonov](https://twitter.com/PAksonov)

`react-native-router-flux` is a different API over `react-navigation`. It helps users to define all the routes in one central place and navigate and communicate between different screens in an easy way. But it also means that `react-native-router-flux` inherits all [limitations](https://reactnavigation.org/docs/en/limitations.html) and changes from updated versions.

### IMPORTANT NOTES

#### v4 is based on [React Navigation v2.x](https://reactnavigation.org/). See [this branch](https://github.com/aksonov/react-native-router-flux/tree/v3) and [docs](https://github.com/aksonov/react-native-router-flux/blob/master/README3.md) for v3 based on deprecated React Native Experimental Navigation API. It is not supported and may not work with latest React Native versions.
Expand All @@ -18,6 +20,8 @@ ___
* [Sponsors/Backers/Contributors](#contributors)


## Usage

Define all your routes in one React component...

```js
Expand Down
13 changes: 3 additions & 10 deletions examples/expo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"scripts": {
"start": "expo start",
"dev:start": "yarn dev && yarn start",
"android": "expo start --android",
"ios": "expo start --ios",
"dev:ios": "yarn dev && yarn ios",
Expand All @@ -18,23 +19,15 @@
"jest": {
"preset": "jest-expo"
},
"resolutions": {
"*/@babel/cli": "7.0.0",
"*/@babel/code-frame": "7.0.0",
"*/@babel/core": "7.1.0",
"*/@babel/generator": "7.0.0",
"*/@babel/helper-split-export-declaration": "7.0.0",
"*/@babel/template": "7.0.0"
},
"dependencies": {
"@expo/samples": "2.1.1",
"expo": "^30.0.1",
"react": "16.3.1",
"react-native": "https://github.com/expo/react-native/archive/sdk-30.0.0.tar.gz",
"react-native-button": "^2.3.0",
"react-native-button": "~2.3.0",
"react-native-router-flux": "file:../..",
"react-native-router-flux-cli": "file:../../packages/react-native-router-flux-cli",
"react-navigation": "^2.14.2",
"react-navigation": "~2.14.2",
"react-navigation-stack": "^0.4.0"
},
"devDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions examples/react-native/Example.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ const styles = StyleSheet.create({
},
});

const defaultReducer = new Reducer();
const reducerCreate = () => {
const reducerCreate = params => {
const defaultReducer = new Reducer(params);
return (state, action) => {
console.log('reducer: ACTION:', action);
return defaultReducer(state, action);
Expand Down
2 changes: 1 addition & 1 deletion examples/react-native/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"react-native-router-flux": "file:../..",
"react-native-router-flux-cli": "file:../../packages/react-native-router-flux-cli",
"react-native-screens": "^1.0.0-alpha.12",
"react-navigation": "2.16.x",
"react-navigation": "2.x",
"react-navigation-deprecated-tab-navigator": "^1.3.0",
"react-navigation-stack": "^0.6.0"
},
Expand Down
10 changes: 0 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,6 @@
"fix": "prettier-eslint src/**/*.js __tests__/**/*.js --write",
"test": "jest"
},
"resolutions": {
"*/@babel/cli": "7.0.0-beta.47",
"*/@babel/code-frame": "7.0.0-beta.47",
"*/@babel/core": "7.0.0-beta.47",
"*/@babel/generator": "7.0.0-beta.47",
"*/@babel/helper-split-export-declaration": "7.0.0-beta.47",
"*/@babel/template": "7.0.0-beta.47"
},
"dependencies": {
"lodash.isequal": "4.5.0",
"opencollective": "^1.0.3",
Expand Down Expand Up @@ -73,8 +65,6 @@
"jest": {
"preset": "react-native",
"modulePathIgnorePatterns": [
"<rootDir>/Example/",
"<rootDir>/ReduxExample/",
"<rootDir>/examples/"
],
"transformIgnorePatterns": [
Expand Down

0 comments on commit 1848731

Please sign in to comment.