engine/view/placeholder
Interfaces
-
module:engine/view/placeholder~PlaceholderableViewElement
Functions
-
disableViewPlaceholder( view, element ) → voidmodule:engine/view/placeholder~disableViewPlaceholderDisables the placeholder functionality from a given element.
See
enableViewPlaceholder()to learn more.Parameters
view : EditingViewelement : ViewElement
Returns
void
-
enableViewPlaceholder( options = { options.element, [options.isDirectHost], [options.keepOnFocus], [options.text], options.view } ) → voidmodule:engine/view/placeholder~enableViewPlaceholderA 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
placeholderproperty in the providedelement.To disable the placeholder, use
disableViewPlaceholder()helper.Parameters
options : objectConfiguration options of the placeholder.
Propertiesoptions.element : ViewEditableElement | PlaceholderableViewElementElement that will gain a placeholder. See
options.isDirectHostto learn more.[ options.isDirectHost ] : booleanIf set
false, the placeholder will not be enabled directly in the passedelementbut 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.Defaults to
true[ options.keepOnFocus ] : booleanIf set
true, the placeholder stay visible when the host element is focused.Defaults to
false[ options.text ] : stringPlaceholder text. It's deprecated and will be removed soon. Use
options.element.placeholderinstead.options.view : EditingViewEditing view instance.
Returns
void
-
hideViewPlaceholder( writer, element ) → booleanmodule:engine/view/placeholder~hideViewPlaceholderHides 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
enableViewPlaceholder()anddisableViewPlaceholder()for full placeholder functionality.Parameters
writer : ViewDowncastWriterelement : ViewElement
Returns
booleantrue, if any changes were made to theelement.
-
needsViewPlaceholder( element, keepOnFocus ) → booleanmodule:engine/view/placeholder~needsViewPlaceholderChecks 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
enableViewPlaceholder()in that case or make sure the correct element is passed to the helper.Parameters
element : ViewElementElement that holds the placeholder.
keepOnFocus : booleanFocusing the element will keep the placeholder visible.
Returns
boolean
-
showViewPlaceholder( writer, element ) → booleanmodule:engine/view/placeholder~showViewPlaceholderShows 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
enableViewPlaceholder()anddisableViewPlaceholder()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
enableViewPlaceholder()in that case or make sure the correct element is passed to the helper.Parameters
writer : ViewDowncastWriterelement : ViewElement
Returns
booleantrue, if any changes were made to theelement.