@ckeditor/ckeditor5-vue
Version:
Official Vue.js 3+ component for CKEditor 5 – the best browser-based rich text editor.
134 lines (133 loc) • 14 kB
TypeScript
import type { CKEditorError, MultiRootEditor } from 'ckeditor5';
import type { ExtractEditorType } from '@ckeditor/ckeditor5-integrations-common';
import type { MultiRootEditorData, MultiRootEditorErrorDescription, MultiRootEditorRootsAttributes, MultiRootEditorWithWatchdogRelaxedConstructor } from './multiroot/types.js';
declare const _default: <TEditorConstructor extends MultiRootEditorWithWatchdogRelaxedConstructor>(__VLS_props: {
readonly onError?: ((error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => any) | undefined;
readonly onReady?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onDestroy?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onFocus?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onBlur?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onInput?: ((data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:modelValue"?: ((...args: unknown[]) => any) | undefined;
readonly onChange?: ((event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:rootsAttributes"?: ((...args: unknown[]) => any) | undefined;
editor: TEditorConstructor;
config?: import("ckeditor5").EditorConfig | undefined;
disabled?: boolean | undefined;
disableTwoWayDataBinding?: boolean | undefined;
watchdogConfig?: import("ckeditor5").WatchdogConfig | undefined;
disableWatchdog?: boolean | undefined;
modelValue?: MultiRootEditorData | undefined;
rootsAttributes?: MultiRootEditorRootsAttributes | undefined;
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
emit: ((evt: "ready", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "destroy", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "focus", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "error", error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => void) & ((evt: "blur", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "input", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "change", event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:rootsAttributes", rootsAttributes: MultiRootEditorRootsAttributes, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", value: MultiRootEditorData) => void) & ((evt: "update:rootsAttributes", value: MultiRootEditorRootsAttributes) => void);
attrs: any;
slots: {
default?: ((props: {
editor: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
attributes: MultiRootEditorRootsAttributes;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}) => any) | undefined;
};
} | undefined, __VLS_expose?: ((exposed: {
instance: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}) => void) | undefined, __VLS_setup?: Promise<{
props: {
readonly onError?: ((error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => any) | undefined;
readonly onReady?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onDestroy?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onFocus?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onBlur?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onInput?: ((data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:modelValue"?: ((...args: unknown[]) => any) | undefined;
readonly onChange?: ((event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:rootsAttributes"?: ((...args: unknown[]) => any) | undefined;
editor: TEditorConstructor;
config?: import("ckeditor5").EditorConfig | undefined;
disabled?: boolean | undefined;
disableTwoWayDataBinding?: boolean | undefined;
watchdogConfig?: import("ckeditor5").WatchdogConfig | undefined;
disableWatchdog?: boolean | undefined;
modelValue?: MultiRootEditorData | undefined;
rootsAttributes?: MultiRootEditorRootsAttributes | undefined;
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
expose(exposed: {
instance: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}): void;
attrs: any;
slots: {
default?: ((props: {
editor: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
attributes: MultiRootEditorRootsAttributes;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}) => any) | undefined;
};
emit: ((evt: "ready", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "destroy", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "focus", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "error", error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => void) & ((evt: "blur", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "input", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "change", event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:rootsAttributes", rootsAttributes: MultiRootEditorRootsAttributes, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", value: MultiRootEditorData) => void) & ((evt: "update:rootsAttributes", value: MultiRootEditorRootsAttributes) => void);
}>) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> & {
__ctx?: {
props: {
readonly onError?: ((error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => any) | undefined;
readonly onReady?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onDestroy?: ((editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onFocus?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onBlur?: ((event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly onInput?: ((data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:modelValue"?: ((...args: unknown[]) => any) | undefined;
readonly onChange?: ((event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => any) | undefined;
readonly "onUpdate:rootsAttributes"?: ((...args: unknown[]) => any) | undefined;
editor: TEditorConstructor;
config?: import("ckeditor5").EditorConfig | undefined;
disabled?: boolean | undefined;
disableTwoWayDataBinding?: boolean | undefined;
watchdogConfig?: import("ckeditor5").WatchdogConfig | undefined;
disableWatchdog?: boolean | undefined;
modelValue?: MultiRootEditorData | undefined;
rootsAttributes?: MultiRootEditorRootsAttributes | undefined;
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
expose(exposed: {
instance: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}): void;
attrs: any;
slots: {
default?: ((props: {
editor: import("./utils/wrapWithWatchdogIfPresent.js").EditorWithAttachedWatchdog<ExtractEditorType<TEditorConstructor> & MultiRootEditor> | undefined;
roots: string[];
data: MultiRootEditorData;
attributes: MultiRootEditorRootsAttributes;
rootsAttributes: MultiRootEditorRootsAttributes;
addRoot: (options: import("./multiroot/types.js").AddRootOptions) => Promise<void>;
removeRoot: (name: string) => Promise<void>;
}) => any) | undefined;
};
emit: ((evt: "ready", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "destroy", editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "focus", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "error", error: Error | CKEditorError, description: MultiRootEditorErrorDescription<ExtractEditorType<TEditorConstructor> & MultiRootEditor>) => void) & ((evt: "blur", event: import("ckeditor5").EventInfo<string, unknown>, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "input", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", data: MultiRootEditorData, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "change", event: unknown, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:rootsAttributes", rootsAttributes: MultiRootEditorRootsAttributes, event: import("ckeditor5").EventInfo<string, unknown> | null, editor: ExtractEditorType<TEditorConstructor> & MultiRootEditor) => void) & ((evt: "update:modelValue", value: MultiRootEditorData) => void) & ((evt: "update:rootsAttributes", value: MultiRootEditorRootsAttributes) => void);
} | undefined;
};
export default _default;
type __VLS_PrettifyLocal<T> = {
[K in keyof T]: T[K];
} & {};