Sanity Library Reference Docs
    Preparing search index...

    Interface VisualEditingProps

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

    Hierarchy

    Index

    Properties

    components? history? plugins? refresh? zIndex?

    Properties

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

    This API is unstable and could change at any time.

    history?: undefined

    The history adapter is already implemented

    plugins?: OverlayPluginDefinition[]

    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.

    Settings

    Member Visibility

    On This Page

    Properties