Current section
Files
Jump to
Current section
Files
dist/src/hooks/editor/typings.d.ts
/**
* List of supported CKEditor5 editor types.
*/
export declare const EDITOR_TYPES: readonly ["inline", "classic", "balloon", "decoupled", "multiroot"];
/**
* Represents a unique identifier for a CKEditor5 editor instance.
* This is typically the ID of the HTML element that the editor is attached to.
*/
export type EditorId = string;
/**
* Defines editor type supported by CKEditor5. It must match list of available
* editor types specified in `preset/parser.ex` file.
*/
export type EditorType = (typeof EDITOR_TYPES)[number];
/**
* Represents a CKEditor5 plugin as a string identifier.
*/
export type EditorPlugin = string;
/**
* Configuration object for CKEditor5 editor instance.
*/
export type EditorConfig = {
/**
* Array of plugin identifiers to be loaded by the editor.
*/
plugins: EditorPlugin[];
/**
* Other configuration options are flexible and can be any key-value pairs.
*/
[key: string]: any;
};
/**
* Represents a license key for CKEditor5.
*/
export type EditorLicense = {
key: string;
};
/**
* Configuration object for the CKEditor5 hook.
*/
export type EditorPreset = {
/**
* The type of CKEditor5 editor to use.
* Must be one of the predefined types: 'inline', 'classic', 'balloon', 'decoupled', or 'multiroot'.
*/
type: EditorType;
/**
* The configuration object for the CKEditor5 editor.
* This should match the configuration expected by CKEditor5.
*/
config: EditorConfig;
/**
* The license key for CKEditor5.
* This is required for using CKEditor5 with a valid license.
*/
license: EditorLicense;
/**
* Optional height for the editor, if applicable.
* This can be used to set a specific height for the editor instance.
*/
editableHeight?: number;
};
//# sourceMappingURL=typings.d.ts.map