CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

list/legacylist/legacyutils

@ckeditor/ckeditor5-list/src/legacylist/legacyutils

module

Filtering

Functions

  • createViewListItemElement( writer ) → ContainerElement

    See source

    Creates a list item ContainerElement.

    Parameters

    writer : DowncastWriter

    The writer instance.

    Returns

    ContainerElement

  • findNestedList( viewElement ) → Element | null

    See source

    Returns a first list view element that is direct child of the given view element.

    Parameters

    viewElement : Element

    Returns

    Element | null

  • generateLiInUl( modelItem, conversionApi ) → ContainerElement

    See source

    Helper function that creates a <ul><li></li></ul> or (<ol>) structure out of the given modelItem model listItem element. Then, it binds the created view list item (<li>) with the model listItem element. The function then returns the created view list item (<li>).

    Parameters

    modelItem : Item

    Model list item.

    conversionApi : DowncastConversionApi

    Conversion interface.

    Returns

    ContainerElement

    View list element.

  • getListTypeFromListStyleType( listStyleType ) → 'bulleted' | 'numbered' | null

    See source

    Checks whether the given list-style-type is supported by numbered or bulleted list.

    Parameters

    listStyleType : string

    Returns

    'bulleted' | 'numbered' | null

  • internal

    getSelectedListItems( model ) → Array<Element>

    See source

    Returns an array with all listItem elements in the model selection.

    It returns all the items even if only a part of the list is selected, including items that belong to nested lists. If no list is selected, it returns an empty array. The order of the elements is not specified.

    Parameters

    model : Model

    Returns

    Array<Element>

  • getSiblingListItem( modelItem, options = { [options.direction], [options.listIndent], [options.sameIndent], [options.smallerIndent] } ) → Element | null

    See source

    Helper function that searches for a previous list item sibling of a given model item that meets the given criteria passed by the options object.

    Parameters

    modelItem : null | Item
    options : object

    Search criteria.

    Properties
    [ options.direction ] : 'forward' | 'backward'

    Walking direction.

    [ options.listIndent ] : number

    The reference indentation.

    [ options.sameIndent ] : boolean

    Whether the sought sibling should have the same indentation.

    [ options.smallerIndent ] : boolean

    Whether the sought sibling should have a smaller indentation.

    Returns

    Element | null

  • getSiblingNodes( position, direction ) → Array<Element>

    See source

    Returns an array with all listItem elements that represent the same list.

    It means that values of listIndent, listType, listStyle, listReversed and listStart for all items are equal.

    Additionally, if the position is inside a list item, that list item will be returned as well.

    Parameters

    position : Position

    Starting position.

    direction : 'forward' | 'backward'

    Walking direction.

    Returns

    Array<Element>

  • injectViewList( modelItem, injectedItem, conversionApi, model ) → void

    See source

    Helper function that inserts a view list at a correct place and merges it with its siblings. It takes a model list item element (modelItem) and a corresponding view list item element (injectedItem). The view list item should be in a view list element (<ul> or <ol>) and should be its only child. See comments below to better understand the algorithm.

    Parameters

    modelItem : Element

    Model list item.

    injectedItem : ContainerElement
    conversionApi : DowncastConversionApi

    Conversion interface.

    model : Model

    The model instance.

    Returns

    void

  • mergeViewLists( viewWriter, firstList, secondList ) → Position | null

    See source

    Helper function that takes two parameters that are expected to be view list elements, and merges them. The merge happens only if both parameters are list elements of the same type (the same element name and the same class attributes).

    Parameters

    viewWriter : DowncastWriter

    The writer instance.

    firstList : Item

    The first element to compare.

    secondList : Item

    The second element to compare.

    Returns

    Position | null

    The position after merge or null when there was no merge.

  • positionAfterUiElements( viewPosition ) → Position

    See source

    Helper function that for a given view.Position, returns a view.Position that is after all view.UIElements that are after the given position.

    For example: <container:p>foo^<ui:span></ui:span><ui:span></ui:span>bar</container:p> For position ^, the position before "bar" will be returned.

    Parameters

    viewPosition : Position

    Returns

    Position