Sign up (with export icon)

PluginStaticMembers

Api-interface icon interface

Static properties of a plugin.

Type parameters

Properties

  • Chevron-right icon

    isContextPlugin : boolean | undefined
    readonly

    A flag which defines if a plugin is allowed or not allowed to be used directly by a Context.

  • Chevron-right icon

    pluginName : string | undefined
    readonly

    An optional name of the plugin. If set, the plugin will be available in get by 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 code

    Note: The native Function.name property 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.removePlugins option.

  • Chevron-right icon

    requires : PluginDependencies<TContext> | undefined
    readonly

    An 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
  • Chevron-right icon

    isOfficialPlugin : boolean | undefined
    internalreadonly

    A flag which defines if a plugin is an official CKEditor 5 plugin.

  • Chevron-right icon

    isPremiumPlugin : boolean | undefined
    internalreadonly

    A flag which defines if a plugin is a premium CKEditor 5 plugin.