Type alias NavigationProp<ParamList, RouteName, NavigatorID, State, ScreenOptions, EventMap>

Type declaration

• getParent:function

  • getParent<T>(id?): T

  • Returns the navigation prop from a parent navigator based on the ID. If an ID is provided, the navigation prop from the parent navigator with matching ID (including current) will be returned. If no ID is provided, the navigation prop from the immediate parent navigator will be returned.

    Type Parameters

    • T = undefined | NavigationProp<ParamListBase, string, undefined, Readonly<{
          history?: unknown[];
          index: number;
          key: string;
          routeNames: Extract<keyof ParamList, string>[];
          routes: NavigationRoute<ParamList, keyof ParamList>[];
          stale: false;
          type: string;
      }>, {}, {}>

    Parameters

    • Optional id: NavigatorID

      Optional ID of a parent navigator.

    Returns T

• setOptions:function

  • setOptions(options): void

  • Update the options for the route. The options object will be shallow merged with default options object.

    Parameters

    • options: Partial<ScreenOptions>

      Options object for the route.

    Returns void

• setParams:function

  • setParams(params): void

  • Update the param object for the route. The new params will be shallow merged with the old one.

    Parameters

    • params: ParamList[RouteName] extends undefined
          ? undefined
          : Partial<ParamList[RouteName]>

      Params object for the current route.

    Returns void