AutomaticDecorators (link/utils)
@ckeditor/ckeditor5-link/src/utils/automaticdecorators
Helper class that ties together all LinkDecoratorAutomaticDefinition
and provides
the downcast dispatchers for them.
Filtering
Properties
-
Gives information about the number of decorators stored in the
AutomaticDecorators
instance. -
private
_definitions : Set<NormalizedLinkDecoratorAutomaticDefinition>
module:link/utils/automaticdecorators~AutomaticDecorators#_definitions
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 ) → void
module:link/utils/automaticdecorators~AutomaticDecorators#add
Adds automatic decorator objects or an array with them to be used during downcasting.
Parameters
item : ArrayOrItem<NormalizedLinkDecoratorAutomaticDefinition>
A configuration object of automatic rules for decorating links. It might also be an array of such objects.
Returns
void
-
getDispatcher() → ( DowncastDispatcher ) => void
module:link/utils/automaticdecorators~AutomaticDecorators#getDispatcher
Provides the conversion helper used in the
add
method.Returns
( DowncastDispatcher ) => void
A dispatcher function used as conversion helper in
add
.
-
getDispatcherForLinkedImage() → ( DowncastDispatcher ) => void
module:link/utils/automaticdecorators~AutomaticDecorators#getDispatcherForLinkedImage
Provides the conversion helper used in the
add
method when linking images.Returns
( DowncastDispatcher ) => void
A dispatcher function used as conversion helper in
add
.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.