@grandaniel/vue-markdown-editor 1.2.0 → 1.3.0-dev.c5fc9b8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/README.md +226 -141
  2. package/dist/components/MarkdownEditor/Factory/MarkdownNodeFactory.d.ts +7 -0
  3. package/dist/components/MarkdownEditor/MarkdownComponentRegistry.d.ts +5 -1
  4. package/dist/components/MarkdownEditor/MarkdownEditorModule.vue.d.ts +2 -2
  5. package/dist/components/MarkdownEditor/Modules/MarkdownModuleBlockquote.vue.d.ts +20 -0
  6. package/dist/components/MarkdownEditor/Modules/MarkdownModuleCodeBlock.vue.d.ts +66 -0
  7. package/dist/components/MarkdownEditor/Modules/MarkdownModuleCodeBlockState.d.ts +5 -0
  8. package/dist/components/MarkdownEditor/Modules/MarkdownModuleFile.vue.d.ts +2 -2
  9. package/dist/components/MarkdownEditor/Modules/MarkdownModuleHeadline1.vue.d.ts +2 -2
  10. package/dist/components/MarkdownEditor/Modules/MarkdownModuleHeadline2.vue.d.ts +2 -2
  11. package/dist/components/MarkdownEditor/Modules/MarkdownModuleHeadline3.vue.d.ts +2 -2
  12. package/dist/components/MarkdownEditor/Modules/MarkdownModuleHr.vue.d.ts +14 -0
  13. package/dist/components/MarkdownEditor/Modules/MarkdownModuleHrState.d.ts +3 -0
  14. package/dist/components/MarkdownEditor/Modules/MarkdownModuleOrderedList.vue.d.ts +14 -0
  15. package/dist/components/MarkdownEditor/Modules/MarkdownModuleParagraph.vue.d.ts +2 -2
  16. package/dist/components/MarkdownEditor/Modules/MarkdownModuleTable.vue.d.ts +14 -0
  17. package/dist/components/MarkdownEditor/Modules/MarkdownModuleTableState.d.ts +5 -0
  18. package/dist/components/MarkdownEditor/Types/MarkdownAstNode.d.ts +4 -0
  19. package/dist/components/MarkdownEditor/Types/MarkdownAstNodeType.d.ts +7 -2
  20. package/dist/components/MarkdownEditor/index.d.ts +7 -1
  21. package/dist/components/MarkdownRenderer/Composable/useMarkdownRenderer.d.ts +21 -1143
  22. package/dist/components/MarkdownRenderer/MarkdownRenderer.vue.d.ts +12 -1141
  23. package/dist/components/MarkdownRenderer/RenderModules/MarkdownModuleBlockquoteRender.vue.d.ts +7 -0
  24. package/dist/components/MarkdownRenderer/RenderModules/MarkdownModuleCodeBlockRender.vue.d.ts +7 -0
  25. package/dist/components/MarkdownRenderer/RenderModules/MarkdownModuleHrRender.vue.d.ts +6 -0
  26. package/dist/components/MarkdownRenderer/RenderModules/MarkdownModuleOrderedListRender.vue.d.ts +7 -0
  27. package/dist/components/MarkdownRenderer/RenderModules/MarkdownModuleTableRender.vue.d.ts +7 -0
  28. package/dist/index.d.ts +1 -0
  29. package/dist/markdown.d.ts +20 -0
  30. package/dist/vue-markdown-editor.css +1 -1
  31. package/dist/vue-markdown-editor.mjs +15883 -10355
  32. package/package.json +5 -6
@@ -0,0 +1,66 @@
1
+ import type MarkdownModuleCodeBlockState from "./MarkdownModuleCodeBlockState";
2
+ declare function focus(): void;
3
+ type __VLS_ModelProps = {
4
+ modelValue: MarkdownModuleCodeBlockState;
5
+ };
6
+ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
7
+ focus: typeof focus;
8
+ editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
9
+ editorRef: import("vue").Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
10
+ editor: {
11
+ default: null;
12
+ type: import("vue").PropType<import("@tiptap/vue-3").Editor>;
13
+ };
14
+ }>> & Readonly<{}>, {
15
+ rootEl: import("vue").Ref<Element | undefined, Element | undefined>;
16
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
17
+ editor: import("@tiptap/vue-3").Editor;
18
+ }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
19
+ P: {};
20
+ B: {};
21
+ D: {};
22
+ C: {};
23
+ M: {};
24
+ Defaults: {};
25
+ }, Readonly<import("vue").ExtractPropTypes<{
26
+ editor: {
27
+ default: null;
28
+ type: import("vue").PropType<import("@tiptap/vue-3").Editor>;
29
+ };
30
+ }>> & Readonly<{}>, {
31
+ rootEl: import("vue").Ref<Element | undefined, Element | undefined>;
32
+ }, {}, {}, {}, {
33
+ editor: import("@tiptap/vue-3").Editor;
34
+ }> | undefined, import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
35
+ editor: {
36
+ default: null;
37
+ type: import("vue").PropType<import("@tiptap/vue-3").Editor>;
38
+ };
39
+ }>> & Readonly<{}>, {
40
+ rootEl: import("vue").Ref<Element | undefined, Element | undefined>;
41
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
42
+ editor: import("@tiptap/vue-3").Editor;
43
+ }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
44
+ P: {};
45
+ B: {};
46
+ D: {};
47
+ C: {};
48
+ M: {};
49
+ Defaults: {};
50
+ }, Readonly<import("vue").ExtractPropTypes<{
51
+ editor: {
52
+ default: null;
53
+ type: import("vue").PropType<import("@tiptap/vue-3").Editor>;
54
+ };
55
+ }>> & Readonly<{}>, {
56
+ rootEl: import("vue").Ref<Element | undefined, Element | undefined>;
57
+ }, {}, {}, {}, {
58
+ editor: import("@tiptap/vue-3").Editor;
59
+ }> | undefined>;
60
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
61
+ "update:modelValue": (value: MarkdownModuleCodeBlockState) => any;
62
+ }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
63
+ "onUpdate:modelValue"?: ((value: MarkdownModuleCodeBlockState) => any) | undefined;
64
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
65
+ declare const _default: typeof __VLS_export;
66
+ export default _default;
@@ -0,0 +1,5 @@
1
+ export default class MarkdownModuleCodeBlockState {
2
+ code: string;
3
+ language: string;
4
+ constructor(object: MarkdownModuleCodeBlockState);
5
+ }
@@ -6,11 +6,11 @@ type __VLS_ModelProps = {
6
6
  declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
7
7
  focus: typeof focus;
8
8
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
- "retry-upload": (fileState: MarkdownModuleFileState) => any;
10
9
  "update:modelValue": (value: MarkdownModuleFileState) => any;
10
+ "retry-upload": (fileState: MarkdownModuleFileState) => any;
11
11
  }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
12
- "onRetry-upload"?: ((fileState: MarkdownModuleFileState) => any) | undefined;
13
12
  "onUpdate:modelValue"?: ((value: MarkdownModuleFileState) => any) | undefined;
13
+ "onRetry-upload"?: ((fileState: MarkdownModuleFileState) => any) | undefined;
14
14
  }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
15
15
  declare const _default: typeof __VLS_export;
16
16
  export default _default;
@@ -6,15 +6,15 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
6
6
  editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
7
7
  focus: () => void;
8
8
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
- "update:modelValue": (value: MarkdownModuleTextState) => any;
10
9
  "update:model-value": (componentState: MarkdownModuleTextState) => any;
11
10
  "update:cursor-position": (cursorPosition: number) => any;
12
11
  "change-type": (newType: import("..").MarkdownAstNodeType) => any;
12
+ "update:modelValue": (value: MarkdownModuleTextState) => any;
13
13
  }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
14
- "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
15
14
  "onUpdate:model-value"?: ((componentState: MarkdownModuleTextState) => any) | undefined;
16
15
  "onUpdate:cursor-position"?: ((cursorPosition: number) => any) | undefined;
17
16
  "onChange-type"?: ((newType: import("..").MarkdownAstNodeType) => any) | undefined;
17
+ "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
18
18
  }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
19
19
  declare const _default: typeof __VLS_export;
20
20
  export default _default;
@@ -6,15 +6,15 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
6
6
  editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
7
7
  focus: () => void;
8
8
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
- "update:modelValue": (value: MarkdownModuleTextState) => any;
10
9
  "update:model-value": (componentState: MarkdownModuleTextState) => any;
11
10
  "update:cursor-position": (cursorPosition: number) => any;
12
11
  "change-type": (newType: import("..").MarkdownAstNodeType) => any;
12
+ "update:modelValue": (value: MarkdownModuleTextState) => any;
13
13
  }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
14
- "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
15
14
  "onUpdate:model-value"?: ((componentState: MarkdownModuleTextState) => any) | undefined;
16
15
  "onUpdate:cursor-position"?: ((cursorPosition: number) => any) | undefined;
17
16
  "onChange-type"?: ((newType: import("..").MarkdownAstNodeType) => any) | undefined;
17
+ "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
18
18
  }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
19
19
  declare const _default: typeof __VLS_export;
20
20
  export default _default;
@@ -6,15 +6,15 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
6
6
  editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
7
7
  focus: () => void;
8
8
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
- "update:modelValue": (value: MarkdownModuleTextState) => any;
10
9
  "update:model-value": (componentState: MarkdownModuleTextState) => any;
11
10
  "update:cursor-position": (cursorPosition: number) => any;
12
11
  "change-type": (newType: import("..").MarkdownAstNodeType) => any;
12
+ "update:modelValue": (value: MarkdownModuleTextState) => any;
13
13
  }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
14
- "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
15
14
  "onUpdate:model-value"?: ((componentState: MarkdownModuleTextState) => any) | undefined;
16
15
  "onUpdate:cursor-position"?: ((cursorPosition: number) => any) | undefined;
17
16
  "onChange-type"?: ((newType: import("..").MarkdownAstNodeType) => any) | undefined;
17
+ "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
18
18
  }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
19
19
  declare const _default: typeof __VLS_export;
20
20
  export default _default;
@@ -0,0 +1,14 @@
1
+ import type MarkdownModuleHrState from "./MarkdownModuleHrState";
2
+ declare function focus(): void;
3
+ type __VLS_ModelProps = {
4
+ modelValue: MarkdownModuleHrState;
5
+ };
6
+ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
7
+ focus: typeof focus;
8
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
+ "update:modelValue": (value: MarkdownModuleHrState) => any;
10
+ }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
11
+ "onUpdate:modelValue"?: ((value: MarkdownModuleHrState) => any) | undefined;
12
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
13
+ declare const _default: typeof __VLS_export;
14
+ export default _default;
@@ -0,0 +1,3 @@
1
+ export default class MarkdownModuleHrState {
2
+ constructor(_object?: MarkdownModuleHrState);
3
+ }
@@ -0,0 +1,14 @@
1
+ import MarkdownModuleListState from "./MarkdownModuleListState";
2
+ type __VLS_ModelProps = {
3
+ modelValue: MarkdownModuleListState;
4
+ };
5
+ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
6
+ focus(): void;
7
+ editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
8
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
+ "update:modelValue": (value: MarkdownModuleListState) => any;
10
+ }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
11
+ "onUpdate:modelValue"?: ((value: MarkdownModuleListState) => any) | undefined;
12
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
13
+ declare const _default: typeof __VLS_export;
14
+ export default _default;
@@ -6,15 +6,15 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
6
6
  editor: import("vue").ShallowRef<import("@tiptap/vue-3").Editor | undefined, import("@tiptap/vue-3").Editor | undefined>;
7
7
  focus: () => void;
8
8
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
- "update:modelValue": (value: MarkdownModuleTextState) => any;
10
9
  "update:model-value": (componentState: MarkdownModuleTextState) => any;
11
10
  "update:cursor-position": (cursorPosition: number) => any;
12
11
  "change-type": (newType: import("..").MarkdownAstNodeType) => any;
12
+ "update:modelValue": (value: MarkdownModuleTextState) => any;
13
13
  }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
14
- "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
15
14
  "onUpdate:model-value"?: ((componentState: MarkdownModuleTextState) => any) | undefined;
16
15
  "onUpdate:cursor-position"?: ((cursorPosition: number) => any) | undefined;
17
16
  "onChange-type"?: ((newType: import("..").MarkdownAstNodeType) => any) | undefined;
17
+ "onUpdate:modelValue"?: ((value: MarkdownModuleTextState) => any) | undefined;
18
18
  }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
19
19
  declare const _default: typeof __VLS_export;
20
20
  export default _default;
@@ -0,0 +1,14 @@
1
+ import type MarkdownModuleTableState from "./MarkdownModuleTableState";
2
+ declare function focus(): void;
3
+ type __VLS_ModelProps = {
4
+ modelValue: MarkdownModuleTableState;
5
+ };
6
+ declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {
7
+ focus: typeof focus;
8
+ }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
9
+ "update:modelValue": (value: MarkdownModuleTableState) => any;
10
+ }, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
11
+ "onUpdate:modelValue"?: ((value: MarkdownModuleTableState) => any) | undefined;
12
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
13
+ declare const _default: typeof __VLS_export;
14
+ export default _default;
@@ -0,0 +1,5 @@
1
+ export default class MarkdownModuleTableState {
2
+ headers: string[];
3
+ rows: string[][];
4
+ constructor(object: MarkdownModuleTableState);
5
+ }
@@ -1,5 +1,7 @@
1
+ import type MarkdownModuleCodeBlockState from "../Modules/MarkdownModuleCodeBlockState";
1
2
  import type MarkdownModuleFileState from "../Modules/MarkdownModuleFileState";
2
3
  import type MarkdownModuleImageState from "../Modules/MarkdownModuleImageState";
4
+ import type MarkdownModuleTableState from "../Modules/MarkdownModuleTableState";
3
5
  import type MarkdownModuleTextState from "../Modules/MarkdownModuleTextState";
4
6
  import type MarkdownNodeType from "./MarkdownAstNodeType";
5
7
  export declare class MarkdownAstNode<TState extends object = object> {
@@ -14,3 +16,5 @@ export declare class MarkdownAstNode<TState extends object = object> {
14
16
  export type TextNode = MarkdownAstNode<MarkdownModuleTextState>;
15
17
  export type ImageNode = MarkdownAstNode<MarkdownModuleImageState>;
16
18
  export type FileNode = MarkdownAstNode<MarkdownModuleFileState>;
19
+ export type CodeBlockNode = MarkdownAstNode<MarkdownModuleCodeBlockState>;
20
+ export type TableNode = MarkdownAstNode<MarkdownModuleTableState>;
@@ -5,8 +5,13 @@ declare enum MarkdownNodeType {
5
5
  HEADLINE3 = 3,
6
6
  IMAGE = 4,
7
7
  LIST = 5,
8
- FILE = 6
8
+ FILE = 6,
9
+ BLOCKQUOTE = 7,
10
+ CODE_BLOCK = 8,
11
+ HR = 9,
12
+ TABLE = 10,
13
+ ORDERED_LIST = 11
9
14
  }
10
- export type TextishNodeType = MarkdownNodeType.PARAGRAPH | MarkdownNodeType.LIST | MarkdownNodeType.HEADLINE1 | MarkdownNodeType.HEADLINE2 | MarkdownNodeType.HEADLINE3;
15
+ export type TextishNodeType = MarkdownNodeType.PARAGRAPH | MarkdownNodeType.LIST | MarkdownNodeType.HEADLINE1 | MarkdownNodeType.HEADLINE2 | MarkdownNodeType.HEADLINE3 | MarkdownNodeType.BLOCKQUOTE | MarkdownNodeType.ORDERED_LIST;
11
16
  export declare function isTextNodeType(type: MarkdownNodeType): type is TextishNodeType;
12
17
  export default MarkdownNodeType;
@@ -1,6 +1,12 @@
1
1
  export { default as MarkdownEditor } from './MarkdownEditor.vue';
2
2
  export { useMarkdownEditor, type MarkdownEditorInstance } from "./Composable/useMarkdownEditor";
3
3
  export { isTextNodeState } from "./MarkdownComponentRegistry";
4
- export { MarkdownAstNode, type FileNode, type ImageNode, type TextNode } from "./Types/MarkdownAstNode";
4
+ export { MarkdownAstNode, type CodeBlockNode, type FileNode, type ImageNode, type TableNode, type TextNode, } from "./Types/MarkdownAstNode";
5
5
  export { default as MarkdownAstNodeType, isTextNodeType, type TextishNodeType } from "./Types/MarkdownAstNodeType";
6
6
  export { default as MarkdownModuleFileState } from "./Modules/MarkdownModuleFileState";
7
+ export { default as MarkdownModuleCodeBlockState } from "./Modules/MarkdownModuleCodeBlockState";
8
+ export { default as MarkdownModuleHrState } from "./Modules/MarkdownModuleHrState";
9
+ export { default as MarkdownModuleTableState } from "./Modules/MarkdownModuleTableState";
10
+ export { default as MarkdownModuleImageState } from "./Modules/MarkdownModuleImageState";
11
+ export { default as MarkdownModuleListState } from "./Modules/MarkdownModuleListState";
12
+ export { default as MarkdownModuleTextState } from "./Modules/MarkdownModuleTextState";