Packages

ckeditor5_phoenix

1.25.1
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

HexDocs

Current section

Files

Jump to
Readme
54 Versions
8 Dependencies
Dependants
Files
Activity
ckeditor5_phoenix dist hooks editor utils create-editor-in-context.d.ts
Raw

dist/hooks/editor/utils/create-editor-in-context.d.ts 

import { Context, ContextWatchdog, Editor, EditorConfig } from 'ckeditor5';

/**

 * Creates a CKEditor 5 editor instance within a given context watchdog.

 *

 * @param params Parameters for editor creation.

 * @param params.element The DOM element or data for the editor.

 * @param params.context The context watchdog instance.

 * @param params.creator The editor creator utility.

 * @param params.config The editor configuration object.

 * @returns The created editor instance.

 */

export declare function createEditorInContext({ element, context, creator, config }: Attrs): Promise<{

    editor: Editor;

    state: "available" | "unavailable";

    editorContextId: string;

    context: ContextWatchdog<Context>;

}>;

/**

 * Retrieves the context watchdog from an editor instance, if available.

 *

 * @param editor The editor instance.

 * @returns The context watchdog or null if not found.

 */

export declare function unwrapEditorContext(editor: Editor): EditorContextDescriptor | null;

/**

 * Parameters for creating an editor in a context.

 */

type Attrs = {

    context: ContextWatchdog<Context>;

    creator: EditorCreator;

    element: HTMLElement;

    config: EditorConfig;

};

/**

 * Descriptor for an editor context.

 */

type EditorContextDescriptor = {

    state: 'available' | 'unavailable';

    editorContextId: string;

    context: ContextWatchdog<Context>;

};

/**

 * Type representing an Editor creator with a create method.

 */

type EditorCreator = {

    create: (...args: any) => Promise<Editor>;

};

export {};

//# sourceMappingURL=create-editor-in-context.d.ts.map