editor-svg 1.0.2 → 1.0.3

package/docs/guide/i18n.md

@@ -1,111 +0,0 @@
-# 国际化
-
-## 使用方式
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-
-const instance = new Editor(container, <IElement[]>data, options)
-
-// 注册
-instance.register.langMap(locale: string, lang: ILang)
-
-// 设置
-instance.command.executeSetLocale(locale)
-```
-
-## ILang
-
-```typescript
-interface ILang {
-  contextmenu: {
-    global: {
-      cut: string
-      copy: string
-      paste: string
-      selectAll: string
-      print: string
-    }
-    control: {
-      delete: string
-    }
-    hyperlink: {
-      delete: string
-      cancel: string
-      edit: string
-    }
-    image: {
-      change: string
-      saveAs: string
-      textWrap: string
-      textWrapType: {
-        embed: string
-        upDown: string
-        surround: string
-        floatTop: string
-        floatBottom: string
-    }
-    table: {
-      insertRowCol: string
-      insertTopRow: string
-      insertBottomRow: string
-      insertLeftCol: string
-      insertRightCol: string
-      deleteRowCol: string
-      deleteRow: string
-      deleteCol: string
-      deleteTable: string
-      mergeCell: string
-      mergeCancelCell: string
-      verticalAlign: string
-      verticalAlignTop: string
-      verticalAlignMiddle: string
-      verticalAlignBottom: string
-      border: string
-      borderAll: string
-      borderEmpty: string
-      borderDash: string
-      borderExternal: string
-      borderInternal: string
-      borderTd: string
-      borderTdTop: string
-      borderTdRight: string
-      borderTdBottom: string
-      borderTdLeft: string
-      borderTdForward: string
-      borderTdBack: string
-    }
-  }
-  datePicker: {
-    now: string
-    confirm: string
-    return: string
-    timeSelect: string
-    weeks: {
-      sun: string
-      mon: string
-      tue: string
-      wed: string
-      thu: string
-      fri: string
-      sat: string
-    }
-    year: string
-    month: string
-    hour: string
-    minute: string
-    second: string
-  }
-  frame: {
-    header: string
-    footer: string
-  }
-  pageBreak: {
-    displayName: string
-  }
-  zone: {
-    headerTip: string
-    footerTip: string
-  }
-}
-```

package/docs/guide/listener.md

@@ -1,126 +0,0 @@
-# 事件监听(listener)
-
-::: warning
-listener 只能响应一个方法，后续不再添加新监听方法，推荐使用 eventBus 进行事件监听。
-:::
-
-## 使用方式
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-
-const instance = new Editor(container, <IElement[]>data, options)
-instance.listener.eventName = ()=>{}
-```
-
-## rangeStyleChange
-
-功能：选区样式发生改变
-
-用法：
-
-```javascript
-instance.listener.rangeStyleChange = (payload: IRangeStyle) => {}
-```
-
-## visiblePageNoListChange
-
-功能：可见页发生改变
-
-用法：
-
-```javascript
-instance.listener.visiblePageNoListChange = (payload: number[]) => {}
-```
-
-## intersectionPageNoChange
-
-功能：当前页发生改变
-
-用法：
-
-```javascript
-instance.listener.intersectionPageNoChange = (payload: number) => {}
-```
-
-## pageSizeChange
-
-功能：当前页数发生改变
-
-用法：
-
-```javascript
-instance.listener.pageSizeChange = (payload: number) => {}
-```
-
-## pageScaleChange
-
-功能：当前页面缩放比例发生改变
-
-用法：
-
-```javascript
-instance.listener.pageScaleChange = (payload: number) => {}
-```
-
-## contentChange
-
-功能：当前内容发生改变
-
-用法：
-
-```javascript
-instance.listener.contentChange = () => {}
-```
-
-## controlChange
-
-功能：当前光标所在控件发生改变
-
-用法：
-
-```javascript
-instance.listener.controlChange = (payload: IControlChangeResult) => {}
-```
-
-## controlContentChange
-
-功能：控件内容发生改变
-
-用法：
-
-```javascript
-instance.listener.controlContentChange = (
-  payload: IControlContentChangeResult
-) => {}
-```
-
-## pageModeChange
-
-功能：页面模式发生改变
-
-用法：
-
-```javascript
-instance.listener.pageModeChange = (payload: PageMode) => {}
-```
-
-## saved
-
-功能：文档执行保存
-
-用法：
-
-```javascript
-instance.listener.saved = (payload: IEditorResult) => {}
-```
-
-## zoneChange
-
-功能：区域发生改变
-
-用法：
-
-```javascript
-instance.listener.zoneChange = (payload: EditorZone) => {}
-```

package/docs/guide/option.md

@@ -1,214 +0,0 @@
-# 配置
-
-## 使用方式
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-
-new Editor(container, IEditorData | IElement[], {
-  // 配置项
-})
-```
-
-## 完整配置
-
-```typescript
-interface IEditorOption {
-  mode?: EditorMode // 编辑器模式：编辑、清洁（不显示视觉辅助元素。如：分页符）、只读、表单（仅控件内可编辑）、打印（不显示辅助元素、未书写控件及前后括号）、设计模式（不可删除、只读等配置不控制）、涂鸦模式（屏蔽选区、允许长按移动绘制线条）。默认：编辑
-  locale?: string // 多语言类型。默认：zhCN
-  defaultType?: string // 默认元素类型。默认：TEXT
-  defaultColor?: string // 默认字体颜色。默认：#000000
-  defaultFont?: string // 默认字体。默认：Microsoft YaHei
-  defaultSize?: number // 默认字号。默认：16
-  minSize?: number // 最小字号。默认：5
-  maxSize?: number // 最大字号。默认：72
-  defaultBasicRowMarginHeight?: number // 默认行高。默认：8
-  defaultRowMargin?: number // 默认行间距。默认：1
-  defaultTabWidth?: number // 默认tab宽度。默认：32
-  width?: number // 纸张宽度。默认：794
-  height?: number // 纸张高度。默认：1123
-  scale?: number // 缩放比例。默认：1
-  pageGap?: number // 纸张间隔。默认：20
-  underlineColor?: string // 下划线颜色。默认：#000000
-  strikeoutColor?: string // 删除线颜色。默认：#FF0000
-  rangeColor?: string // 选区颜色。默认：#AECBFA
-  rangeAlpha?: number // 选区透明度。默认：0.6
-  rangeMinWidth?: number // 选区最小宽度。默认：5
-  searchMatchColor?: string // 搜索高亮颜色。默认：#FFFF00
-  searchNavigateMatchColor?: string // 搜索导航高亮颜色。默认：#AAD280
-  searchMatchAlpha?: number // 搜索高亮透明度。默认：0.6
-  highlightAlpha?: number // 高亮元素透明度。默认：0.6
-  highlightMarginHeight?: number // 高亮元素边距高度。默认：8
-  resizerColor?: string // 图片尺寸器颜色。默认：#4182D9
-  resizerSize?: number // 图片尺寸器大小。默认：5
-  marginIndicatorSize?: number // 页边距指示器长度。默认：35
-  marginIndicatorColor?: string // 页边距指示器颜色。默认：#BABABA
-  margins?: IMargin // 页面边距。默认：[100, 120, 100, 120]
-  pageMode?: PageMode // 纸张模式：连页、分页。默认：分页
-  renderMode?: RenderMode // 渲染模式：极速（多个字组合渲染）、兼容（逐字渲染：避免浏览器字体等环境差异）。默认：极速
-  defaultHyperlinkColor?: string // 默认超链接颜色。默认：#0000FF
-  table?: ITableOption // 表格配置。{tdPadding?:IPadding; defaultTrMinHeight?:number; defaultColMinWidth?:number}
-  header?: IHeader // 页眉信息。{top?:number; maxHeightRadio?:MaxHeightRatio;}
-  footer?: IFooter // 页脚信息。{bottom?:number; maxHeightRadio?:MaxHeightRatio;}
-  pageNumber?: IPageNumber // 页码信息。{bottom:number; size:number; font:string; color:string; rowFlex:RowFlex; format:string; numberType:NumberType;}
-  paperDirection?: PaperDirection // 纸张方向：纵向、横向
-  inactiveAlpha?: number // 正文内容失焦时透明度。默认值：0.6
-  historyMaxRecordCount?: number // 历史（撤销重做）最大记录次数。默认：100次
-  printPixelRatio?: number // 打印像素比率（值越大越清晰，但尺寸越大）。默认：3
-  maskMargin?: IMargin // 编辑器上的遮盖边距（如悬浮到编辑器上的菜单栏、底部工具栏）。默认：[0, 0, 0, 0]
-  letterClass?: string[] // 排版支持的字母类。默认：a-zA-Z。内置可选择的字母表类：LETTER_CLASS
-  contextMenuDisableKeys?: string[] // 禁用的右键菜单。默认：[]
-  shortcutDisableKeys?: string[] // 禁用的快捷键。默认：[]
-  scrollContainerSelector?: string // 滚动区域选择器。默认：document
-  pageOuterSelectionDisable?: boolean // 鼠标移出页面时选区禁用。默认：false
-  wordBreak?: WordBreak // 单词与标点断行：BREAK_WORD首行不出现标点&单词不拆分、BREAK_ALL按字符宽度撑满后折行。默认：BREAK_WORD
-  watermark?: IWatermark // 水印信息。{data:string; color?:string; opacity?:number; size?:number; font?:string; numberType:NumberType;}
-  control?: IControlOption // 控件信息。 {placeholderColor?:string; bracketColor?:string; prefix?:string; postfix?:string; borderWidth?: number; borderColor?: string; activeBackgroundColor?: string; disabledBackgroundColor?: string; existValueBackgroundColor?: string; noValueBackgroundColor?: string;}
-  checkbox?: ICheckboxOption // 复选框信息。{width?:number; height?:number; gap?:number; lineWidth?:number; fillStyle?:string; strokeStyle?: string; verticalAlign?: VerticalAlign;}
-  radio?: IRadioOption // 单选框信息。{width?:number; height?:number; gap?:number; lineWidth?:number; fillStyle?:string; strokeStyle?: string; verticalAlign?: VerticalAlign;}
-  cursor?: ICursorOption // 光标样式。{width?: number; color?: string; dragWidth?: number; dragColor?: string; dragFloatImageDisabled?: boolean;}
-  title?: ITitleOption // 标题配置。{ defaultFirstSize?: number; defaultSecondSize?: number; defaultThirdSize?: number defaultFourthSize?: number; defaultFifthSize?: number; defaultSixthSize?: number;}
-  placeholder?: IPlaceholder // 编辑器空白占位文本
-  group?: IGroup // 成组配置。{opacity?:number; backgroundColor?:string; activeOpacity?:number; activeBackgroundColor?:string; disabled?:boolean; deletable?:boolean;}
-  pageBreak?: IPageBreak // 分页符配置。{font?:string; fontSize?:number; lineDash?:number[];}
-  zone?: IZoneOption // 编辑器区域配置。{tipDisabled?:boolean;}
-  background?: IBackgroundOption // 背景配置。{color?:string; image?:string; size?:BackgroundSize; repeat?:BackgroundRepeat; applyPageNumbers?:number[]}。默认：{color: '#FFFFFF'}
-  lineBreak?: ILineBreakOption // 换行符配置。{disabled?:boolean; color?:string; lineWidth?:number;}
-  whiteSpace?: IWhiteSpaceOption // 空格符配置。{disabled?:boolean; color?:string; radius?:number;}
-  separator?: ISeparatorOption // 分隔符配置。{lineWidth?:number; strokeStyle?:string;}
-  lineNumber?: ILineNumberOption // 行号配置。{size?:number; font?:string; color?:string; disabled?:boolean; right?:number}
-  pageBorder?: IPageBorderOption // 页面边框配置。{color?:string; lineWidth:number; padding?:IPadding; disabled?:boolean;}
-  badge?: IBadgeOption // 徽章配置。{top?:number; left?:number}
-  modeRule?: IModeRule // 编辑器模式规则配置。{print:{imagePreviewerDisabled?: boolean;backgroundDisabled?: boolean;}; readonly:{imagePreviewerDisabled?: boolean}; form:{controlDeletableDisabled?: boolean}}
-  graffiti?: IGraffitiOption // 涂鸦模式配置。{defaultLineWidth?: number; defaultLineColor?: string}
-  label?: ILabelOption // 标签配置。{defaultColor?:string; defaultBackgroundColor?:string; defaultBorderRadius?:number; defaultPadding?:IPadding}
-  imgCaption?: IImgCaptionOption // 图片题注配置。{color?:string; font?:string; size?:number; top?:number}
-  list?: IListOption // 列表配置。{inheritStyle?:boolean}
-}
-```
-
-## 表格配置
-
-```typescript
-interface ITableOption {
-  tdPadding?: IPadding // 单元格内边距。默认：[0, 5, 5, 5]
-  defaultTrMinHeight?: number // 默认表格行最小高度。默认：42
-  defaultColMinWidth?: number // 默认表格列最小宽度（整体宽度足够时应用，否则会按比例缩小）。默认：40
-  overflow?: boolean // 是否允许表格超出正文区域。默认：true
-}
-```
-
-## 页眉配置
-
-```typescript
-interface IHeader {
-  top?: number // 距离页面顶部大小。默认：30
-  inactiveAlpha?: number // 失活时透明度。默认：1
-  maxHeightRadio?: MaxHeightRatio // 占页面最大高度比。默认：HALF
-  disabled?: boolean // 是否禁用
-  editable?: boolean // 禁止编辑标题内容
-}
-```
-
-## 页脚配置
-
-```typescript
-interface IFooter {
-  bottom?: number // 距离页面底部大小。默认：30
-  inactiveAlpha?: number // 失活时透明度。默认：1
-  maxHeightRadio?: MaxHeightRatio // 占页面最大高度比。默认：HALF
-  disabled?: boolean // 是否禁用
-  editable?: boolean // 禁止编辑页脚内容
-}
-```
-
-## 页码配置
-
-```typescript
-interface IPageNumber {
-  bottom?: number // 距离页面底部大小。默认：60
-  size?: number // 字体大小。默认：12
-  font?: string // 字体。默认：Microsoft YaHei
-  color?: string // 字体颜色。默认：#000000
-  rowFlex?: RowFlex // 行对齐方式。默认：CENTER
-  format?: string // 页码格式。默认：{pageNo}。示例：第{pageNo}页/共{pageCount}页
-  numberType?: NumberType // 数字类型。默认：ARABIC
-  disabled?: boolean // 是否禁用
-  startPageNo?: number // 起始页码。默认：1
-  fromPageNo?: number // 从第几页开始出现页码。默认：0
-  maxPageNo?: number | null // 最大页码（从0开始）。默认：null
-}
-```
-
-## 水印配置
-
-```typescript
-interface IWatermark {
-  data: string // 文本。
-  type?: WatermarkType
-  width?: number
-  height?: number
-  color?: string // 颜色。默认：#AEB5C0
-  opacity?: number // 透明度。默认：0.3
-  size?: number // 字体大小。默认：200
-  font?: string // 字体。默认：Microsoft YaHei
-  repeat?: boolean // 重复水印。默认：false
-  gap?: [horizontal: number, vertical: number] // 水印间距。默认：[10,10]
-  numberType: NumberType.ARABIC // 页码格式。默认：{pageNo}。示例：第{pageNo}页/共{pageCount}页
-}
-```
-
-## 占位文本配置
-
-```typescript
-interface IPlaceholder {
-  data: string // 文本。
-  color?: string // 颜色。默认：#DCDFE6
-  opacity?: number // 透明度。默认：1
-  size?: number // 字体大小。默认：16
-  font?: string // 字体。默认：Microsoft YaHei
-}
-```
-
-## 行号配置
-
-```typescript
-interface ILineNumberOption {
-  size?: number // 字体大小。默认：12
-  font?: string // 字体。默认：Microsoft YaHei
-  color?: string // 颜色。默认：#000000
-  disabled?: boolean // 是否禁用。默认：true
-  right?: number // 距离正文距离。默认：20
-  type?: LineNumberType // 编号类型（每页重新编号、连续编号）。默认：连续编号
-}
-```
-
-## 页面边框配置
-
-```typescript
-interface IPageBorderOption {
-  color?: string // 颜色。默认：#000000
-  lineWidth?: number // 宽度。默认：1
-  padding?: IPadding // 距离正文内边距。默认：[0, 5, 0, 5]
-  disabled?: boolean // 是否禁用。默认：true
-}
-```
-
-## 标签配置
-
-```typescript
-interface ILabelOption {
-  defaultColor?: string // 默认标签文本颜色
-  defaultBackgroundColor?: string // 默认标签背景颜色
-  defaultBorderRadius?: number // 默认标签边框半径
-  defaultPadding?: IPadding // 默认标签内边距
-}
-```
-
-## 列表配置
-
-```typescript
-interface IListOption {
-  inheritStyle?: boolean // 是否让列表序号继承文字样式。默认：false
-}
-```

package/docs/guide/override.md

@@ -1,57 +0,0 @@
-# 重写方法
-
-## 使用方式
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-
-const instance = new Editor(container, <IElement[]>data, options)
-
-instance.override.overrideFunction = () => unknown | IOverrideResult
-```
-
-```typescript
-interface IOverrideResult {
-  preventDefault?: boolean // 阻止执行内部默认方法。默认阻止
-}
-```
-
-## paste
-
-功能：重写粘贴方法
-
-用法：
-
-```javascript
-instance.override.paste = (evt?: ClipboardEvent) => unknown | IOverrideResult
-```
-
-## pasteImage
-
-功能：重写粘贴图片方法
-
-用法：
-
-```javascript
-instance.override.pasteImage = (file: File | Blob) => unknown | IOverrideResult
-```
-
-## copy
-
-功能：重写复制方法
-
-用法：
-
-```javascript
-instance.override.copy = () => unknown | IOverrideResult
-```
-
-## drop
-
-功能：重写拖放方法
-
-用法：
-
-```javascript
-instance.override.drop = (evt: DragEvent) => unknown | IOverrideResult
-```

package/docs/guide/plugin-custom.md

@@ -1,25 +0,0 @@
-# 自定义插件
-
-::: tip
-官方维护插件仓库：https://github.com/Hufe921/canvas-editor-plugin
-:::
-
-## 开发插件
-
-```javascript
-export function myPlugin(editor: Editor, options?: Option) {
-  // 1. 修改方法，详见：src/plugins/copy
-  editor.command.updateFunction = () => {}
-
-  // 2. 增加方法，详见：src/plugins/markdown
-  editor.command.addFunction = () => {}
-
-  // 3. 事件监听、快捷键、右键菜单、重写方法等组合处理
-}
-```
-
-## 使用插件
-
-```javascript
-instance.use(myPlugin, options?: Option)
-```

package/docs/guide/plugin-internal.md

@@ -1,125 +0,0 @@
-# 官方插件
-
-::: tip
-官方维护插件仓库：https://github.com/Hufe921/canvas-editor-plugin
-
-官方维护插件演示地址：https://hufe.club/canvas-editor-plugin
-:::
-
-## 条形码
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-import barcode1DPlugin from "@hufe921/canvas-editor-plugin-barcode1d"
-
-const instance = new Editor()
-instance.use(barcode1DPlugin)
-
-instance.executeInsertBarcode1D(
-  content: string,
-  width: number,
-  height: number,
-  options?: JsBarcode.Options
-)
-```
-
-## 二维码
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-import barcode2DPlugin from "@hufe921/canvas-editor-plugin-barcode2d"
-
-const instance = new Editor()
-instance.use(barcode2DPlugin, options?: IBarcode2DOption)
-
-instance.executeInsertBarcode2D(
-  content: string,
-  width: number,
-  height: number,
-  hints?: Map<EncodeHintType, any>
-)
-```
-
-## 代码块
-
-```javascript
-import Editor from "@hufe921/canvas-editor"
-import codeblockPlugin from "@hufe921/canvas-editor-plugin-codeblock"
-
-const instance = new Editor()
-instance.use(codeblockPlugin)
-
-instance.executeInsertCodeblock(content: string)
-```
-
-## Word
-
-```javascript
-import Editor from '@hufe921/canvas-editor'
-import docxPlugin from '@hufe921/canvas-editor-plugin-docx'
-
-const instance = new Editor()
-instance.use(docxPlugin)
-
-command.executeImportDocx({
-  arrayBuffer: buffer
-})
-
-instance.executeExportDocx({
-  fileName: string
-})
-```
-
-## Excel
-
-```javascript
-import Editor from '@hufe921/canvas-editor'
-import excelPlugin from '@hufe921/canvas-editor-plugin-excel'
-
-const instance = new Editor()
-instance.use(excelPlugin)
-
-command.executeImportExcel({
-  arrayBuffer: buffer
-})
-```
-
-## 悬浮工具
-
-```javascript
-import Editor from '@hufe921/canvas-editor'
-import floatingToolbarPlugin from '@hufe921/canvas-editor-plugin-floating-toolbar'
-
-const instance = new Editor()
-instance.use(floatingToolbarPlugin)
-```
-
-## 流程图
-
-```javascript
-import Editor from '@hufe921/canvas-editor'
-import diagramPlugin from '@hufe921/canvas-editor-plugin-diagram'
-
-const instance = new Editor()
-instance.use(diagramPlugin)
-
-command.executeLoadDiagram({
-  lang?: Lang
-  data?: string
-  onDestroy?: (message?: any) => void
-})
-```
-
-## 大小写转换
-
-```javascript
-import Editor from '@hufe921/canvas-editor'
-import casePlugin from '@hufe921/canvas-editor-plugin-case'
-
-const instance = new Editor()
-instance.use(casePlugin)
-
-command.executeUpperCase()
-
-command.executeLowerCase()
-```