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

    Interface PlaceholderOptions

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

    Properties

    emptyEditorClass emptyNodeClass includeChildren placeholder showOnlyCurrent showOnlyWhenEditable

    Properties

    emptyEditorClass: string

    The class name for the empty editor

    'is-editor-empty'
    emptyNodeClass: string

    The class name for empty nodes

    'is-empty'
    includeChildren: boolean

    Controls if the placeholder should be shown for all descendents.

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

    false
    placeholder:
        | string
        | (
            (
                PlaceholderProps: {
                    editor: Editor;
                    hasAnchor: boolean;
                    node: Node;
                    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