UNPKG

vue-email-editor

Version:

The excellent drag-n-drop email editor by [Unlayer](https://unlayer.com/embed) as a [Vue](https://vuejs.org/) _wrapper component_. This is the most powerful and developer friendly visual email builder for your app.

170 lines (169 loc) 8.74 kB
import { EmailEditorProps } from './types'; declare const _default: import("vue").DefineComponent<{ editorId: () => EmailEditorProps["editorId"]; minHeight: { type: () => EmailEditorProps["minHeight"]; default: string; }; options: { type: () => EmailEditorProps["options"]; default: () => {}; }; scriptUrl: () => EmailEditorProps["scriptUrl"]; /** * @Deprecated Props: Use `options.appearance` instead */ appearance: () => EmailEditorProps["appearance"]; /** * @Deprecated Props: Use `options.locale` instead */ locale: () => EmailEditorProps["locale"]; /** * @Deprecated Props: Use `options.projectId` instead */ projectId: () => EmailEditorProps["projectId"]; /** * @Deprecated Props: Use `options.tools` instead */ tools: () => EmailEditorProps["tools"]; }, { editor: import("vue").Ref<{ frame: { id: number; ready: boolean; iframe: HTMLIFrameElement | undefined; messages: any[]; callbackId: number; callbacks: { [key: number]: Function | undefined; }; createIframe: (src: string) => HTMLIFrameElement; destroy: () => void; appendTo: (el: Element) => void; onWindowMessage: (event: MessageEvent<any>) => void; postMessage: (action: string, message: import("embed/Frame").Message) => void; withMessage: (action: string, message: import("embed/Frame").Message | undefined, callback?: Function) => void; _preprocessMessageFunctions: (message: import("embed/Frame").Message) => import("embed/Frame").Message; preprocessMessage: (message: import("embed/Frame").Message) => import("embed/Frame").Message; scheduleMessage: (message: import("embed/Frame").Message) => void; flushMessages: () => void; handleMessage: ({ action, callbackId, doneId, result: _result, resultArgs: _resultArgs, }: import("embed/Frame").MessageData) => void; receiveMessage: (event: any) => void; } | null; init: (config?: import("embed/Config").Config) => void; destroy: () => void; version: string | undefined; loadEditor: (config: import("embed/Config").Config) => void; renderEditor: (config: import("embed/Config").Config) => void; initEditor: (config: import("embed/Config").Config) => void; registerColumns: (cells: number[]) => void; registerCallback: (type: string, callback: Function) => void; unregisterCallback: (type: string) => void; registerProvider: (type: string, callback: Function) => void; unregisterProvider: (type: string) => void; reloadProvider: (type: string) => void; addEventListener: (type: string, callback: Function) => void; removeEventListener: (type: string) => void; setDesignId: (id: string | null) => void; setDesignMode: (designMode: string) => void; setDisplayMode: (displayMode: import("state/types/types").DisplayMode) => void; loadProject: (projectId: number) => void; loadUser: (user: import("state/types/types").User) => void; loadTemplate: (templateId: number) => void; loadStockTemplate: (stockTemplateId: string) => void; setLinkTypes: (linkTypes: import("state/types/types").LinkTypes) => void; setLinkTypesSharedConfig: (linkTypesSharedConfig: import("state/types/types").LinkTypesSharedConfig | null) => void; setMergeTags: (mergeTags: import("state/types/types").MergeTags) => void; setSpecialLinks: (specialLinks: import("state/types/types").SpecialLink[]) => void; setDisplayConditions: (displayConditions: import("state/types/types").DisplayConditions) => void; setLocale: (locale: import("engine/config/intl").Locale | null) => void; setTextDirection: (textDirection: import("engine/config/intl").TextDirection | null) => void; setTranslations: (translations: import("state/types/types").Translations) => void; loadBlank: (bodyValues?: object) => void; loadDesign: (design: import("state/types/types").JSONTemplate) => void; saveDesign: (callback: Function, options?: import("embed/Config").SaveDesignOptions) => void; exportHtml: (callback: (data: import("embed/Config").ExportHtmlResult) => void, options?: import("embed/Config").ExportHtmlOptions) => void; exportLiveHtml: (callback: (data: import("embed/Config").ExportLiveHtmlResult) => void, options?: import("embed/Config").ExportLiveHtmlOptions) => void; exportPlainText: (callback: (data: import("embed/Config").ExportPlainTextResult) => void, options?: import("embed/Config").ExportPlainTextOptions) => void; exportImage: (callback: (data: import("embed/Config").ExportFromApiResult) => void, options?: import("embed/Config").ExportImageFromApiOptions) => void; exportPdf: (callback: (data: import("embed/Config").ExportFromApiResult) => void, options?: import("embed/Config").ExportPdfFromApiOptions) => void; exportZip: (callback: (data: import("embed/Config").ExportFromApiResult) => void, options?: import("embed/Config").ExportZipFromApiOptions) => void; setAppearance: (appearance: import("editor/components/editors/types").DeepPartial<import("state/types/types").AppearanceConfig>) => void; setBodyValues: (bodyValues: Partial<import("engine/options/bodies").BodyValues>, bodyId?: number) => void; setStyleGuide: (styleGuide: object) => void; setDesignTagsConfig: (designTagsConfig: import("state/types/types").DesignTagsConfig) => void; setMergeTagsConfig: (mergeTagsConfig: import("state/types/types").MergeTagsConfig) => void; showPreview: (payload: { device?: import("state/types/types").Device; resolution?: number; }) => void; hidePreview: () => void; canUndo: (callback: (result: boolean) => void) => void; canRedo: (callback: (result: boolean) => void) => void; undo: () => void; redo: () => void; audit: (callback: (data: { status: "FAIL" | "PASS"; errors: import("state/types/types").Audit[]; }) => void) => void; setValidator: (validator: import("state/types/types").Validator | null) => void; setToolValidator: (tool: string, validator: import("state/types/types").Validator | null) => void; updateTabs: (tabs: import("state/types/types").Tabs) => void; clearValidators: () => void; registerContainerExporter: () => void; registerItemExporter: () => void; registerTool: () => void; registerPropertyEditor: () => void; registerTab: () => void; createPanel: () => void; createViewer: () => void; createWidget: () => void; } | null>; }, unknown, { id(): string | undefined; }, { loadEditor(): void; /** * @deprecated This method will be removed in the next major release. Use `editor.exportHtml` instead. */ exportHtml(callback: Parameters<EmailEditorProps["exportHtml"]>[0]): void; /** * @deprecated This method will be removed in the next major release. Use `editor.loadDesign` instead. */ loadDesign(design: Parameters<EmailEditorProps["loadDesign"]>[0]): void; /** * @deprecated This method will be removed in the next major release. Use `editor.saveDesign` instead. */ saveDesign(callback: Parameters<EmailEditorProps["saveDesign"]>[0]): void; }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ editorId: () => EmailEditorProps["editorId"]; minHeight: { type: () => EmailEditorProps["minHeight"]; default: string; }; options: { type: () => EmailEditorProps["options"]; default: () => {}; }; scriptUrl: () => EmailEditorProps["scriptUrl"]; /** * @Deprecated Props: Use `options.appearance` instead */ appearance: () => EmailEditorProps["appearance"]; /** * @Deprecated Props: Use `options.locale` instead */ locale: () => EmailEditorProps["locale"]; /** * @Deprecated Props: Use `options.projectId` instead */ projectId: () => EmailEditorProps["projectId"]; /** * @Deprecated Props: Use `options.tools` instead */ tools: () => EmailEditorProps["tools"]; }>>, { minHeight: string | number | undefined; options: import("embed/Config").Config | undefined; }, {}>; export default _default;