Sanity Library Reference Docs
    Preparing search index...

    Interface StateLinkProps

    Props for the StateLink component.

    interface StateLinkProps {
        replace?: boolean;
        state?: Record<string, unknown>;
        toIndex?: boolean;
    }
    Index

    Properties

    replace?: boolean

    Whether to replace the current history entry instead of adding a new one.

    state?: Record<string, unknown>

    The state to associate with the link.

    toIndex?: boolean

    Whether to navigate to the index page of the app.