CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

engine/view/placeholder

@ckeditor/ckeditor5-engine/src/view/placeholder

module

Filtering

Interfaces

Functions

  • disablePlaceholder( view, element ) → void

    See source

    Disables the placeholder functionality from a given element.

    See enablePlaceholder() to learn more.

    Parameters

    view : View
    element : Element

    Returns

    void

  • enablePlaceholder( options = { options.element, [options.isDirectHost], [options.keepOnFocus], [options.text], options.view } ) → void

    See source

    A helper that enables a placeholder on the provided view element (also updates its visibility). The placeholder is a CSS pseudo–element (with a text content) attached to the element.

    To change the placeholder text, change value of the placeholder property in the provided element.

    To disable the placeholder, use disablePlaceholder() helper.

    Parameters

    options : object

    Configuration options of the placeholder.

    Properties
    options.element : EditableElement | PlaceholderableElement

    Element that will gain a placeholder. See options.isDirectHost to learn more.

    [ options.isDirectHost ] : boolean

    If set false, the placeholder will not be enabled directly in the passed element but in one of its children (selected automatically, i.e. a first empty child element). Useful when attaching placeholders to elements that can host other elements (not just text), for instance, editable root elements.

    [ options.keepOnFocus ] : boolean

    If set true, the placeholder stay visible when the host element is focused.

    [ options.text ] : string

    Placeholder text. It's deprecated and will be removed soon. Use options.element.placeholder instead.

    options.view : View

    Editing view instance.

    Returns

    void

  • hidePlaceholder( writer, element ) → boolean

    See source

    Hides a placeholder in the element by changing related attributes and CSS classes.

    Note: This helper will not update the placeholder visibility nor manage the it in any way in the future. What it does is a one–time state change of an element. Use enablePlaceholder() and disablePlaceholder() for full placeholder functionality.

    Parameters

    writer : DowncastWriter
    element : Element

    Returns

    boolean

    true, if any changes were made to the element.

  • needsPlaceholder( element, keepOnFocus ) → boolean

    See source

    Checks if a placeholder should be displayed in the element.

    Note: This helper will blindly check the possibility of showing a placeholder directly in the root editable element if one is passed, which may not be the expected result. If an element can host other elements (not just text), most likely one of its children should be checked instead because it will be the final host for the placeholder. Use enablePlaceholder() in that case or make sure the correct element is passed to the helper.

    Parameters

    element : Element

    Element that holds the placeholder.

    keepOnFocus : boolean

    Focusing the element will keep the placeholder visible.

    Returns

    boolean

  • showPlaceholder( writer, element ) → boolean

    See source

    Shows a placeholder in the provided element by changing related attributes and CSS classes.

    Note: This helper will not update the placeholder visibility nor manage the it in any way in the future. What it does is a one–time state change of an element. Use enablePlaceholder() and disablePlaceholder() for full placeholder functionality.

    Note: This helper will blindly show the placeholder directly in the root editable element if one is passed, which could result in a visual clash if the editable element has some children (for instance, an empty paragraph). Use enablePlaceholder() in that case or make sure the correct element is passed to the helper.

    Parameters

    writer : DowncastWriter
    element : Element

    Returns

    boolean

    true, if any changes were made to the element.