CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

AutomaticDecorators (link)

@ckeditor/ckeditor5-link/src/utils

class
See source

Helper class that ties together all LinkDecoratorAutomaticDefinition and provides the downcast dispatchers for them.

Filtering

Properties

  • protected readonly

    length : Number

    See source

    Gives information about the number of decorators stored in the AutomaticDecorators instance.

  • private

    _definitions : Set

    See source

    Stores the definition of automatic decorators. This data is used as a source for a downcast dispatcher to create a proper conversion to output data.

Methods

  • add( item )

    See source

    Adds automatic decorator objects or an array with them to be used during downcasting.

    Parameters

    item : LinkDecoratorAutomaticDefinition | Array.<LinkDecoratorAutomaticDefinition>

    A configuration object of automatic rules for decorating links. It might also be an array of such objects.

  • getDispatcher() → function

    See source

    Provides the conversion helper used in the add method.

    Returns

    function

    A dispatcher function used as conversion helper in add.

  • getDispatcherForLinkedImage() → function

    See source

    Provides the conversion helper used in the add method when linking images.

    Returns

    function

    A dispatcher function used as conversion helper in add.