Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentActionsContextBeta

    interface DocumentActionsContext {
        currentUser: CurrentUser;
        dataset: string;
        documentId?: string;
        getClient: (options: SourceClientOptions) => SanityClient$1;
        i18n: LocaleSource;
        projectId: string;
        releaseId: string;
        schema: Schema;
        schemaType: string;
        singleton?: string;
        versionType: DocumentActionsVersionType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentUser dataset documentId? getClient i18n projectId releaseId schema schemaType singleton? versionType

    Properties

    currentUser: CurrentUser

    The current user or null if not authenticated.

    dataset: string

    The name of the dataset.

    documentId?: string
    getClient: (options: SourceClientOptions) => SanityClient$1

    A function that returns a Sanity client with the specified options.

    i18n: LocaleSource

    Localization resources

    projectId: string

    The ID of the project.

    releaseId: string

    releaseId of the open document, it's undefined if it's published or the draft

    schema: Schema

    The schema for this source.

    schemaType: string
    singleton?: string

    The singleton definition id, if the document is configured as a singleton.

    The context already includes documentId and schemaType properties, so the full SingletonDefinition is not provided.

    versionType: DocumentActionsVersionType

    the type of the currently active document.

    Settings

    Member Visibility

    On This Page

    Properties