Packages
ckeditor5_phoenix
1.28.2
1.28.2
1.28.1
1.28.0
1.27.2
1.27.1
1.27.0
1.26.0
1.25.1
1.25.0
1.24.2
1.24.1
1.24.0
1.23.0
1.22.0
1.21.0
1.20.0
1.19.0
1.18.0
1.17.2
1.17.1
1.17.0
1.16.1
1.16.0
1.15.8
1.15.7
1.15.6
1.15.5
1.15.4
1.15.3
1.15.2
1.15.1
1.15.0
1.14.2
1.14.1
1.14.0
1.13.0
1.12.0
1.11.0
1.10.2
1.10.1
1.10.0
1.9.0
1.8.0
1.7.0
1.6.0
1.5.0
1.4.1
1.4.0
1.3.0
1.2.1
1.2.0
1.1.0
1.0.8
1.0.7
CKEditor 5 integration for Phoenix Framework
Current section
Files
Jump to
Current section
Files
dist/hooks/editor/custom-editor-plugins.d.ts
import { PluginConstructor } from 'ckeditor5';
import { CanBePromise } from '../../types';
type PluginReader = () => CanBePromise<PluginConstructor>;
/**
* Registry for custom CKEditor plugins.
* Allows registration and retrieval of custom plugins that can be used alongside built-in plugins.
*/
export declare class CustomEditorPluginsRegistry {
static readonly the: CustomEditorPluginsRegistry;
/**
* Map of registered custom plugins.
*/
private readonly plugins;
/**
* Private constructor to enforce singleton pattern.
*/
private constructor();
/**
* Registers a custom plugin for the CKEditor.
*
* @param name The name of the plugin.
* @param reader The plugin reader function that returns the plugin constructor.
* @returns A function to unregister the plugin.
*/
register(name: string, reader: PluginReader): () => void;
/**
* Removes a custom plugin by its name.
*
* @param name The name of the plugin to unregister.
* @throws Will throw an error if the plugin is not registered.
*/
unregister(name: string): void;
/**
* Removes all custom editor plugins.
* This is useful for cleanup in tests or when reloading plugins.
*/
unregisterAll(): void;
/**
* Retrieves a custom plugin by its name.
*
* @param name The name of the plugin.
* @returns The plugin constructor or undefined if not found.
*/
get(name: string): Promise<PluginConstructor | undefined>;
/**
* Checks if a plugin with the given name is registered.
*
* @param name The name of the plugin.
* @returns `true` if the plugin is registered, `false` otherwise.
*/
has(name: string): boolean;
}
export {};
//# sourceMappingURL=custom-editor-plugins.d.ts.map