CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/API
Class

PluginCollection (core)

@ckeditor/ckeditor5-core/src/plugincollection

class
See source

Manages a list of CKEditor plugins, including loading, resolving dependencies and initialization.

Filtering

Methods

  • constructor( editor, [ availablePlugins ] )

    Creates an instance of the PluginCollection class. Allows loading and initializing plugins and their dependencies.

    See source

    Parameters

    editor : Editor
    [ availablePlugins ] : Array.<Function>

    Plugins (constructors) which the collection will be able to use when load is used with plugin names (strings, instead of constructors). Usually, the editor will pass its built-in plugins to the collection so they can later be used in config.plugins or config.removePlugins by names.

  • Symbol.iterator() → Iterable.<Array>

    Iterable interface.

    See source

    Returns [ PluginConstructor, pluginInstance ] pairs.

    Returns

    Iterable.<Array>

  • destroy() → Promise

    Destroys all loaded plugins.

    See source

    Returns

    Promise

  • get( key ) → PluginInterface

    Gets the plugin instance by its constructor or name.

    See source

    Parameters

    key : function | String

    The plugin constructor or name.

    Returns

    PluginInterface

  • load( plugins, [ removePlugins ] ) → Promise

    Loads a set of plugins and adds them to the collection.

    See source

    Parameters

    plugins : Array.<(Function | String)>

    An array of plugin constructors or plugin names. The second option (names) works only if availablePlugins were passed to the constructor.

    [ removePlugins ] : Array.<(String | Function)>

    Names of plugins or plugin constructors that should not be loaded (despite being specified in the plugins array).

    Returns

    Promise

    A promise which gets resolved once all plugins are loaded and available in the collection.

    Promise.<PluginInterface>>

    returns.loadedPlugins The array of loaded plugins.

  • _add( PluginConstructor, plugin )

    protected

    Adds the plugin to the collection. Exposed mainly for testing purposes.

    See source

    Parameters

    PluginConstructor : function

    The plugin constructor.

    plugin : PluginInterface

    The instance of the plugin.