Packages

ckeditor5_phoenix

1.24.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 plugins sync-editor-with-phoenix.d.ts
Raw

dist/hooks/editor/plugins/sync-editor-with-phoenix.d.ts 

import { Editor, PluginConstructor } from 'ckeditor5';

import { EditorId } from '../typings';

/**

 * Creates a SyncEditorWithPhoenix plugin class. It's not two way binding, but

 * it allows you to push editor data to Phoenix on change, focus and blur events, and

 * also to set editor data from Phoenix.

 *

 * In order to debug two-way binding, check `EditorRootValueSentinel` component, which is used

 * to assign the value to the editor based on modification of the Elixir component's assigns.

 *

 * @param options The options for the plugin, including editorId, debounce time, events to listen to, and pushEvent/handleEvent functions.

 * @returns A Promise that resolves to the SyncEditorWithPhoenix plugin constructor.

 */

export declare function createSyncEditorWithPhoenixPlugin(options: Attrs): Promise<PluginConstructor>;

type Attrs = {

    editorId: EditorId;

    saveDebounceMs: number;

    events: {

        change: boolean;

        focus: boolean;

        blur: boolean;

        ready: boolean;

    };

    pushEvent: (event: string, payload: any) => void;

    handleEvent: (event: string, callback: (payload: any) => void) => void;

};

/**

 * Marks pending `change:data` as non-syncable with Phoenix.

 *

 * @param editor Editor instance.

 */

export declare function skipPendingPhoenixDataChangeSync(editor: Editor): () => void;

export {};

//# sourceMappingURL=sync-editor-with-phoenix.d.ts.map