Files
react-native/Libraries/NavigationExperimental/Reducer/NavigationStackReducer.js
Eric Vicenti a3085464f6 NavigationExperimental
Summary:
A new API to unify internal navigation. Also addresses a highly-rated community 'pain': https://productpains.com/post/react-native/better-navigator-api-and-docs/

Offers the following improvements:

- Redux-style navigation logic is easy to reason about
- Navigation state can be easily saved and restored through refreshes
- Declarative navigation views can be implemented in native or JS
- Animations and gestures are isolated and now use the Animated library

public

Reviewed By: hedgerwang

Differential Revision: D2798048

fb-gh-sync-id: 88027ef9ead8a80afa38354252bc377455cc6dbb
2016-02-05 14:26:35 -08:00

142 lines
3.8 KiB
JavaScript

/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @providesModule NavigationStackReducer
* @flow
*/
'use strict';
var NavigationStateUtils = require('NavigationState');
import type {
NavigationState,
NavigationReducer,
} from 'NavigationState';
export type NavigationStackReducerAction = {
type: string,
};
const ActionTypes = {
PUSH: 'react-native/NavigationExperimental/stack-push',
POP: 'react-native/NavigationExperimental/stack-pop',
JUMP_TO: 'react-native/NavigationExperimental/stack-jumpTo',
JUMP_TO_INDEX: 'react-native/NavigationExperimental/stack-jumpToIndex',
RESET: 'react-native/NavigationExperimental/stack-reset',
};
const DEFAULT_KEY = 'NAV_STACK_DEFAULT_KEY';
function NavigationStackPushAction(state: NavigationState): NavigationStackReducerAction {
return {
type: ActionTypes.PUSH,
state,
};
}
function NavigationStackPopAction(): NavigationStackReducerAction {
return {
type: ActionTypes.POP,
};
}
function NavigationStackJumpToAction(key: string): NavigationStackReducerAction {
return {
type: ActionTypes.JUMP_TO,
key,
};
}
function NavigationStackJumpToIndexAction(index: number): NavigationStackReducerAction {
return {
type: ActionTypes.JUMP_TO_INDEX,
index,
};
}
function NavigationStackResetAction(children: Array<NavigationState>, index: number): NavigationStackReducerAction {
return {
type: ActionTypes.RESET,
index,
children,
};
}
type StackReducerConfig = {
initialStates: Array<NavigationState>;
initialIndex: ?number;
key: ?string;
matchAction: (action: any) => boolean;
actionStateMap: (action: any) => NavigationState;
};
function NavigationStackReducer({initialStates, initialIndex, key, matchAction, actionStateMap}: StackReducerConfig): NavigationReducer {
return function (lastState: ?NavigationState, action: any): NavigationState {
if (key == null) {
key = DEFAULT_KEY;
}
if (initialIndex == null) {
initialIndex = initialStates.length - 1;
}
if (!lastState) {
lastState = {
index: initialIndex,
children: initialStates,
key,
};
}
const lastParentState = NavigationStateUtils.getParent(lastState);
if (!action || !lastParentState) {
return lastState;
}
switch (action.type) {
case ActionTypes.PUSH:
return NavigationStateUtils.push(
lastParentState,
action.state
);
case ActionTypes.POP:
if (lastParentState.index === 0 || lastParentState.children.length === 1) {
return lastParentState;
}
return NavigationStateUtils.pop(lastParentState);
case ActionTypes.JUMP_TO:
return NavigationStateUtils.jumpTo(
lastParentState,
action.key
);
case ActionTypes.JUMP_TO_INDEX:
return NavigationStateUtils.jumpToIndex(
lastParentState,
action.index
);
case ActionTypes.RESET:
return {
...lastParentState,
index: action.index,
children: action.children,
};
}
if (matchAction(action)) {
return NavigationStateUtils.push(
lastParentState,
actionStateMap(action)
);
}
return lastParentState;
};
}
NavigationStackReducer.PushAction = NavigationStackPushAction;
NavigationStackReducer.PopAction = NavigationStackPopAction;
NavigationStackReducer.JumpToAction = NavigationStackJumpToAction;
NavigationStackReducer.JumpToIndexAction = NavigationStackJumpToIndexAction;
NavigationStackReducer.ResetAction = NavigationStackResetAction;
module.exports = NavigationStackReducer;