list/documentlist/utils/view

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

Functions

• createListElement( writer, indent, type ) → AttributeElementmodule:list/documentlist/utils/view~createListElement

  protected

  Creates a list attribute element (ol or ul).

  See source

  Parameters

  writer : DowncastWriter

  The downcast writer.

  indent : Number

  The list item indent.

  type : 'bulleted' | 'numbered'

  The list type.

  Returns

  AttributeElement

• createListItemElement( writer, indent, id ) → AttributeElementmodule:list/documentlist/utils/view~createListItemElement

  protected

  Creates a list item attribute element (li).

  See source

  Parameters

  writer : DowncastWriter

  The downcast writer.

  indent : Number

  The list item indent.

  id : String

  The list item ID.

  Returns

  AttributeElement

• getIndent( listItem ) → Numbermodule:list/documentlist/utils/view~getIndent

  protected

  Calculates the indent value for a list item. Handles HTML compliant and non-compliant lists.

  See source

  Also, fixes non HTML compliant lists indents:

  before:                                     fixed list:
  OL                                          OL
  |-> LI (parent LIs: 0)                      |-> LI     (indent: 0)
      |-> OL                                  |-> OL
          |-> OL                                  |
          |   |-> OL                              |
          |       |-> OL                          |
          |           |-> LI (parent LIs: 1)      |-> LI (indent: 1)
          |-> LI (parent LIs: 1)                  |-> LI (indent: 1)
  
  before:                                     fixed list:
  OL                                          OL
  |-> OL                                      |
      |-> OL                                  |
           |-> OL                             |
               |-> LI (parent LIs: 0)         |-> LI        (indent: 0)
  
  before:                                     fixed list:
  OL                                          OL
  |-> LI (parent LIs: 0)                      |-> LI         (indent: 0)
  |-> OL                                          |-> OL
      |-> LI (parent LIs: 0)                          |-> LI (indent: 1)

  Parameters

  listItem : Element

  Returns

  Number

• getViewElementIdForListType( type, indent ) → Stringmodule:list/documentlist/utils/view~getViewElementIdForListType

  protected

  Returns a view element ID for the given list type and indent.

  See source

  Parameters

  type : 'bulleted' | 'numbered'

  The list type.

  indent : Number

  The list indent level.

  Returns

  String

• getViewElementNameForListType( type ) → Stringmodule:list/documentlist/utils/view~getViewElementNameForListType

  protected

  Returns a view element name for the given list type.

  See source

  Parameters

  type : 'bulleted' | 'numbered'

  The list type.

  Returns

  String

• isListItemView( viewElement ) → Booleanmodule:list/documentlist/utils/view~isListItemView

  protected

  Checks if view element is a list item (li).

  See source

  Parameters

  viewElement : Element

  Returns

  Boolean

• isListView( viewElement ) → Booleanmodule:list/documentlist/utils/view~isListView

  protected

  Checks if view element is a list type (ul or ol).

  See source

  Parameters

  viewElement : Element

  Returns

  Boolean