Skip to content

Editor 编辑器

xy-editor 统一承接 Markdown 编辑、只读切换和内容同步,适合后台知识库、公告、说明文档等输入场景。

基础用法

通过 v-model 直接同步 Markdown 内容。

禁用态与配置下发

disabled 可以把编辑器切到只读交互,options 则继续承接底层 Vditor 的常用能力配置。

当前可编辑

实例方法控制

通过 expose 的 focus / setValue / getValue,可以把编辑器接进模板填充、草稿恢复和快捷录入流程。

当前读取到的 Markdown
## 运营周报

点击上方按钮可以快速插入模板内容。

公告编辑页

这个示例把编辑器放进真实的后台编辑场景里,而不是只展示一个独立输入框。

公告编辑页
产品更新待发布
发布信息
栏目
产品更新
创建人
小叶
面向范围
全员可见
当前摘要
# 四月版本更新

## 本次重点

- 新增图表、编辑器与播放器封装
- 完成 OverlayForm 关闭生命周期补齐
- 增强中后台页面壳层组件...

与增强层组合

在实际后台里,编辑器经常出现在 OverlayForm 这类覆盖层编辑链路里,而不是单独占一整页。

公告管理列表
当前文档:四月版本公告尚未提交

与 OverlayForm 组合

富文本或 Markdown 编辑并不总在独立页面中出现,也常作为覆盖层编辑的一部分嵌入 OverlayForm

公告编辑动作
这个场景展示 `OverlayForm + Editor` 的组合方式

使用约定

  • xy-editor 对外统一暴露 Markdown 字符串,不扩展额外数据协议。
  • options 会透传给 Vditor;当 options、高度、最小高度或占位文案变化时,组件会重建实例。
  • disabled 是当前公开的只读入口,适合审批查看、模板回看和系统生成内容复核。
  • 外部要主动写入内容时,优先用 v-model;需要显式触发焦点或覆盖内容时再使用 expose。

API

Editor Attributes

属性说明类型默认值
model-value当前 Markdown 内容EditorProps["modelValue"]''
options透传给 Vditor 的配置项EditorProps["options"]{}
placeholder占位文案EditorProps["placeholder"]''
height编辑器高度EditorProps["height"]'auto'
min-height编辑器最小高度string | number360
disabled是否禁用编辑booleanfalse

Editor Events

事件说明参数
update:model-value内容输入变化时触发EditorModelValueChangeHandler
init编辑器实例初始化后触发EditorInstanceHandler
ready编辑器实例可用后触发EditorInstanceHandler
focus获取焦点时触发EditorFocusHandler
blur失焦时触发EditorBlurHandler

Editor Exposes

暴露项说明类型
editor当前 Vditor 实例引用EditorInstance["editor"]
getValue获取当前 Markdown 内容EditorInstance["getValue"]
setValue主动写入 Markdown 内容EditorInstance["setValue"]
focus让编辑器获取焦点EditorInstance["focus"]