Interface

ItemMarkerDowncastStrategy (list/list)

@ckeditor/ckeditor5-list/src/list/listediting

interface

The custom marker downcast strategy.

Filtering

Properties

  • attributeName : string

    The model attribute name.

  • scope : 'itemMarker'

    The scope of the downcast.

Methods

  • canInjectMarkerIntoElement( modelElement ) → boolean

    Should return true if the custom marker can be injected into a given list block. Otherwise, custom marker view element is always injected before the block element.

    Parameters

    modelElement : Element

    Returns

    boolean
  • canWrapElement( modelElement ) → boolean

    Should return true if the given list block can be wrapped with the wrapper created by createWrapperElement() or only the marker element should be wrapped.

    Parameters

    modelElement : Element

    Returns

    boolean
  • createElement( writer, modelElement, __namedParameters = { [__namedParameters.dataPipeline] } ) → null | Element

    Creates a view element for a custom item marker.

    Parameters

    writer : DowncastWriter
    modelElement : Element
    __namedParameters : object
    Properties
    [ __namedParameters.dataPipeline ] : boolean

    Returns

    null | Element
  • createWrapperElement( writer, modelElement, __namedParameters = { [__namedParameters.dataPipeline] } ) → AttributeElement

    Creates an AttributeElement to be used for wrapping a first block of a list item.

    Parameters

    writer : DowncastWriter
    modelElement : Element
    __namedParameters : object
    Properties
    [ __namedParameters.dataPipeline ] : boolean

    Returns

    AttributeElement