Type Alias CreateNativeHistoryOptions

Create-native-history options.

type CreateNativeHistoryOptions = {
    adapter?: NativeLinkAdapter;
    initialPath?: string;
    mapURLToPath?: (url: string) => string;
    onIncomingURL?: NativeIncomingURLMode;
}

Index

Properties

adapter? initialPath? mapURLToPath? onIncomingURL?

Properties

`Optional`adapter

adapter?: NativeLinkAdapter

Deep-link adapter implementation.

`Optional`initialPath

initialPath?: string

Initial fallback path when there is no incoming URL.

Default: "/".

`Optional`mapURLToPath

mapURLToPath?: (url: string) => string

Mapper for converting a URL into a path string.

Default: mapNativeURLToPath.

`Optional`onIncomingURL

onIncomingURL?: NativeIncomingURLMode

How to apply incoming URL events to history.

Default: "replace".