Sanity Library Reference Docs
    Preparing search index...

    Type Alias NavigateToDashboardPath

    NavigateToDashboardPath: (
        options: {
            path: string;
            scope?: "in-app" | "dashboard";
            type?: "push" | "replace";
        },
    ) => void

    Reports an in-app navigation to the Dashboard so the browser URL and the Dashboard's own router follow the app. type defaults to 'push' and only applies in the federated runtime; see useNavigate.

    scope defaults to 'in-app', where path is relative to the app's route. With 'dashboard', path is a Dashboard URL from urlFor and is navigated to as-is; only the federated runtime supports it.

    Type declaration

      • (
            options: {
                path: string;
                scope?: "in-app" | "dashboard";
                type?: "push" | "replace";
            },
        ): void

      • Parameters

        • options: { path: string; scope?: "in-app" | "dashboard"; type?: "push" | "replace" }

        Returns void

    Settings

    Member Visibility