From 3922a171a17d8e9249a36ffd7562e81df68768ba Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Wed, 27 Mar 2024 11:22:06 +0800 Subject: [PATCH] docs: add title prop for editor create extension point (#325) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 为编辑器扩展添加 title 字段的描述,为 https://github.com/halo-dev/halo/pull/5465 的改动添加文档。 /kind documentation ```release-note None ``` --- .../ui/extension-points/editor-create.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/developer-guide/plugin/api-reference/ui/extension-points/editor-create.md b/docs/developer-guide/plugin/api-reference/ui/extension-points/editor-create.md index f3a42d8..5db1faa 100644 --- a/docs/developer-guide/plugin/api-reference/ui/extension-points/editor-create.md +++ b/docs/developer-guide/plugin/api-reference/ui/extension-points/editor-create.md @@ -39,14 +39,16 @@ export interface EditorProvider { 其中,`component` 可以是组件对象或组件名称,且此组件有以下实现要求: -1. 组件必须包含以下 props: - 1. `raw:string`:用于接收原始内容。 - 2. `content:string`:用于接收渲染后的内容。 - 3. `uploadImage?: (file: File) => Promise`:用于上传图片,在编辑器内部获取到 File 之后直接调用此方法即可得到上传后的附件信息。 -2. 组件必须包含以下 emit 事件: - 1. `update:raw`:用于更新原始内容。 - 2. `update:content`:用于更新渲染后的内容。 - 3. `update`:发送更新事件。 +1. 组件包含以下 props: + 1. `title:string`:用于接收标题。 + 2. `raw:string`:用于接收原始内容。 + 3. `content:string`:用于接收渲染后的内容。 + 4. `uploadImage?: (file: File) => Promise`:用于上传图片,在编辑器内部获取到 File 之后直接调用此方法即可得到上传后的附件信息。 +2. 组件包含以下 emit 事件: + 1. `update:title`:用于更新标题。 + 2. `update:raw`:用于更新原始内容。 + 3. `update:content`:用于更新渲染后的内容。 + 4. `update`:发送更新事件。 ## 示例