# markdown-editor LLMs.txt

> 供 LLM 快速理解 `@flatbiz/antd/markdown-editor` 的使用方式。

## 模块定位

markdown编辑器

## 导入方式

```ts
import { MarkdownEditor } from '@flatbiz/antd/markdown-editor';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `MarkdownEditor` - markdown编辑器
- `ReactMdEditor` - 
- `* from ./content.jsx`
- `MermaidViewBtn`
- `PluginMermaidCode`
- `MarkdownEditorProps`
- `UploadImageContent`
- `UploadImageBtn`

## 依赖的 antd 能力

`Button`、`FormInstance`、`InputNumber`、`message`、`Spin`

## Props / 配置要点

### MarkdownEditorProps

- `style`（可选）：: CSSProperties
- `className`（可选）：: string
- `value`（可选）：: string
- `onChange`（可选）：: (value?: string) => void
- `onUploadImage`（可选）：: (file: File) => Promise<{ url: string; name: string }>；图片上传回调，配置后，在工具栏中显示上传图片按钮
- `height`（可选）：: number | string；当高度参数为百分比时，拖动条无效
- `hideToolbar`（可选）：: boolean；是否隐藏工具栏
- `visibleDragbar`（可选）：: boolean；是否可拖拽高度操作，默认值：true
- `readonly`（可选）：: boolean；是否只读，设置后会隐藏工具栏部分功能
- `readonlyHeightAuto`（可选）：: boolean；只读高度自适应，设置为 true 时，会根据内容自动调整高度，默认值：true
- `isDarkMode`（可选）：: boolean；是否暗色模式，默认值：false
- `hideBorder`（可选）：: boolean；是否隐藏边框

## 使用规则与行为

- markdown编辑器
- 图片上传回调，配置后，在工具栏中显示上传图片按钮
- 当高度参数为百分比时，拖动条无效
- 是否隐藏工具栏
- 是否可拖拽高度操作，默认值：true
- 是否只读，设置后会隐藏工具栏部分功能
- 只读高度自适应，设置为 true 时，会根据内容自动调整高度，默认值：true
- 是否暗色模式，默认值：false
- 是否隐藏边框

## 默认值线索

- `readonlyHeightAutoFt => readonlyHeightAuto ?? true`

## 基础示例

```tsx
import { MarkdownEditor, type MarkdownEditorProps } from '@flatbiz/antd/markdown-editor';

const props: MarkdownEditorProps = {
  // 按业务传入必要参数
};

<MarkdownEditor {...props} />;
```

## 源码索引

- `src/markdown-editor/content.tsx`
- `src/markdown-editor/editor.tsx`
- `src/markdown-editor/index.ts`
- `src/markdown-editor/mermaid-view/index.tsx`
- `src/markdown-editor/plugin-mermaid.tsx`
- `src/markdown-editor/type.ts`
- `src/markdown-editor/upload-image/content.tsx`
- `src/markdown-editor/upload-image/index.tsx`

## 给 LLM 的注意事项

- 优先使用 `@flatbiz/antd/markdown-editor` 或主入口 `@flatbiz/antd` 的公开导出，不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时，以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数，请读取上方源码索引中的类型定义和 JSDoc。