Interface VisualEditingOptions

interface VisualEditingOptions {
    components?: OverlayComponentResolver<
        OverlayComponent<Record<string, unknown>, any>,
    >;
    history?: HistoryAdapter;
    plugins?: OverlayPluginDefinition[];
    refresh?: (payload: HistoryRefresh) => false | Promise<void>;
    zIndex?: string | number;
}

Properties

components?: OverlayComponentResolver<
OverlayComponent<Record<string, unknown>, any>,
>

This API is unstable and could change at any time.

The history adapter is used for Sanity Presentation to navigate URLs in the preview frame.

This API is unstable and could change at any time.

refresh?: (payload: HistoryRefresh) => false | Promise<void>

The refresh API allows smarter refresh logic than the default location.reload() behavior.

zIndex?: string | number

The CSS z-index on the root node that renders overlays, tweak it accordingly to what layout you have.