restricted-editing/restrictededitingmode/utils
@ckeditor/ckeditor5-restricted-editing/src/restrictededitingmode/utils
module
Filtering
Functions
-
getMarkerAtPosition( editor, position ) → Marker | undefined
module:restricted-editing/restrictededitingmode/utils~getMarkerAtPosition
Returns a single "restricted-editing-exception" marker at a given position. Contrary to
getMarkersAtPosition
, it returnd a marker also when the postion is equal to one of the marker's start or end positions.Parameters
Returns
Marker | undefined
-
isPositionInRangeBoundaries( range, position ) → boolean
module:restricted-editing/restrictededitingmode/utils~isPositionInRangeBoundaries
Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
Parameters
Returns
boolean
-
isSelectionInMarker( selection, [ marker ] ) → boolean
module:restricted-editing/restrictededitingmode/utils~isSelectionInMarker
Checks if the selection is fully contained in the marker. Positions on marker boundaries are considered "in".
<marker>[]foo</marker> -> true <marker>f[oo]</marker> -> true <marker>f[oo</marker> ba]r -> false <marker>foo</marker> []bar -> false
Parameters
selection : DocumentSelection
[ marker ] : Marker
Returns
boolean
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.