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
AutomaticDecoratorsinstance. -
private
_definitions : Set<NormalizedLinkDecoratorAutomaticDefinition>module:link/utils/automaticdecorators~AutomaticDecorators#_definitionsStores 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 ) → voidmodule:link/utils/automaticdecorators~AutomaticDecorators#addAdds 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 ) => voidmodule:link/utils/automaticdecorators~AutomaticDecorators#getDispatcherProvides the conversion helper used in the
addmethod.Returns
( DowncastDispatcher ) => voidA dispatcher function used as conversion helper in
add.
-
getDispatcherForLinkedImage() → ( DowncastDispatcher ) => voidmodule:link/utils/automaticdecorators~AutomaticDecorators#getDispatcherForLinkedImageProvides the conversion helper used in the
addmethod when linking images.Returns
( DowncastDispatcher ) => voidA 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.