CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

TokenList (engine/view)

@ckeditor/ckeditor5-engine/src/view/tokenlist

class
See source

Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).

Filtering

Properties

  • readonly

    isEmpty : boolean

    See source

    Returns true if token list has no tokens set.

  • readonly

    size : number

    See source

    Number of tokens.

  • private

    _set : Set<string>

    See source

    The set of tokens.

Methods

  • clear() → void

    See source

    Removes all tokens.

    Returns

    void

  • has( name ) → boolean

    See source

    Checks if a given token is set.

    Parameters

    name : string

    Returns

    boolean

  • isSimilar( other ) → boolean

    See source

    Returns true if both attributes have the same tokens.

    Parameters

    other : TokenList

    Returns

    boolean

  • keys() → Array<string>

    See source

    Returns all tokens.

    Returns

    Array<string>

  • remove( tokens ) → void

    See source

    Removes given token.

    Parameters

    tokens : ArrayOrItem<string>

    Returns

    void

  • set( tokens ) → void

    See source

    Sets a given token without affecting other tokens.

    Parameters

    tokens : ArrayOrItem<string>

    Returns

    void

  • setTo( value ) → TokenList

    See source

    Resets the value to the given one.

    Parameters

    value : string

    Returns

    TokenList

  • toString() → string

    See source

    Returns a normalized tokens string.

    Returns

    string

  • internal

    _canMergeFrom() → boolean

    See source

    Used by _canMergeAttributesFrom to verify if the given attribute can be merged without conflicts into the attribute.

    This method is indirectly used by the DowncastWriter while downcasting an AttributeElement to merge it with other AttributeElement.

    Returns

    boolean

  • internal

    _clone() → TokenList

    See source

    Clones the attribute value.

    Returns

    TokenList

  • internal

    _getConsumables( [ name ] ) → Array<string>

    See source

    Returns a list of consumables for the attribute.

    Could be filtered by the given token name.

    Parameters

    [ name ] : string

    Returns

    Array<string>

  • internal

    _getTokensMatch( tokenPattern ) → undefined | Array<string>

    See source

    Used by the Matcher to collect matching attribute tokens.

    Parameters

    tokenPattern : string | true | RegExp

    The matched token name pattern.

    Returns

    undefined | Array<string>

    An array of matching tokens.

  • internal

    _isMatching( other ) → boolean

    See source

    Used by _canSubtractAttributesOf to verify if the given attribute can be fully subtracted from the attribute.

    This method is indirectly used by the DowncastWriter while down-casting an AttributeElement to unwrap the AttributeElement.

    Parameters

    other : TokenList

    Returns

    boolean

  • internal

    _mergeFrom( other ) → void

    See source

    Used by _mergeAttributesFrom to merge a given attribute into the attribute.

    This method is indirectly used by the DowncastWriter while down-casting an AttributeElement to merge it with other AttributeElement.

    Parameters

    other : TokenList

    Returns

    void