@ckeditor/ckeditor5-angular/ckeditor.d.ts

Official Angular 2+ component for CKEditor 5 – the best browser-based rich text editor.

/**
 * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md.
 */
/**
 * Basic typings for the CKEditor5 elements.
 */
export declare namespace CKEditor5 {
    /**
     * The CKEditor5 editor constructor.
     */
    interface EditorConstructor {
        create(sourceElementOrData: HTMLElement | string, config?: Config): Promise<Editor>;
    }
    /**
     * The CKEditor5 editor config.
     */
    interface Config {
        [key: string]: any;
    }
    /**
     * The event object passed to CKEditor5 event callbacks.
     *
     * See https://ckeditor.com/docs/ckeditor5/latest/api/module_utils_eventinfo-EventInfo.html
     */
    interface EventInfo<EventName extends string> {
        readonly name: EventName;
        readonly path: any[];
        readonly source: any;
        return?: any;
        off(): void;
        stop(): void;
    }
    /**
     * The base Editor class.
     *
     * See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html
     */
    interface BaseEditor {
        readonly commands: any;
        readonly config: any;
        readonly conversion: any;
        readonly data: any;
        readonly editing: any;
        readonly keystrokes: any;
        readonly locale: any;
        readonly model: any;
        readonly plugins: any;
        readonly state: 'initializing' | 'ready' | 'destroyed';
        isReadOnly: boolean;
        delegate(events: string[]): any;
        destroy(): Promise<void>;
        execute(commandName: string, ...params: any[]): any;
        fire(eventName: string, args?: any): any;
        listenTo(emitter: any, eventName: string, callback: Function, options?: any): void;
        off(eventName: string, callback: Function): void;
        on(eventName: string, callback: Function, options?: any): void;
        once(eventName: string, callback: Function, options?: any): void;
        stopListening(emitter: any, eventName: string, callback: Function): void;
        t(...args: any[]): void;
        [property: string]: any;
    }
    /**
     * The CKEditor5 DataApi interface.
     *
     * See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_utils_dataapimixin-DataApi.html.
     */
    interface DataApi {
        getData(): string;
        setData(data: string): void;
    }
    /**
     * A CKEditor5 editor that implements the
     * [DataApi interface](https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_utils_dataapimixin-DataApi.html).
     * E.g. the `ClassicEditor`, `InlineEditor`, etc.
     */
    interface Editor extends BaseEditor, DataApi {
    }
}