当编辑器中存在未保存的更改时,如果用户执行以下任一操作,autosave 插件将向用户发出警告:

  • 尝试关闭浏览器窗口或标签页,或

  • 尝试离开当前页面。

autosave 插件会添加以下内容:

  • File 菜单下的一个菜单项“恢复上次草稿”,以及

  • 一个可选的toolbar按钮。

基本设置

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  toolbar: 'restoredraft'
});

有关使用模块打包器打包此插件的信息,请参阅打包 TinyMCE - 概述。

选项

这些设置会影响 autosave 插件的执行。此处描述的设置将影响当前编辑器实例的本地存储草稿的间隔、持续时间和行为。

autosave_ask_before_unload

此选项允许你设置编辑器是否应在用户尝试关闭当前窗口时提示用户,告知他们存在未保存的更改。默认情况下此选项是启用的,下面提供了一个禁用此设置的示例。

类型:Boolean

默认值:true

可能的值:true, false

示例:使用 autosave_ask_before_unload

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  autosave_ask_before_unload: false
});

autosave_interval

此选项允许你指定编辑器在对当前内容进行快照并将其保存到本地存储之间应等待的时间。语法是在数字值末尾添加字母 s。例如,“30s”表示30秒。

类型:String

默认值:'30s'

示例:使用 autosave_interval

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  autosave_interval: '20s'
});

autosave_prefix

此选项允许你设置用于本地存储键的前缀。

类型:String

默认值:'tinymce-autosave-{path}{query}-{id}-'

示例:使用 autosave_prefix

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  autosave_prefix: 'tinymce-autosave-{path}{query}-{id}-'
});

autosave_restore_when_empty

此选项允许你指定在初始化时如果编辑器为空,TinyMCE 是否应自动恢复存储在本地存储中的内容。这对于不知道可以通过从 File 菜单中选择Restore last draft来恢复因浏览器崩溃而丢失的工作的用户来说非常有用。

类型:Boolean

默认值:false

可能的值:true, false

示例:使用 autosave_restore_when_empty

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  autosave_restore_when_empty: true
});

autosave_retention

此选项允许你指定编辑器内容应在本地存储中保留的时长。超过设定时间的内容将被忽略。语法是在数字值末尾添加字母 m。例如,“20m”表示20分钟。

类型:String

默认值:'20m'

示例:使用 autosave_retention

tinymce.init({
  selector: 'textarea',  // 根据你的 HTML 修改此值
  plugins: 'autosave',
  autosave_retention: '30m'
});

toolbar按钮

Autosave 插件提供了以下toolbar按钮:

toolbar按钮标识符描述

restoredraft

恢复到最新的自动保存草稿。

可以使用以下方式将这些toolbar按钮添加到编辑器中:

菜单项

Autosave 插件提供了以下菜单项:

菜单项标识符默认菜单位置描述

restoredraft

File

恢复到最新的自动保存草稿。

可以使用以下方式将这些菜单项添加到编辑器中:

  • menu 配置选项。

  • contextmenu 配置选项。

  • 自定义菜单工具栏按钮。