Packages
ckeditor5_phoenix
1.3.0
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/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