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 ) → ModelPostFixer

    See source

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

    Parameters

    editor : Editor

    Returns

    ModelPostFixer

  • resurrectCollapsedMarkerPostFixer( editor ) → ModelPostFixer

    See source

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

    Parameters

    editor : Editor

    Returns

    ModelPostFixer

  • setupExceptionHighlighting( editor ) → void

    See source

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

    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

    Returns

    void

  • upcastHighlightToMarker( config = { config.model, config.view } ) → ( UpcastDispatcher ) => void

    See source

    A view highlight-to-marker conversion helper.

    Parameters

    config : object

    Conversion configuration.

    Properties
    config.model : () => string
    config.view : MatcherPattern

    Returns

    ( UpcastDispatcher ) => void