文档配置

用于配置 Umo Editor 文档区域及文档名称的显示和行为。

默认配置

{
  document: {
    title: '未命名文档',
    content: '',
    placeholder: {
      en_US: 'Please enter the document content...',
      zh_CN: '请输入文档内容...',
    },
    enableSpellcheck: true,
    enableMarkdown: true,
    enableBubbleMenu: true,
    enableBlockMenu: true, // v1.3.0 新增
    readOnly: false,
    autofocus: true,
    characterLimit: 0,
    typographyRules: {},
    editorProps: {}, // v2.3.0 新增
    parseOptions: { // v2.3.0 新增
      preserveWhitespace: 'full',
    },
    autoSave: { // v1.4.0 新增
      enabled: true,
      interval: 300000,
    },
  },
}

配置项说明

document.title

说明：文档标题，用于导出的文件名称等，您可以通过setDocument 方法来动态设置或修改文档标题。

类型：String

默认值：未命名文档

document.content

说明：初始的文档内容，用户可修改，您可以通过setContent 方法来动态设置或修改文档内容。

类型：String

默认值：空

document.placeholder

说明：文档内容为空时的占位符。

类型：String 或 Object

默认值：请输入文档内容...

document.enableSpellcheck

说明：是否启用浏览器拼写检查，启用时用户可手动关闭，您可以通过setDocument 方法来动态设置是否启用浏览器拼写检查。

类型：Boolean

默认值：true

document.enableMarkdown

说明：是否启用 Markdown 语法，启用时用户可手动关闭，您可以通过setDocument 方法来动态设置是否启用 Markdown 语法。

类型：Boolean

默认值：true

document.enableBubbleMenu

说明：是否启用气泡菜单，您可以通过setDocument 方法来动态设置是否显示气泡菜单。

类型：Boolean

默认值：true

document.enableBlockMenu v1.3.0 新增

说明：是否启用块级菜单，您可以通过setDocument 方法来动态设置是否显示块级菜单。

类型：Boolean

默认值：true

document.readOnly

说明：文档是否只读，为 true 时用户无法编辑当前文档，您可以通过setReadOnly 方法来设置文档是否只读。

类型：Boolean

默认值：false

document.autofocus

说明：文档是否自动获得光标焦点，您可以通过focus 方法来设置文档是否获得光标焦点。

类型：Boolean

默认值：true

document.characterLimit

说明：文档字数限制，为 0 时不限制字数。

类型：Number

默认值：0

document.typographyRules

说明：文档排版规则。

类型：Object

默认值：{}

配置项:

如果要禁用某项，将该项设置为 false 即可，如：

{
  document:{
    typographyRules: {
      emDash: false
    }
  }
}

<template>
  <umo-editor 
    :document="{
      typographyRules: {
        emDash: false
      }
    }" 
  />
</template>
 
<script setup>
import { UmoEditor } from '@umoteam/editor'
</script>

document.autoSave v1.4.0 新增

说明：文档自动保存配置，您可以通过setDocument 方法来动态设置或修改此配置。

类型：Object

配置项:

• enabled: Boolean，是否启用自动保存，默认值为 true。
• interval: Number，自动保存的间隔时间，单位为毫秒，默认值为 300000（5 分钟）。

document.editorProps v2.3.0 新增

说明：对于一些进阶场景，您可以通过 document。editorProps 向ProseMirror传递一些配置，您可以使用它来覆盖各种编辑器事件或更改编辑器 DOM 元素属性。更多信息见：https://prosemirror.net/docs/ref/#view.EditorProps

示例：

{
  editorProps: {
    attributes: {
      class: 'prose prose-sm sm:prose lg:prose-lg xl:prose-2xl mx-auto focus:outline-none',
    },
    transformPastedText(text) {
      return text.toUpperCase()
    },
  },
}

类型：Object

默认值：{}

document.parseOptions v2.3.0 新增

说明：定义ProseMirror解析行为，当你需要解析一个 DOM 节点或者一个原始文本字符串到 ProseMirror 的文档模型时，你可以使用 document.parseOptions 来自定义解析过程。更多信息见：https://prosemirror.net/docs/ref/#model.ParseOptions

类型：Object

默认值：{ preserveWhitespace: 'full' }