Sanity Library Reference Docs
    Preparing search index...

    Interface BlockOptions

    Schema options for a Block schema definition

    interface BlockOptions {
        canvasApp?: CanvasAppOptions;
        oneLine?: boolean;
        sanityCreate?: SanityCreateOptions;
        spellCheck?: boolean;
        unstable_whitespaceOnPasteMode?: "normalize" | "preserve" | "remove";
    }

    Hierarchy (View Summary)

    Index

    Properties

    canvasApp? oneLine? sanityCreate? spellCheck? unstable_whitespaceOnPasteMode?

    Properties

    canvasApp?: CanvasAppOptions
    oneLine?: boolean

    When enabled, the editor will restrict all line breaks and soft breaks, forcing content to remain on a single line. This will also update the styling of the editor to reflect the single-line constraint.

    Pasting content that is on multiple lines will be normalized to a single line, if possible.

    false
    sanityCreate?: SanityCreateOptions
    spellCheck?: boolean

    Turn on or off the builtin browser spellchecking. Default is on.

    unstable_whitespaceOnPasteMode?: "normalize" | "preserve" | "remove"

    Settings

    Member Visibility

    On This Page

    Properties