react-router-native

Functions

• createSearchParams()
• Link()
• NativeRouter()
• useAndroidBackButton()
• useDeepLinking()
• useHardwareBackButton()
• useLinkPressHandler()
• useSearchParams()

Interfaces

• LinkProps

  • children
  • onPress
  • relative
  • replace
  • state
  • to
• NativeRouterProps

Type Aliases

• ParamKeyValuePair
• SetURLSearchParams
• URLSearchParamsInit

function createSearchParams

createSearchParams: (init?: URLSearchParamsInit) => URLSearchParams;

• Creates a URLSearchParams object using the given initializer.

  This is identical to new URLSearchParams(init) except it also supports arrays as values in the object form of the initializer instead of just strings. This is convenient when you need multiple values for a given key, but don't want to use an array initializer.

  For example, instead of:

  let searchParams = new URLSearchParams([ ['sort', 'name'], ['sort', 'price'] ]);

  you can do:

  let searchParams = createSearchParams({ sort: ['name', 'price'] });

function Link

Link: ({
    onPress,
    relative,
    replace,
    state,
    to,
    ...rest
}: LinkProps) => React.JSX.Element;

• A <TouchableHighlight> that navigates to a different URL when touched.

function NativeRouter

NativeRouter: (props: NativeRouterProps) => React.JSX.Element;

• A <Router> that runs on React Native.

function useAndroidBackButton

useAndroidBackButton: () => void;

• Enables support for the hardware back button on Android.

function useDeepLinking

useDeepLinking: () => void;

• Enables deep linking, both on the initial app launch and for subsequent incoming links.

function useHardwareBackButton

useHardwareBackButton: () => void;

• Enables support for the hardware back button on Android.

function useLinkPressHandler

useLinkPressHandler: (
    to: To,
    {
        replace,
        state,
        relative,
    }?: { replace?: boolean; state?: any; relative?: RelativeRoutingType }
) => (event: GestureResponderEvent) => void;

• Handles the press behavior for router <Link> components. This is useful if you need to create custom <Link> components with the same press behavior we use in our exported <Link>.

function useSearchParams

useSearchParams: (
    defaultInit?: URLSearchParamsInit
) => [URLSearchParams, SetURLSearchParams];

• A convenient wrapper for accessing individual query parameters via the URLSearchParams interface.

type ParamKeyValuePair

type ParamKeyValuePair = [string, string];

type SetURLSearchParams

type SetURLSearchParams = (
    nextInit?:
        | URLSearchParamsInit
        | ((prev: URLSearchParams) => URLSearchParamsInit),
    navigateOpts?: NavigateOptions
) => void;

type URLSearchParamsInit

type URLSearchParamsInit =
    | string
    | ParamKeyValuePair[]
    | Record<string, string | string[]>
    | URLSearchParams;