remons-markdown-editor 1.0.0-beta.9 → 2.0.0-beta.0

package/dist/MarkdownEditor.d.ts

@@ -1,12 +1,13 @@
-import { ImageUploadConfig } from './types';
+import { default as React } from 'react';
+import { ImageUploadConfig, ComponentSchema, NotifyFn } from './types';
 import { PreviewOptions } from './components/Preview';
 export interface MarkdownEditorRef {
     getContent: () => string;
 }
 export interface MarkdownEditorProps {
-    /** 初始内容 */
+    /** 初始内容（非受控） */
     defaultValue?: string;
-    /** 受控内容 */
+    /** 受控内容；传入时请同时提供 onChange，否则外部更新会覆盖本地编辑 */
     value?: string;
     /** 内容变化回调 */
     onChange?: (value: string) => void;
@@ -18,6 +19,24 @@ export interface MarkdownEditorProps {
     previewOptions?: PreviewOptions;
     /** 图片上传配置 */
     uploadConfig?: ImageUploadConfig;
+    /**
+     * 局部注册的容器 schema：仅对当前编辑器实例生效，
+     * 同名时覆盖全局注册（useRegisterToolbar）的 schema。
+     * 请传入稳定引用（组件外常量或 useMemo）。
+     */
+    schemas?: ComponentSchema[];
+    /**
+     * 提示注入点（如"请先配置图片上传功能"）。
+     * 缺省使用宿主 antd App 上下文的 message，其次回退 console。
+     */
+    onNotify?: NotifyFn;
 }
-declare const _default: import('react').ForwardRefExoticComponent<MarkdownEditorProps & import('react').RefAttributes<MarkdownEditorRef>>;
-export default _default;
+interface WrapperProps extends MarkdownEditorProps {
+    ref?: React.Ref<MarkdownEditorRef>;
+}
+/**
+ * 包一层 antd App：为库内部的 message 等反馈组件提供上下文；
+ * 宿主已有 App 包裹时内层仅作兜底（component={false} 不额外渲染 DOM）。
+ */
+export default function MarkdownEditorWithApp({ ref, ...props }: WrapperProps): React.JSX.Element;
+export {};

package/dist/components/Dialog/EditDialog.d.ts

@@ -1,3 +1,4 @@
+import { ContainerProps } from '../../utils/parseContainer';
 /**
  * 弹窗编辑容器属性的组件
  */
@@ -7,9 +8,9 @@ interface EditDialogProps {
     /** 容器类型名称 */
     typeName: string;
     /** 当前属性值 */
-    currentProps: Record<string, string>;
+    currentProps: ContainerProps;
     /** 保存回调 */
-    onSave: (props: Record<string, string>) => void;
+    onSave: (props: ContainerProps) => void;
     /** 关闭回调 */
     onClose: () => void;
 }
@@ -17,5 +18,5 @@ interface EditDialogProps {
  * 属性编辑弹窗组件
  * 根据组件 schema 的 renderDialog 函数渲染弹窗内容
  */
-export default function EditDialog({ visible, typeName, currentProps, onSave, onClose }: EditDialogProps): import("react").JSX.Element | null;
+export default function EditDialog({ visible, typeName, currentProps, onSave, onClose }: EditDialogProps): import('react').JSX.Element | null;
 export {};

package/dist/components/Editor/codemirrorExtensions.d.ts

@@ -3,10 +3,10 @@ import { ImageUploadConfig } from '../../types';
 interface GetCodeMirrorExtensionsOptions {
     /** 编辑容器属性的回调函数 */
     onEditContainer?: OnEditContainer;
-    /** 图片上传配置 */
-    uploadConfig?: ImageUploadConfig;
-    /** 未配置上传时的提示回调 */
-    onMessageNoUploadConfig?: () => void;
+    /** 获取最新图片上传配置（运行期求值） */
+    getUploadConfig?: () => ImageUploadConfig | undefined;
+    /** 获取最新"未配置上传"提示回调（运行期求值） */
+    getOnMessageNoUploadConfig?: () => (() => void) | undefined;
 }
 export declare const getCodeMirrorExtensions: (opts?: GetCodeMirrorExtensionsOptions) => import('@codemirror/state').Extension[];
 export default getCodeMirrorExtensions;

package/dist/components/Editor/containerWidget.d.ts

@@ -1,20 +1,25 @@
-import { ViewPlugin, DecorationSet } from '@codemirror/view';
-import { Facet } from '@codemirror/state';
+import { ViewPlugin, EditorView, DecorationSet } from '@codemirror/view';
+import { EditorState, Facet } from '@codemirror/state';
+import { ContainerBlock } from '../../utils/parseContainer';
 /**
  * 编辑容器属性的回调函数类型
+ * @param view 当前编辑器实例
+ * @param container 被点击编辑的容器块（含位置与最新属性）
  */
-export interface OnEditContainer {
-    (view: any, typeName: string, propsLineFrom: number, propsLineTo: number, currentProps: Record<string, string>): void;
-}
+export type OnEditContainer = (view: EditorView, container: ContainerBlock) => void;
 /**
  * 自定义 facet 用于传递编辑回调
  */
-export declare const containerEditCallback: Facet<any, OnEditContainer>;
+export declare const containerEditCallback: Facet<OnEditContainer, OnEditContainer | null>;
 /**
  * 容器编辑 ViewPlugin
- * 将容器的 ::: 头行和 {} 属性行替换为只读 widget，使其无法在编辑器中直接编辑
+ * 将容器的 ::: 头行和 {} 属性行替换为只读 widget，使其无法在编辑器中直接编辑。
+ * 仅在文档内容变化时重建装饰，光标移动不触发全文扫描。
  */
 export declare const containerWidgetPlugin: ViewPlugin<{
     decorations: DecorationSet;
-    update(update: any): void;
+    update(update: {
+        docChanged: boolean;
+        state: EditorState;
+    }): void;
 }, undefined>;

package/dist/components/Editor/index.d.ts

@@ -1,4 +1,5 @@
 import { EditorView } from 'codemirror';
+import { OnEditContainer } from './containerWidget';
 import { ImageUploadConfig } from '../../types';
 interface EditorProps {
     value: string;
@@ -6,11 +7,11 @@ interface EditorProps {
     onScrollReady?: (scrollDOM: HTMLElement) => void;
     onViewReady?: (view: EditorView) => void;
     /** 编辑容器属性的回调 */
-    onEditContainer?: (view: any, typeName: string, propsLineFrom: number, propsLineTo: number, currentProps: Record<string, string>) => void;
+    onEditContainer?: OnEditContainer;
     /** 图片上传配置 */
     uploadConfig?: ImageUploadConfig;
     /** 未配置上传时的提示回调 */
     onMessageNoUploadConfig?: () => void;
 }
-export default function Editor({ value, onChange, onScrollReady, onViewReady, onEditContainer, uploadConfig, onMessageNoUploadConfig }: EditorProps): import("react").JSX.Element;
+export default function Editor({ value, onChange, onScrollReady, onViewReady, onEditContainer, uploadConfig, onMessageNoUploadConfig }: EditorProps): import('react').JSX.Element;
 export {};

package/dist/components/Icon/config.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 配置 iconfont 脚本地址（宿主在应用入口调用），需在首次渲染前设置；
+ * 变更后重置内部缓存，下次渲染时以新地址重建图标组件。
+ */
+export declare function setIconfontScriptUrl(url: string): void;
+/** 读取当前 iconfont 脚本地址 */
+export declare function getIconfontScriptUrl(): string;
+/** 懒创建图标组件：首次渲染时才注入 iconfont 脚本，避免模块层副作用 */
+export declare function getIconComponent(): import('react').FC<import('@ant-design/icons/es/components/IconFont').IconFontProps<string>>;

package/dist/components/Icon/index.d.ts

@@ -0,0 +1,2 @@
+declare function IconComponent(type: string, className?: string): import('react').JSX.Element;
+export default IconComponent;

package/dist/components/Preview/index.d.ts

@@ -1,10 +1,11 @@
 import { RenderMarkdownProps } from 'remons-render-markdown';
-export type PreviewOptions = Omit<RenderMarkdownProps, 'content'> & {
-    languages?: Record<string, any> | null | undefined;
-};
+export type PreviewOptions = Omit<RenderMarkdownProps, 'content'>;
 export interface PreviewProps {
     content: string;
+    /** 透传给 RenderMarkdown 的渲染配置 */
     previewOptions?: PreviewOptions;
+    /** 额外的高亮语言包（与 languagesCommon 合并注册） */
+    languages?: Record<string, any> | null;
 }
-declare const Preview: import('react').ForwardRefExoticComponent<PreviewProps & import('react').RefAttributes<HTMLDivElement>>;
-export default Preview;
+declare const _default: import('react').MemoExoticComponent<import('react').ForwardRefExoticComponent<PreviewProps & import('react').RefAttributes<HTMLDivElement>>>;
+export default _default;

package/dist/components/Toolbar/buttons.d.ts

@@ -9,15 +9,52 @@ export declare function insertAtCursor(view: EditorView, before: string, after?:
  */
 export declare function insertAtLineStart(view: EditorView, text: string): void;
 /**
- * 上传图片
+ * 切换标题：
+ * - 当前行已是目标级别标题 → 移除行首 # 前缀（变回普通文本）
+ * - 当前行是其他级别标题 → 替换为目标级别
+ * - 当前行是普通文本 → 插入目标级别前缀
+ * @param view - CodeMirror 编辑器实例
+ * @param level - 标题级别（1-6）
+ */
+export declare function toggleHeading(view: EditorView, level: number): void;
+/**
+ * 切换任务列表（checkbox 待办）
+ * - 支持多行：对选区内每一行应用 `- [ ] `
+ * - 普通列表项（如 `- 内容`）直接转换为 `- [ ] 内容`
+ * - 切换：若所有目标行都已是任务项，则移除行首前缀
+ */
+export declare function toggleTaskList(view: EditorView): void;
+/**
+ * 切换行首前缀（支持多行选区）
+ * - 已是对应前缀的行 → 移除前缀（变回普通文本）
+ * - 未加前缀的行 → 在行首插入前缀
+ * @param view - CodeMirror 编辑器实例
+ * @param pattern - 匹配行首前缀的正则
+ * @param insertText - 未匹配时插入的前缀文本
+ */
+export declare function toggleLinePrefix(view: EditorView, pattern: RegExp, insertText: string): void;
+/**
+ * Tab：列表行缩进一级（4 空格）
+ * - 普通行返回 false，继续走默认缩进
+ * - 有序列表缩进后重排序号，子列表从 1 开始
+ */
+export declare function indentMarkdownList(view: EditorView): boolean;
+/**
+ * Shift-Tab：列表行反缩进一级
+ * - 普通行返回 false，继续走默认缩进
+ * - 有序列表反缩进后并入上一层并重排序号
+ */
+export declare function dedentMarkdownList(view: EditorView): boolean;
+/**
+ * 上传图片：失败（含网络异常）统一返回 null，不抛错
  * @param file - 要上传的文件
  * @param uploadConfig - 上传配置
  */
 export declare function uploadFileToServer(file: File, uploadConfig: ImageUploadConfig): Promise<string | null>;
 /**
- * 判断是否配置了图片上传
+ * 判断是否配置了图片上传（类型谓词，守卫后可安全访问配置）
  */
-export declare function isUploadConfigured(uploadConfig?: ImageUploadConfig): boolean;
+export declare function isUploadConfigured(uploadConfig?: ImageUploadConfig): uploadConfig is ImageUploadConfig;
 /**
  * 图片上传：创建隐藏的 file input 触发选择，上传后插入 markdown 图片语法
  * @param view - CodeMirror 编辑器实例

package/dist/components/Toolbar/config.d.ts

@@ -1,6 +1,13 @@
-import { ToolbarButtonConfig, ImageUploadConfig } from '../../types';
+import { ToolbarButtonConfig, ImageUploadConfig, NotifyFn } from '../../types';
+interface ToolbarConfigOptions {
+    /** 图片上传配置 */
+    upload?: ImageUploadConfig;
+    /** 提示注入点（由宿主提供，如 antd App 上下文的 message） */
+    notify?: NotifyFn;
+}
 /**
  * 创建工具栏配置
  * @param options - 配置选项
  */
-export declare function createToolbarConfig(options?: ImageUploadConfig): ToolbarButtonConfig[];
+export declare function createToolbarConfig(options?: ToolbarConfigOptions): ToolbarButtonConfig[];
+export {};

package/dist/components/Toolbar/hooks/useToolbar.d.ts

@@ -1,10 +1,12 @@
 import { EditorView } from '@codemirror/view';
-import { ToolbarButtonConfig, ImageUploadConfig } from '../../../types';
+import { ToolbarButtonConfig, ImageUploadConfig, NotifyFn } from '../../../types';
 export interface UseToolbarOptions {
     /** 第三方扩展的按钮配置，将追加到工具栏末尾 */
     extraItems?: ToolbarButtonConfig[];
     /** 图片上传配置 */
     uploadConfig?: ImageUploadConfig;
+    /** 提示注入点（由宿主提供） */
+    notify?: NotifyFn;
 }
 export interface UseToolbarReturn {
     config: ToolbarButtonConfig[];

package/dist/components/Toolbar/index.d.ts

@@ -1,5 +1,5 @@
 import { EditorView } from '@codemirror/view';
-import { ToolbarButtonConfig, ImageUploadConfig } from '../../types';
+import { ToolbarButtonConfig, ImageUploadConfig, NotifyFn } from '../../types';
 interface ToolbarProps {
     editorView: EditorView | null;
     fullscreen?: boolean;
@@ -8,6 +8,9 @@ interface ToolbarProps {
     extraItems?: ToolbarButtonConfig[];
     /** 图片上传配置 */
     uploadConfig?: ImageUploadConfig;
+    /** 提示注入点（由宿主提供） */
+    notify?: NotifyFn;
 }
-export default function Toolbar({ editorView, fullscreen, onToggleFullscreen, extraItems, uploadConfig }: ToolbarProps): import("react").JSX.Element;
-export {};
+declare function Toolbar({ editorView, fullscreen, onToggleFullscreen, extraItems, uploadConfig, notify }: ToolbarProps): import('react').JSX.Element;
+declare const _default: import('react').MemoExoticComponent<typeof Toolbar>;
+export default _default;

package/dist/components/Toolbar/renderers/TablePicker/TableDropdown.d.ts

@@ -1,5 +1,4 @@
-import { default as React } from 'react';
 import { EditorView } from '@codemirror/view';
 export default function TableDropdown({ editorView }: {
     editorView: EditorView | null;
-}): React.JSX.Element;
+}): import('react').JSX.Element;

package/dist/components/Toolbar/renderers/TablePicker/index.d.ts

@@ -5,5 +5,5 @@ interface TableSize {
 interface TablePickerProps {
     onSelect: (size: TableSize) => void;
 }
-export default function TablePicker({ onSelect }: TablePickerProps): import("react").JSX.Element;
+export default function TablePicker({ onSelect }: TablePickerProps): import('react').JSX.Element;
 export {};

package/dist/components/Toolbar/renderers/ToolbarItemRenderer.d.ts

@@ -3,5 +3,5 @@ interface Props {
     item: ToolbarButtonConfig;
     onClick: (item: ToolbarButtonConfig) => void;
 }
-export declare function ToolbarItemRenderer({ item, onClick }: Props): import("react").JSX.Element;
+export declare function ToolbarItemRenderer({ item, onClick }: Props): import('react').JSX.Element;
 export {};

package/dist/hooks/useRegisterToolbar.d.ts

@@ -93,6 +93,9 @@ import { ComponentSchema } from '../types';
  * @example 批量注册
  * ```tsx
  * function MyPage() {
+ *   // 注意：schema 需声明为稳定引用（组件外常量或 useMemo），
+ *   // 否则每次渲染都会重新注册；多实例互不干扰的场景请改用
+ *   // <MarkdownEditor schemas={[...]} /> 局部注册
  *   useRegisterToolbar([schema1, schema2, schema3])
  *   return <MarkdownEditor />
  * }

package/dist/hooks/useScrollSync.d.ts

@@ -1,5 +1,9 @@
 /**
- * 滚动同步 Hook
- * 将源滚动容器的滚动位置同步到目标预览容器
+ * 双向滚动同步 Hook
+ * 编辑器与预览区互相同步滚动位置（基于比例）
+ * 使用 syncing 锁防止双向循环触发
+ *
+ * 直接接收滚动容器元素（而非 ref）：元素变化时 effect 重新执行并重新绑定监听，
+ * 避免"挂载时容器尚未就绪 / 编辑器 view 被重建"导致监听永久失效或绑到旧节点。
  */
-export declare function useScrollSync(sourceRef: React.RefObject<HTMLElement | null>, targetRef: React.RefObject<HTMLDivElement | null>): void;
+export declare function useScrollSync(source: HTMLElement | null, target: HTMLElement | null): void;