Skip to content

[react-navigation] Loosen navigator navigationOptions #24943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RyanCavanaugh merged 2 commits into from
Apr 17, 2018
Merged

[react-navigation] Loosen navigator navigationOptions #24943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34afefb
Loosen navigator navigationOptions
doomsower Apr 12, 2018
3baef18
Fix linter
doomsower Apr 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions types/react-navigation/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,7 @@ export interface NavigationScreenDetails<T> {
navigation: NavigationScreenProp<NavigationRoute>;
}

export interface NavigationScreenOptions {
title?: string;
}
export type NavigationScreenOptions = NavigationStackScreenOptions & NavigationTabScreenOptions & NavigationDrawerScreenOptions;

export interface NavigationScreenConfigProps {
navigation: NavigationScreenProp<NavigationRoute>;
Expand Down Expand Up @@ -289,7 +287,8 @@ export interface NavigationStackViewConfig {
onTransitionEnd?: () => void;
}

export type NavigationStackScreenOptions = NavigationScreenOptions & {
export interface NavigationStackScreenOptions {
title?: string;
header?: (React.ReactElement<any> | ((headerProps: HeaderProps) => React.ReactElement<any>)) | null;
headerTransparent?: boolean;
headerTitle?: string | React.ReactElement<any>;
Expand All @@ -305,14 +304,14 @@ export type NavigationStackScreenOptions = NavigationScreenOptions & {
headerBackground?: React.ReactNode | React.ReactType;
gesturesEnabled?: boolean;
gestureResponseDistance?: { vertical?: number; horizontal?: number };
};
}

export interface NavigationStackRouterConfig {
headerTransitionPreset?: 'fade-in-place' | 'uikit';
initialRouteName?: string;
initialRouteParams?: NavigationParams;
paths?: NavigationPathsConfig;
navigationOptions?: NavigationScreenConfig<NavigationStackScreenOptions>;
navigationOptions?: NavigationScreenConfig<NavigationScreenOptions>;
}

export type NavigationStackAction =
Expand Down Expand Up @@ -352,7 +351,7 @@ export interface NavigationPathsConfig {
export interface NavigationTabRouterConfig {
initialRouteName?: string;
paths?: NavigationPathsConfig;
navigationOptions?: NavigationScreenConfig<NavigationTabScreenOptions>;
navigationOptions?: NavigationScreenConfig<NavigationScreenOptions>;
order?: string[]; // todo: type these as the real route names rather than 'string'

// Does the back button cause the router to switch to the initial tab
Expand All @@ -364,7 +363,8 @@ export interface TabScene {
index: number;
tintColor?: string;
}
export interface NavigationTabScreenOptions extends NavigationScreenOptions {
export interface NavigationTabScreenOptions {
title?: string;
tabBarIcon?:
React.ReactElement<any>
| ((options: { tintColor: (string | null), focused: boolean }) => (React.ReactElement<
Expand All @@ -384,7 +384,8 @@ export interface NavigationTabScreenOptions extends NavigationScreenOptions {
}) => void;
}

export interface NavigationDrawerScreenOptions extends NavigationScreenOptions {
export interface NavigationDrawerScreenOptions {
title?: string;
drawerIcon?:
React.ReactElement<any>
| ((options: { tintColor: (string | null), focused: boolean }) => (React.ReactElement<
Expand Down
5 changes: 4 additions & 1 deletion types/react-navigation/react-navigation-tests.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,10 @@ const tabNavigatorConfigWithNavigationOptions: TabNavigatorConfig = {
navigationOptions: {
tabBarOnPress: ({scene, jumpToIndex}) => {
jumpToIndex(scene.index);
}
},
headerStyle: {
backgroundColor: 'red',
},
},
};

Expand Down