CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

list/list/utils

@ckeditor/ckeditor5-list/src/list/utils

module

Filtering

Functions

  • createUIComponent( editor, commandName, label, icon )

    private

    Helper method for creating a UI button and linking it with an appropriate command.

    See source

    Parameters

    editor : Editor

    The editor instance to which the UI component will be added.

    commandName : String

    The name of the command.

    label : String

    The button label.

    icon : String

    The source of the icon.

  • createViewListItemElement( writer ) → ContainerElement

    Creates a list item ContainerElement.

    See source

    Parameters

    writer : DowncastWriter

    The writer instance.

    Returns

    ContainerElement

  • findNestedList( viewElement ) → Element | null

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

    See source

    Parameters

    viewElement : Element

    Returns

    Element | null

  • generateLiInUl( modelItem, conversionApi ) → ContainerElement

    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>).

    See source

    Parameters

    modelItem : Item

    Model list item.

    conversionApi : UpcastConversionApi

    Conversion interface.

    Returns

    ContainerElement

    View list element.

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

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

    See source

    Parameters

    listStyleType : String

    Returns

    'bulleted' | 'numbered' | null

  • getSelectedListItems( model ) → Array.<Element>

    protected

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

    See source

    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.sameIndent], [options.smallerIndent], [options.listIndent], [options.direction] } ) → Item | null

    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.

    See source

    Parameters

    modelItem : Item
    options : Object

    Search criteria.

    Properties
    [ options.sameIndent ] : Boolean

    Whether the sought sibling should have the same indentation.

    Defaults to false

    [ options.smallerIndent ] : Boolean

    Whether the sought sibling should have a smaller indentation.

    Defaults to false

    [ options.listIndent ] : Number

    The reference indentation.

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

    Walking direction.

    Defaults to 'backward'

    Returns

    Item | null

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

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

    See source

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

    Parameters

    position : Position

    Starting position.

    direction : 'forward' | 'backward'

    Walking direction.

    Returns

    Array.<Element>

  • injectViewList( modelItem, injectedItem, conversionApi, model )

    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.

    See source

    Parameters

    modelItem : Item

    Model list item.

    injectedItem : ContainerElement
    conversionApi : UpcastConversionApi

    Conversion interface.

    model : Model

    The model instance.

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

    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).

    See source

    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

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

    See source

    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