PluginStaticMembers
Static properties of a plugin.
Type parameters
-
TContext : Editor
Properties
-
isContextPlugin : boolean | undefinedreadonlymodule:core/plugin~PluginStaticMembers#isContextPluginA flag which defines if a plugin is allowed or not allowed to be used directly by a
Context. -
pluginName : string | undefinedreadonlymodule:core/plugin~PluginStaticMembers#pluginNameAn optional name of the plugin. If set, the plugin will be available in
getby its name and its constructor. If not, then only by its constructor.The name should reflect the constructor name.
To keep the plugin class definition tight, it is recommended to define this property as a static getter:
export class ImageCaption { static get pluginName() { return 'ImageCaption'; } }Copy codeNote: The native
Function.nameproperty could not be used to keep the plugin name because it will be mangled during code minification.Naming a plugin is necessary to enable removing it through the
config.removePluginsoption. -
requires : PluginDependencies<TContext> | undefinedreadonlymodule:core/plugin~PluginStaticMembers#requiresAn array of plugins required by this plugin.
To keep the plugin class definition tight it is recommended to define this property as a static getter:
import { Image } from './image.js'; export class ImageCaption { static get requires() { return [ Image ]; } }Copy code -
isOfficialPlugin : boolean | undefinedinternalreadonlymodule:core/plugin~PluginStaticMembers#isOfficialPluginA flag which defines if a plugin is an official CKEditor 5 plugin.
-
isPremiumPlugin : boolean | undefinedinternalreadonlymodule:core/plugin~PluginStaticMembers#isPremiumPluginA flag which defines if a plugin is a premium CKEditor 5 plugin.