Function useRoute

Read the current route: the matched rule's name, its params, the app-owned sandboxPath, and the read-only platform prefix fields (mode, provider, namespace, repository, ref) — e.g. to tell /edit from /present.

useRoute(): {
    mode: string;
    name: undefined
    | string;
    namespace: string;
    params: RouteParams;
    provider: string;
    ref: string;
    repository: string;
    sandboxPath: string;
}
Returns {
    mode: string;
    name: undefined | string;
    namespace: string;
    params: RouteParams;
    provider: string;
    ref: string;
    repository: string;
    sandboxPath: string;
}
- Defined in src/routing.tsx:79

Function useRoute

Returns { mode: string; name: undefined | string; namespace: string; params: RouteParams; provider: string; ref: string; repository: string; sandboxPath: string;}

Settings

Returns {
mode: string;
name: undefined | string;
namespace: string;
params: RouteParams;
provider: string;
ref: string;
repository: string;
sandboxPath: string;
}