@progress/kendo-vue-editor 3.5.0 → 3.5.1-dev.202208100944

package/dist/esm/Editor.d.ts

@@ -0,0 +1,283 @@
+import { DefineComponent, RecordPropsDefinition, ComponentOptions, Vue2type } from './additionalTypes';
+declare type DefaultData<V> = object | ((this: V) => {});
+declare type DefaultMethods<V> = {
+    [key: string]: (this: V, ...args: any[]) => any;
+};
+import { Transaction, EditorView } from '@progress/kendo-editor-common';
+import { EditorToolsSettings } from './config/toolsSettings';
+import { EditorProps } from './EditorProps';
+/** @hidden */
+export declare const allTools: {
+    Bold: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    Italic: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    Underline: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    Strikethrough: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    Subscript: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    Superscript: {
+        comp: DefineComponent<import("./tools/inlineFormat").InlineFormatToolProps, any, import("./tools/inlineFormat").InlineFormatData, import("./tools/inlineFormat").InlineFormatComputed, import("./tools/inlineFormat").InlineFormatMethods, {}, {}, {}, string, import("./tools/inlineFormat").InlineFormatToolProps, import("./tools/inlineFormat").InlineFormatToolProps, {}>;
+        props: EditorToolsSettings.InlineFormatSettings;
+    };
+    AlignLeft: {
+        comp: DefineComponent<import("./main").EditorTools.AlignToolProps, any, import("./tools/align").AlignData, import("./tools/align").AlignComputed, import("./tools/align").AlignMethods, {}, {}, {}, string, import("./main").EditorTools.AlignToolProps, import("./main").EditorTools.AlignToolProps, {}>;
+        props: EditorToolsSettings.AlignSettings;
+    };
+    AlignCenter: {
+        comp: DefineComponent<import("./main").EditorTools.AlignToolProps, any, import("./tools/align").AlignData, import("./tools/align").AlignComputed, import("./tools/align").AlignMethods, {}, {}, {}, string, import("./main").EditorTools.AlignToolProps, import("./main").EditorTools.AlignToolProps, {}>;
+        props: EditorToolsSettings.AlignSettings;
+    };
+    AlignRight: {
+        comp: DefineComponent<import("./main").EditorTools.AlignToolProps, any, import("./tools/align").AlignData, import("./tools/align").AlignComputed, import("./tools/align").AlignMethods, {}, {}, {}, string, import("./main").EditorTools.AlignToolProps, import("./main").EditorTools.AlignToolProps, {}>;
+        props: EditorToolsSettings.AlignSettings;
+    };
+    AlignJustify: {
+        comp: DefineComponent<import("./main").EditorTools.AlignToolProps, any, import("./tools/align").AlignData, import("./tools/align").AlignComputed, import("./tools/align").AlignMethods, {}, {}, {}, string, import("./main").EditorTools.AlignToolProps, import("./main").EditorTools.AlignToolProps, {}>;
+        props: EditorToolsSettings.AlignSettings;
+    };
+    Indent: {
+        comp: DefineComponent<import("./tools/indent").IndentProps, any, import("./tools/indent").IndentData, import("./tools/indent").IndentComputed, import("./tools/indent").IndentMethods, {}, {}, {}, string, import("./tools/indent").IndentProps, import("./tools/indent").IndentProps, {}>;
+        props: EditorToolsSettings.IndentationSettings;
+    };
+    Outdent: {
+        comp: DefineComponent<import("./tools/outdent").OutdentProps, any, import("./tools/outdent").OutdentData, import("./tools/outdent").OutdentComputed, import("./tools/outdent").OutdentMethods, {}, {}, {}, string, import("./tools/outdent").OutdentProps, import("./tools/outdent").OutdentProps, {}>;
+        props: EditorToolsSettings.IndentationSettings;
+    };
+    OrderedList: {
+        comp: DefineComponent<import("./tools/lists").ListToolProps, any, import("./tools/lists").ListData, import("./tools/lists").ListComputed, import("./tools/lists").ListMethods, {}, {}, {}, string, import("./tools/lists").ListToolProps, import("./tools/lists").ListToolProps, {}>;
+        props: EditorToolsSettings.ListSettings;
+    };
+    UnorderedList: {
+        comp: DefineComponent<import("./tools/lists").ListToolProps, any, import("./tools/lists").ListData, import("./tools/lists").ListComputed, import("./tools/lists").ListMethods, {}, {}, {}, string, import("./tools/lists").ListToolProps, import("./tools/lists").ListToolProps, {}>;
+        props: EditorToolsSettings.ListSettings;
+    };
+    FontSize: {
+        comp: DefineComponent<import("./tools/fontStyle").FontNameProps, any, import("./tools/fontStyle").FontNameData, import("./tools/fontStyle").FontNameComputed, import("./tools/fontStyle").FontNameMethods, {}, {}, {}, string, import("./tools/fontStyle").FontNameProps, import("./tools/fontStyle").FontNameProps, {}>;
+        props: EditorToolsSettings.StyleDropDownListSettings;
+    };
+    FontName: {
+        comp: DefineComponent<import("./tools/fontStyle").FontNameProps, any, import("./tools/fontStyle").FontNameData, import("./tools/fontStyle").FontNameComputed, import("./tools/fontStyle").FontNameMethods, {}, {}, {}, string, import("./tools/fontStyle").FontNameProps, import("./tools/fontStyle").FontNameProps, {}>;
+        props: EditorToolsSettings.StyleDropDownListSettings;
+    };
+    FormatBlock: {
+        comp: DefineComponent<import("./tools/formatBlock").FormatBlockProps, any, import("./tools/formatBlock").FormatBlockData, import("./tools/formatBlock").FormatBlockComputed, import("./tools/formatBlock").FormatBlockMethods, {}, {}, {}, string, import("./tools/formatBlock").FormatBlockProps, import("./tools/formatBlock").FormatBlockProps, {}>;
+        props: EditorToolsSettings.FormatBlockDropDownListSettings;
+    };
+    Undo: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.ToolSettings;
+    };
+    Redo: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.ToolSettings;
+    };
+    Link: {
+        comp: DefineComponent<import("./tools/insertLink").LinkProps, any, import("./tools/insertLink").LinkToolData, import("./tools/insertLink").LinkToolComputed, import("./tools/insertLink").LinkToolMethods, {}, {}, {}, string, import("./tools/insertLink").LinkProps, import("./tools/insertLink").LinkProps, {}>;
+        props: EditorToolsSettings.LinkSettings;
+    };
+    Unlink: {
+        comp: DefineComponent<import("./tools/unlink").UnlinkProps, any, import("./tools/unlink").UnlinkData, import("./tools/unlink").UnlinkComputed, import("./tools/unlink").UnlinkMethods, {}, {}, {}, string, import("./tools/unlink").UnlinkProps, import("./tools/unlink").UnlinkProps, {}>;
+        props: EditorToolsSettings.UnlinkSettings;
+    };
+    InsertImage: {
+        comp: DefineComponent<import("./tools/ToolProps").BasicToolProps, any, import("./tools/insertImage").InsertImageData, import("./tools/insertImage").InsertImageComputed, import("./tools/insertImage").InsertImageMethods, {}, {}, {}, string, import("./tools/ToolProps").BasicToolProps, import("./tools/ToolProps").BasicToolProps, {}>;
+        props: EditorToolsSettings.ImageSettings;
+    };
+    ViewHtml: {
+        comp: DefineComponent<import("./tools/viewHtml").ViewHtmlProps, any, import("./tools/viewHtml").ViewHtmlData, import("./tools/viewHtml").ViewHtmlComputed, import("./tools/viewHtml").ViewHtmlMethods, {}, {}, {}, string, import("./tools/viewHtml").ViewHtmlProps, import("./tools/viewHtml").ViewHtmlProps, {}>;
+        props: EditorToolsSettings.ViewHtmlSettings;
+    };
+    CleanFormatting: {
+        comp: DefineComponent<import("./tools/cleanFormatting").CleanFormattingProps, any, import("./tools/cleanFormatting").CleanFormattingData, import("./tools/cleanFormatting").CleanFormattingComputed, import("./tools/cleanFormatting").CleanFormattingMethods, {}, {}, {}, string, import("./tools/cleanFormatting").CleanFormattingProps, import("./tools/cleanFormatting").CleanFormattingProps, {}>;
+        props: EditorToolsSettings.CleanFormattingSettings;
+    };
+    SelectAll: {
+        comp: DefineComponent<import("./tools/selectAll").SelectAllProps, any, import("./tools/selectAll").SelectAllData, import("./tools/selectAll").SelectAllComputed, import("./tools/selectAll").SelectAllMethods, {}, {}, {}, string, import("./tools/selectAll").SelectAllProps, import("./tools/selectAll").SelectAllProps, {}>;
+        props: EditorToolsSettings.SelectAllSettings;
+    };
+    InsertTable: {
+        comp: DefineComponent<import("./tools/insertTable/tool").InsertTableProps, any, import("./tools/insertTable/tool").InsertTableData, import("./tools/insertTable/tool").InsertTableComputed, import("./tools/insertTable/tool").InsertTableMethods, {}, {}, {}, string, import("./tools/insertTable/tool").InsertTableProps, import("./tools/insertTable/tool").InsertTableProps, {}>;
+        props: EditorToolsSettings.InsertTableSettings;
+    };
+    MergeCells: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.MergeCellsSettings;
+    };
+    SplitCell: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.SplitCellSettings;
+    };
+    AddRowBefore: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.AddRowBeforeSettings;
+    };
+    AddRowAfter: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.AddRowAfterSettings;
+    };
+    AddColumnBefore: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.AddColumnBeforeSettings;
+    };
+    AddColumnAfter: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.AddColumnAfterSettings;
+    };
+    DeleteRow: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.DeleteRowSettings;
+    };
+    DeleteColumn: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.DeleteColumnSettings;
+    };
+    DeleteTable: {
+        comp: DefineComponent<import("./tools/ToolProps").ToolProps, any, import("./tools/proseMirrorTool").ProseMirrorData, import("./tools/proseMirrorTool").ProseMirrorComputed, import("./tools/proseMirrorTool").ProseMirrorMethods, {}, {}, {}, string, import("./tools/ToolProps").ToolProps, import("./tools/ToolProps").ToolProps, {}>;
+        props: EditorToolsSettings.DeleteTableSettings;
+    };
+    Print: {
+        comp: DefineComponent<import("./tools/print").PrintProps, any, import("./tools/print").PrintData, import("./tools/print").PrintComputed, import("./tools/print").PrintMethods, {}, {}, {}, string, import("./tools/print").PrintProps, import("./tools/print").PrintProps, {}>;
+        props: EditorToolsSettings.PrintSettings;
+    };
+    Pdf: {
+        comp: DefineComponent<import("./tools/pdf").PdfProps, any, import("./tools/pdf").PdfData, import("./tools/pdf").PdfComputed, import("./tools/pdf").PdfMethods, {}, {}, {}, string, import("./tools/pdf").PdfProps, import("./tools/pdf").PdfProps, {}>;
+        props: EditorToolsSettings.PdfSettings;
+    };
+    InsertFile: {
+        comp: DefineComponent<import("./tools/insertLink").LinkProps, any, import("./tools/insertLink").LinkToolData, import("./tools/insertLink").LinkToolComputed, import("./tools/insertLink").LinkToolMethods, {}, {}, {}, string, import("./tools/insertLink").LinkProps, import("./tools/insertLink").LinkProps, {}>;
+        props: EditorToolsSettings.InsertFileSettings;
+    };
+    FindAndReplace: {
+        comp: DefineComponent<import("./tools/findReplace").FindAndReplaceProps, any, import("./tools/findReplace").FindAndReplaceData, import("./tools/findReplace").FindAndReplaceComputed, import("./tools/findReplace").FindAndReplaceMethods, {}, {}, {}, string, import("./tools/findReplace").FindAndReplaceProps, import("./tools/findReplace").FindAndReplaceProps, {}>;
+        props: EditorToolsSettings.FindReplaceSettings;
+    };
+    ForeColor: {
+        comp: DefineComponent<import("./tools/applyColor").ApplyColorToolProps, any, import("./tools/applyColor").ApplyColorData, import("./tools/applyColor").ApplyColorComputed, import("./tools/applyColor").ApplyColorMethods, {}, {}, {}, string, import("./tools/applyColor").ApplyColorToolProps, import("./tools/applyColor").ApplyColorToolProps, {}>;
+        props: EditorToolsSettings.ApplyColorSettings;
+    };
+    BackColor: {
+        comp: DefineComponent<import("./tools/applyColor").ApplyColorToolProps, any, import("./tools/applyColor").ApplyColorData, import("./tools/applyColor").ApplyColorComputed, import("./tools/applyColor").ApplyColorMethods, {}, {}, {}, string, import("./tools/applyColor").ApplyColorToolProps, import("./tools/applyColor").ApplyColorToolProps, {}>;
+        props: EditorToolsSettings.ApplyColorSettings;
+    };
+};
+/**
+ * @hidden
+ */
+export interface EditorComponentState {
+    element: HTMLElement | null;
+    _view?: EditorView;
+    contentElement: HTMLDivElement | null;
+    iframe: HTMLIFrameElement | null;
+    trOnChange: Transaction | null;
+    htmlOnChange: string | null;
+    pasteEvent?: ClipboardEvent;
+}
+/**
+ * @hidden
+ */
+export interface EditorComputed {
+    [key: string]: any;
+}
+/**
+ * @hidden
+ */
+export interface EditorMethods {
+    [key: string]: any;
+}
+/**
+ * @hidden
+ */
+export interface EditorData {
+    view?: EditorView;
+    linkDialog?: boolean;
+}
+/**
+ * @hidden
+ */
+export interface EditorAll extends Vue2type, EditorMethods, EditorData, EditorComputed, EditorComponentState {
+}
+/**
+ * @hidden
+ */
+declare let EditorVue2: ComponentOptions<EditorAll, DefaultData<EditorData>, DefaultMethods<EditorAll>, EditorComputed, RecordPropsDefinition<EditorProps>>;
+/**
+ * Represents the [Kendo UI for Vue Editor component]({% slug overview_editor %}).
+ *
+ *  ```jsx
+ *  <template>
+ *    <div>
+ *      <Editor
+ *        :tools="tools"
+ *        :content-style="{
+ *          height: '690px',
+ *        }"
+ *        :default-content="content"
+ *      />
+ *    </div>
+ *  </template>
+ *
+ *  <script>
+ *  import { Editor } from "@progress/kendo-vue-editor";
+ *  import content from "./content-overview";
+ *
+ *  export default {
+ *    components: {
+ *      Editor,
+ *    },
+ *    data() {
+ *      return {
+ *        tools: [
+ *          ["Bold", "Italic", "Underline", "Strikethrough"],
+ *          ["Subscript", "Superscript"],
+ *          ["AlignLeft", "AlignCenter", "AlignRight", "AlignJustify"],
+ *          ["Indent", "Outdent"],
+ *          ["OrderedList", "UnorderedList"],
+ *          "FontSize",
+ *          "FontName",
+ *          "FormatBlock",
+ *          ["Undo", "Redo"],
+ *          ["Link", "Unlink", "InsertImage", "ViewHtml"],
+ *          ["InsertTable"],
+ *          ["AddRowBefore", "AddRowAfter", "AddColumnBefore", "AddColumnAfter"],
+ *          ["DeleteRow", "DeleteColumn", "DeleteTable"],
+ *          ["MergeCells", "SplitCell"],
+ *        ],
+ *        content: content,
+ *      };
+ *    },
+ *  };
+ *  </script>
+ *  ```
+ *
+ *
+ *
+ *  ### props <span class='code'>Readonly&lt;[EditorProps]({% slug api_editor_editorprops %})</span>
+ *  The props of the Editor component.
+ *
+ *  ### contentElement <span class='code'>HTMLDivElement</span>
+ *  Returns the content-editable DOM element of the Editor.
+ *
+ *  ### element <span class='code'>HTMLElement</span>
+ *  Returns the DOM element of the Editor.
+ *
+ *  ### value <span class='code'>Node | string</span>
+ *  The value of the Editor.
+ *
+ *  ### view <span class='code'>EditorView&lt;any&gt;</span>
+ *  Returns the `view` object of the Editor.
+ */
+declare const Editor: DefineComponent<EditorProps, any, EditorData, EditorComputed, EditorMethods, {}, {}, {}, string, EditorProps, EditorProps, {}>;
+export { Editor, EditorVue2 };