remons-markdown-editor 1.0.0-beta.1 → 1.0.0-beta.11

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 (33) hide show
  1. package/dist/App.d.ts +2 -0
  2. package/dist/MarkdownEditor.d.ts +23 -0
  3. package/dist/components/Dialog/EditDialog.d.ts +21 -0
  4. package/dist/components/Editor/codemirrorExtensions.d.ts +12 -0
  5. package/dist/components/Editor/containerWidget.d.ts +20 -0
  6. package/dist/components/Editor/index.d.ts +16 -0
  7. package/dist/components/Panel/SplitPanels.d.ts +7 -0
  8. package/dist/components/Preview/index.d.ts +10 -0
  9. package/dist/components/Toolbar/buttons.d.ts +34 -0
  10. package/dist/components/Toolbar/config.d.ts +6 -0
  11. package/dist/components/Toolbar/hooks/useToolbar.d.ts +14 -0
  12. package/dist/components/Toolbar/index.d.ts +13 -0
  13. package/dist/components/Toolbar/renderers/TablePicker/TableDropdown.d.ts +5 -0
  14. package/dist/components/Toolbar/renderers/TablePicker/index.d.ts +9 -0
  15. package/dist/components/Toolbar/renderers/ToolbarItemRenderer.d.ts +7 -0
  16. package/dist/hooks/useFullscreen.d.ts +4 -0
  17. package/dist/hooks/useRegisterToolbar.d.ts +101 -0
  18. package/dist/hooks/useScrollSync.d.ts +6 -0
  19. package/dist/index.cjs +1480 -1198
  20. package/dist/index.cjs.map +1 -1
  21. package/dist/index.css +185 -113
  22. package/dist/index.d.ts +5 -90
  23. package/dist/index.js +1456 -1178
  24. package/dist/index.js.map +1 -1
  25. package/dist/main.d.ts +0 -0
  26. package/dist/registry/componentRegistry.d.ts +34 -0
  27. package/dist/types/index.d.ts +148 -0
  28. package/dist/utils/parseContainer.d.ts +18 -0
  29. package/dist/utils/writeContainer.d.ts +16 -0
  30. package/package.json +79 -81
  31. package/readme.md +309 -81
  32. package/dist/index.css.map +0 -1
  33. package/dist/index.d.cts +0 -90
package/dist/index.d.cts DELETED
@@ -1,90 +0,0 @@
1
- import * as React from 'react';
2
- import React__default from 'react';
3
- import { EditorView } from '@codemirror/view';
4
- import { EditorState } from '@codemirror/state';
5
-
6
- interface MarkdownEditorRef {
7
- getContent: () => string;
8
- }
9
- interface MarkdownEditorProps {
10
- /** 初始内容 */
11
- defaultValue?: string;
12
- /** 受控内容 */
13
- value?: string;
14
- /** 内容变化回调 */
15
- onChange?: (value: string) => void;
16
- /** 是否显示预览面板 */
17
- showPreview?: boolean;
18
- /** 是否支持全屏 */
19
- fullscreen?: boolean;
20
- }
21
- declare const _default: React.ForwardRefExoticComponent<MarkdownEditorProps & React.RefAttributes<MarkdownEditorRef>>;
22
-
23
- interface ToolbarButtonConfig {
24
- id?: string;
25
- icon?: React__default.ComponentType;
26
- label?: string;
27
- children?: ToolbarButtonConfig[];
28
- handler?: (view: EditorView, state: EditorState) => void;
29
- separatorBefore?: boolean;
30
- customRender?: () => React__default.ReactNode;
31
- }
32
- /**
33
- * 弹窗属性配置
34
- * 用于定义 Markdown 容器中需要填充的属性字段
35
- */
36
- interface DialogField {
37
- /** 字段键名,用于 Markdown 属性填充 */
38
- key: string;
39
- /** 默认值 */
40
- defaultValue?: string;
41
- }
42
- /**
43
- * 组件 Schema
44
- * 每个容器组件(如 :::linkCard)定义可编辑字段和弹窗渲染逻辑
45
- */
46
- interface ComponentSchema {
47
- /** 容器名称,对应 :::name 语法 */
48
- name: string;
49
- /** 工具栏按钮显示的标签 */
50
- label: string;
51
- /** 工具栏按钮显示的图标 */
52
- icon?: React__default.ReactNode;
53
- /** 弹窗属性配置 — 用于定义 Markdown 内容中需要填充的字段 */
54
- fields: DialogField[];
55
- /**
56
- * 弹窗内容渲染函数(必填)
57
- * 接收当前属性值和回调函数,由用户完全自定义弹窗内容的渲染
58
- * @param props 当前属性值,用于回显
59
- * @param onChange 属性变更回调,用于更新表单值
60
- * @returns 弹窗内容的 ReactNode
61
- */
62
- renderDialog: (props: Record<string, string>, onChange: (key: string, value: string) => void) => React__default.ReactNode;
63
- }
64
-
65
- /**
66
- * 注册自定义容器组件到工具栏。
67
- * 支持 linkCard 形式的 schema(name + fields + renderDialog)。
68
- * fields 定义 Markdown 属性字段,renderDialog 定义弹窗内容。
69
- *
70
- * @example
71
- * ```tsx
72
- * const schema: ComponentSchema = {
73
- * name: 'alert',
74
- * label: '警告框',
75
- * icon: <AlertOutlined />,
76
- * fields: [{ key: 'level', defaultValue: 'info' }],
77
- * renderDialog: (props, onChange) => (
78
- * <Input value={props.level} onChange={e => onChange('level', e.target.value)} />
79
- * ),
80
- * }
81
- *
82
- * function MyPage() {
83
- * useRegisterToolbar(schema)
84
- * return <MarkdownEditor />
85
- * }
86
- * ```
87
- */
88
- declare function useRegisterToolbar(schema: ComponentSchema): void;
89
-
90
- export { type ComponentSchema, type DialogField, _default as MarkdownEditor, type MarkdownEditorProps, type MarkdownEditorRef, type ToolbarButtonConfig, useRegisterToolbar };