Sanity Library Reference Docs
    Preparing search index...

    Interface Workspace

    Definition for Workspace

    interface Workspace {
        advancedVersionControl: { enabled: boolean };
        authenticated: boolean;
        basePath: string;
        currentUser: CurrentUser;
        dataset: string;
        getClient: (clientOptions: SourceClientOptions) => SanityClient;
        icon: ReactNode;
        mediaLibrary?: MediaLibraryConfig;
        name: string;
        onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void;
        projectId: string;
        releases?: {
            actions?: (
                props: PartialContext<ReleaseActionsContext>,
            ) => ReleaseActionComponent[];
            enabled?: boolean;
            limit?: number;
        };
        schema: Schema;
        search: {
            enableLegacySearch?: boolean;
            filters: SearchFilterDefinition[];
            operators: SearchOperatorDefinition<any>[];
            strategy?: "groqLegacy" | "groq2024";
            unstable_partialIndexing?: { enabled: boolean };
        };
        subtitle?: string;
        tasks?: { enabled: boolean };
        templates: Template<any, any>[];
        title: string;
        tools: Tool<any>[];
    }

    Hierarchy

    Index

    Properties

    advancedVersionControl authenticated basePath currentUser dataset getClient icon mediaLibrary? name onUncaughtError? projectId releases? schema search subtitle? tasks? templates title tools

    Properties

    advancedVersionControl: { enabled: boolean }

    Advanced version control provides features such as inline content diffs in Studio to make resolving conflicts across document versions easier.

    Type declaration

    • Betaenabled: boolean

      Control whether advanced version control functionality is enabled.

      Advanced version control provides features such as inline content diffs in Studio to make resolving conflicts across document versions easier.

    authenticated: boolean

    Whether the user is authenticated.

    basePath: string

    URL base path to use, for instance /myWorkspace Note that this will be prepended with any studio base path, eg /studio/myWorkspace, and is a client-side routing feature. If you're looking to serve your studio from a subpath, you're probably looking for the basePath property in sanity.cli.ts/sanity.cli.js.

    currentUser: CurrentUser

    The current user of the source.

    dataset: string

    The name of the dataset.

    getClient: (clientOptions: SourceClientOptions) => SanityClient

    Returns a client instance.

    Type declaration

    icon: ReactNode

    React component to use as icon for this workspace

    mediaLibrary?: MediaLibraryConfig

    Config for the Sanity Media Library asset source integration.

    name: string

    The name of the source.

    onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void

    Configuration for error handling.

    projectId: string

    The ID of the project.

    releases?: {
        actions?: (
            props: PartialContext<ReleaseActionsContext>,
        ) => ReleaseActionComponent[];
        enabled?: boolean;
        limit?: number;
    }

    Type declaration

    • Optionalactions?: (props: PartialContext<ReleaseActionsContext>) => ReleaseActionComponent[]

      Returns an array of actions for the release.

    • Optionalenabled?: boolean
    • Optionallimit?: number

      Limit the number of releases that can be created by this workspace.

    schema: Schema

    The schema of the source.

    search: {
        enableLegacySearch?: boolean;
        filters: SearchFilterDefinition[];
        operators: SearchOperatorDefinition<any>[];
        strategy?: "groqLegacy" | "groq2024";
        unstable_partialIndexing?: { enabled: boolean };
    }
    subtitle?: string

    Subtitle to show under the name of the workspace

    tasks?: { enabled: boolean }
    templates: Template<any, any>[]

    The templates of the source.

    title: string

    The title of the source.

    tools: Tool<any>[]

    The tools of the source.

    Settings

    Member Visibility

    On This Page

    Properties