@umbraco-cms/backoffice
    Preparing search index...

    Interface PlaceholderOptions

    interface PlaceholderOptions {
        dataAttribute: string;
        emptyEditorClass: string;
        emptyNodeClass:
            | string
            | (
                (
                    EmptyNodeClassProps: {
                        editor: Editor;
                        hasAnchor: boolean;
                        node: ProseMirrorNode;
                        pos: number;
                    },
                ) => string
            );
        includeChildren: boolean;
        placeholder: | string
        | (
            (
                PlaceholderProps: {
                    editor: Editor;
                    hasAnchor: boolean;
                    node: ProseMirrorNode;
                    pos: number;
                },
            ) => string
        );
        showOnlyCurrent: boolean;
        showOnlyWhenEditable: boolean;
    }
    Index
    dataAttribute emptyEditorClass emptyNodeClass includeChildren placeholder showOnlyCurrent showOnlyWhenEditable
    dataAttribute: string

    The data-attribute used for the placeholder label Will be prepended with data- and converted to kebab-case and cleaned of special characters.

    'placeholder'
    emptyEditorClass: string

    The class name for the empty editor

    'is-editor-empty'
    emptyNodeClass:
        | string
        | (
            (
                EmptyNodeClassProps: {
                    editor: Editor;
                    hasAnchor: boolean;
                    node: ProseMirrorNode;
                    pos: number;
                },
            ) => string
        )

    The class name for empty nodes

    You can use a function to return a dynamic class name or a string.

    'is-empty'
    includeChildren: boolean

    Controls if the placeholder should be shown for all descendants.

    If true, the placeholder will be shown for all descendants. If false, the placeholder will only be shown for the current node.

    false
    placeholder:
        | string
        | (
            (
                PlaceholderProps: {
                    editor: Editor;
                    hasAnchor: boolean;
                    node: ProseMirrorNode;
                    pos: number;
                },
            ) => string
        )

    The placeholder content

    You can use a function to return a dynamic placeholder or a string.

    'Write something …'
    showOnlyCurrent: boolean

    Checks if the placeholder should be only shown when the current node is empty.

    If true, the placeholder will only be shown when the current node is empty. If false, the placeholder will be shown when any node is empty.

    true
    showOnlyWhenEditable: boolean

    Checks if the placeholder should be only shown when the editor is editable.

    If true, the placeholder will only be shown when the editor is editable. If false, the placeholder will always be shown.

    true

    Settings
    Member Visibility

    On This Page
    Properties