list/list/utils/view
module
Functions
-
createListElement( writer, indent, type, id ) → ViewAttributeElementinternalmodule:list/list/utils/view~createListElementCreates a list attribute element (ol or ul).
Parameters
writer : ViewDowncastWriterindent : numbertype : ListTypeid : string-
Defaults to
...
Returns
-
createListItemElement( writer, indent, id ) → ViewAttributeElementinternalmodule:list/list/utils/view~createListItemElementCreates a list item attribute element (li).
Parameters
writer : ViewDowncastWriterindent : numberid : string
Returns
-
getIndent( listItem ) → numberinternalmodule:list/list/utils/view~getIndentCalculates the indent value for a list item. Handles HTML compliant and non-compliant lists.
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)Copy codeParameters
listItem : ViewElement
Returns
number
-
getViewElementIdForListType( [ type ], [ indent ] ) → stringinternalmodule:list/list/utils/view~getViewElementIdForListTypeReturns a view element ID for the given list type and indent.
Parameters
[ type ] : ListType[ indent ] : number
Returns
string
-
getViewElementNameForListType( [ type ] ) → 'ol' | 'ul'internalmodule:list/list/utils/view~getViewElementNameForListTypeReturns a view element name for the given list type.
Parameters
[ type ] : ListType
Returns
'ol' | 'ul'
-
isListItemView( viewElement ) → booleaninternalmodule:list/list/utils/view~isListItemViewChecks if view element is a list item (li).
Parameters
viewElement : ViewNode | ViewDocumentFragment
Returns
boolean
-
isListView( viewElement ) → booleaninternalmodule:list/list/utils/view~isListViewChecks if view element is a list type (ul or ol).
Parameters
viewElement : ViewNode | ViewDocumentFragment
Returns
boolean