From 2f64395cbdd6b0d4ab04bf40c2e113af7a0fa4c5 Mon Sep 17 00:00:00 2001 From: Hufe921 Date: Tue, 25 Apr 2023 21:21:39 +0800 Subject: [PATCH] docs: update schema, shortcut, option --- docs/guide/option.md | 3 +++ docs/guide/schema.md | 15 ++++++--------- docs/guide/shortcut-internal.md | 29 ++++++++++++++++++++++++++++- docs/guide/start.md | 4 ++-- 4 files changed, 39 insertions(+), 12 deletions(-) diff --git a/docs/guide/option.md b/docs/guide/option.md index 5b82ad5..5023aba 100644 --- a/docs/guide/option.md +++ b/docs/guide/option.md @@ -64,6 +64,7 @@ interface IEditorOption { interface IHeader { top?: number; // 距离页面顶部大小。默认:30 maxHeightRadio?: MaxHeightRatio; // 占页面最大高度比。默认:HALF + disabled?: boolean; // 是否禁用 } ``` @@ -73,6 +74,7 @@ interface IHeader { interface IFooter { bottom?: number; // 距离页面底部大小。默认:30 maxHeightRadio?: MaxHeightRatio; // 占页面最大高度比。默认:HALF + disabled?: boolean; // 是否禁用 } ``` @@ -87,6 +89,7 @@ interface IPageNumber { rowFlex?: RowFlex; // 行对齐方式。默认:CENTER format?: string; // 页码格式。默认:{pageNo}。示例:第{pageNo}页/共{pageCount}页 numberType?: NumberType; // 数字类型。默认:ARABIC + disabled?: boolean; // 是否禁用 } ``` diff --git a/docs/guide/schema.md b/docs/guide/schema.md index cf1e839..112d78d 100644 --- a/docs/guide/schema.md +++ b/docs/guide/schema.md @@ -21,6 +21,7 @@ interface IElement { BLOCK = 'block' }; value: string; + valueList?: IElement[]; // 复合元素(超链接、标题、列表等)使用 // 样式 font?: string; size?: number; @@ -42,11 +43,9 @@ interface IElement { letterSpacing?: number; // 表格 colgroup?: { - id?: string; width: number; }[]; trList?: { - id?: string; height: number; tdList: { colspan: number; @@ -55,14 +54,9 @@ interface IElement { value: IElement[]; }[]; }[]; - tdId?: string; - trId?: string; - tableId?: string; borderType?: TableBorder; // 超链接 - valueList?: IElement[]; url?: string; - hyperlinkId?: string; // 上下标 actualSize?: number; // 分割线 @@ -92,7 +86,6 @@ interface IElement { disabled?: boolean; }; }; - controlId?: string; controlComponent?: { PREFIX = 'prefix', POSTFIX = 'postfix', @@ -110,7 +103,6 @@ interface IElement { laTexSVG?: string; // 日期 dateFormat?: string; - dateId?: string; // 图片 imgDisplay?: { INLINE = 'inline', @@ -129,5 +121,10 @@ interface IElement { src: string; }; }; + // 标题 + level?: TitleLevel; + // 列表 + listType?: ListType; + listStyle?: ListStyle; } ``` \ No newline at end of file diff --git a/docs/guide/shortcut-internal.md b/docs/guide/shortcut-internal.md index 2942548..097528c 100644 --- a/docs/guide/shortcut-internal.md +++ b/docs/guide/shortcut-internal.md @@ -91,4 +91,31 @@ 功能:上标 ## Ctrl/Cmd + Shift + < -功能:下标 \ No newline at end of file +功能:下标 + +## Ctrl + Alt/Option + 0 +功能:正文 + +## Ctrl + Alt/Option + 1 +功能:标题一 + +## Ctrl + Alt/Option + 2 +功能:标题二 + +## Ctrl + Alt/Option + 3 +功能:标题三 + +## Ctrl + Alt/Option + 4 +功能:标题四 + +## Ctrl + Alt/Option + 5 +功能:标题五 + +## Ctrl + Alt/Option + 6 +功能:标题六 + +## Ctrl/Cmd + Shift + I +功能:无序列表 + +## Ctrl/Cmd + Shift + U +功能:有序列表 \ No newline at end of file diff --git a/docs/guide/start.md b/docs/guide/start.md index 03b35e7..515d080 100644 --- a/docs/guide/start.md +++ b/docs/guide/start.md @@ -10,7 +10,7 @@ ## 功能点 -- 富文本操作(撤销、重做、字体、字号、加粗、斜体、上下标、对齐方式.....) +- 富文本操作(撤销、重做、字体、字号、加粗、斜体、上下标、对齐方式、标题、列表.....) - 插入元素(表格、图片、链接、代码块、分页符、Math公式、日期选择器、内容块......) - 打印(基于canvas转图片、pdf绘制) - 控件(单选、文本、复选框) @@ -24,7 +24,7 @@ ## 待开发 -- 调整行首标点符号 +- 标题、列表功能完善 - 计算性能 - 控件规则 - 表格分页