Sanity Library Reference Docs
    Preparing search index...

    Interface PluginOptionsBeta

    interface PluginOptions {
        __internal_tasks?: { footerAction: ReactNode };
        advancedVersionControl?: {
            enabled?: boolean | ComposableOption<boolean, ConfigContext>;
        };
        document?: DocumentPluginOptions;
        form?: SanityFormConfig;
        mediaLibrary?: MediaLibraryConfig;
        name: string;
        onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void;
        plugins?: PluginOptions[];
        releases?: {
            actions?: ReleaseActionComponent[] | ReleaseActionsResolver;
            enabled?: boolean;
            limit?: number;
        };
        schema?: SchemaPluginOptions;
        search?: {
            enableLegacySearch?: boolean;
            strategy?: "groqLegacy"
            | "groq2024";
            unstable_partialIndexing?: { enabled: boolean };
        };
        studio?: {};
        tools?: Tool<any>[]
        | ComposableOption<Tool<any>[], ConfigContext>;
    }
    Index

    Properties

    __internal_tasks? advancedVersionControl? document? form? mediaLibrary? name onUncaughtError? plugins? releases? schema? search? studio? tools?

    Properties

    Optional Beta__internal_tasks

    __internal_tasks?: { footerAction: ReactNode }
    advancedVersionControl?: {
        enabled?: boolean | ComposableOption<boolean, ConfigContext>;
    }

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

    Type declaration

    • Optional Betaenabled?: boolean | ComposableOption<boolean, ConfigContext>

      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.

    document?: DocumentPluginOptions
    form?: SanityFormConfig
    mediaLibrary?: MediaLibraryConfig

    Config for the Sanity Media Library asset source integration.

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

    Configuration for error handling.

    plugins?: PluginOptions[]
    releases?: {
        actions?: ReleaseActionComponent[] | ReleaseActionsResolver;
        enabled?: boolean;
        limit?: number;
    }

    Configuration for Content Releases

    Type declaration

    • Optionalactions?: ReleaseActionComponent[] | ReleaseActionsResolver

      Actions for releases.

    • Optionalenabled?: boolean
    • Optionallimit?: number

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

    schema?: SchemaPluginOptions
    search?: {
        enableLegacySearch?: boolean;
        strategy?: "groqLegacy" | "groq2024";
        unstable_partialIndexing?: { enabled: boolean };
    }

    Type declaration

    • OptionalenableLegacySearch?: boolean

      Enables the legacy Query API search strategy.

      Use search.strategy instead.

    • Optionalstrategy?: "groqLegacy" | "groq2024"

      Control the strategy used for searching documents. This should generally only be used if you wish to try experimental search strategies.

      This option takes precedence over the deprecated search.enableLegacySearch option.

      Can be one of:

      • "groqLegacy" (default): Use client-side tokenization and schema introspection to search using the GROQ Query API.
      • "groq2024": (experimental) Perform full text searching using the GROQ Query API and its new text::matchQuery function.
    • Optionalunstable_partialIndexing?: { enabled: boolean }
    studio?: {}
    tools?: Tool<any>[] | ComposableOption<Tool<any>[], ConfigContext>

    Settings

    Member Visibility

    On This Page

    Properties