CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

restricted-editing/restrictededitingmode/converters

@ckeditor/ckeditor5-restricted-editing/src/restrictededitingmode/converters

module

Filtering

Functions

  • extendMarkerOnTypingPostFixer( editor ) → function

    static

    A post-fixer that extends a marker when the user types on its boundaries.

    See source

    Parameters

    editor : Editor

    Returns

    function

  • resurrectCollapsedMarkerPostFixer( editor ) → function

    static

    A post-fixer that prevents removing a collapsed marker from the document.

    See source

    Parameters

    editor : Editor

    Returns

    function

  • setupExceptionHighlighting( editor )

    static

    Adds a visual highlight style to a restricted editing exception that the selection is anchored to.

    See source

    The highlight is turned on by adding the .restricted-editing-exception_selected class to the exception in the view:

    • The class is removed before the conversion starts, as callbacks added with the 'highest' priority to DowncastDispatcher events.
    • The class is added in the view post-fixer, after other changes in the model tree are converted to the view.

    This way, adding and removing the highlight does not interfere with conversion.

    Parameters

    editor : Editor

  • upcastHighlightToMarker( config = { [config.view], config.model, [config.converterPriority] } )

    static

    A view highlight-to-marker conversion helper.

    See source

    Parameters

    config : Object

    Conversion configuration.

    Properties
    [ config.view ] : MatcherPattern

    A pattern matching all view elements which should be converted. If not set, the converter will fire for every view element.

    config.model : String | Element | function

    The name of the model element, a model element instance or a function that takes a view element and returns a model element. The model element will be inserted in the model.

    [ config.converterPriority ] : PriorityString

    Converter priority.

    Defaults to 'normal'