editor-svg 1.0.0

package/src/editor/interface/Element.ts

@@ -0,0 +1,273 @@
+import { ImageDisplay } from '../dataset/enum/Common'
+import { ControlComponent } from '../dataset/enum/Control'
+import { ElementType } from '../dataset/enum/Element'
+import { ListStyle, ListType } from '../dataset/enum/List'
+import { RowFlex } from '../dataset/enum/Row'
+import { TitleLevel } from '../dataset/enum/Title'
+import { TableBorder } from '../dataset/enum/table/Table'
+import { IArea } from './Area'
+import { IBlock } from './Block'
+import { ICheckbox } from './Checkbox'
+import { IPadding } from './Common'
+import { IControl } from './Control'
+import { IRadio } from './Radio'
+import { ITextDecoration } from './Text'
+import { ITitle } from './Title'
+import { IColgroup } from './table/Colgroup'
+import { ITr } from './table/Tr'
+
+export interface IElementBasic {
+  id?: string
+  type?: ElementType
+  value: string
+  extension?: unknown
+  externalId?: string
+}
+
+export interface IElementStyle {
+  font?: string
+  size?: number
+  width?: number
+  height?: number
+  bold?: boolean
+  color?: string
+  highlight?: string
+  italic?: boolean
+  underline?: boolean
+  strikeout?: boolean
+  rowFlex?: RowFlex
+  rowMargin?: number
+  letterSpacing?: number
+  textDecoration?: ITextDecoration
+}
+
+export interface IElementRule {
+  hide?: boolean
+}
+
+export interface IElementGroup {
+  groupIds?: string[]
+}
+
+export interface ITitleElement {
+  valueList?: IElement[]
+  level?: TitleLevel
+  titleId?: string
+  title?: ITitle
+}
+
+export interface IListElement {
+  valueList?: IElement[]
+  listType?: ListType
+  listStyle?: ListStyle
+  listId?: string
+  listWrap?: boolean
+}
+
+export interface ITableAttr {
+  colgroup?: IColgroup[]
+  trList?: ITr[]
+  borderType?: TableBorder
+  borderColor?: string
+  borderWidth?: number
+  borderExternalWidth?: number
+  translateX?: number
+}
+
+export interface ITableRule {
+  tableToolDisabled?: boolean
+}
+
+export interface ITableElement {
+  tdId?: string
+  trId?: string
+  tableId?: string
+  conceptId?: string
+  pagingId?: string // 用于区分拆分的表格同属一个源表格
+  pagingIndex?: number // 拆分的表格索引
+}
+
+export type ITable = ITableAttr & ITableRule & ITableElement
+
+export interface IHyperlinkElement {
+  valueList?: IElement[]
+  url?: string
+  hyperlinkId?: string
+}
+
+export interface ISuperscriptSubscript {
+  actualSize?: number
+}
+
+export interface ISeparator {
+  dashArray?: number[]
+  lineWidth?: number
+}
+
+export interface IControlElement {
+  control?: IControl
+  controlId?: string
+  controlComponent?: ControlComponent
+}
+
+export interface ICheckboxElement {
+  checkbox?: ICheckbox
+}
+
+export interface IRadioElement {
+  radio?: IRadio
+}
+
+export interface ILaTexElement {
+  laTexSVG?: string
+}
+
+export interface IDateElement {
+  dateFormat?: string
+  dateId?: string
+}
+
+export interface IImageRule {
+  imgToolDisabled?: boolean
+  imgPreviewDisabled?: boolean
+}
+
+export interface IImageCrop {
+  x: number
+  y: number
+  width: number
+  height: number
+}
+
+export interface IImageCaption {
+  value: string
+  color?: string
+  font?: string
+  size?: number
+  top?: number
+}
+
+export interface IImgCaptionOption {
+  color?: string
+  font?: string
+  size?: number
+  top?: number
+}
+
+export interface IListOption {
+  inheritStyle?: boolean // 是否让列表序号继承文字样式
+}
+
+export interface IImageBasic {
+  imgDisplay?: ImageDisplay
+  imgFloatPosition?: {
+    x: number
+    y: number
+    pageNo?: number
+  }
+  imgCrop?: IImageCrop
+  imgCaption?: IImageCaption
+}
+
+export type IImageElement = IImageBasic & IImageRule
+
+export interface IBlockElement {
+  block?: IBlock
+}
+
+export interface IAreaElement {
+  valueList?: IElement[]
+  areaId?: string
+  areaIndex?: number
+  area?: IArea
+}
+
+export interface ILabelElement {
+  labelId?: string
+  label?: {
+    color?: string
+    backgroundColor?: string
+    borderRadius?: number
+    padding?: IPadding
+  }
+}
+
+export type IElement = IElementBasic &
+  IElementStyle &
+  IElementRule &
+  IElementGroup &
+  ITable &
+  IHyperlinkElement &
+  ISuperscriptSubscript &
+  ISeparator &
+  IControlElement &
+  ICheckboxElement &
+  IRadioElement &
+  ILaTexElement &
+  IDateElement &
+  IImageElement &
+  IBlockElement &
+  ITitleElement &
+  IListElement &
+  IAreaElement &
+  ILabelElement
+
+export interface IElementMetrics {
+  width: number
+  height: number
+  boundingBoxAscent: number
+  boundingBoxDescent: number
+}
+
+export interface IElementPosition {
+  pageNo: number
+  index: number
+  value: string
+  rowIndex: number
+  rowNo: number
+  ascent: number
+  lineHeight: number
+  left: number
+  metrics: IElementMetrics
+  isFirstLetter: boolean
+  isLastLetter: boolean
+  coordinate: {
+    leftTop: number[]
+    leftBottom: number[]
+    rightTop: number[]
+    rightBottom: number[]
+  }
+}
+
+export interface IElementFillRect {
+  x: number
+  y: number
+  width: number
+  height: number
+}
+
+export interface IUpdateElementByIdOption {
+  id?: string
+  conceptId?: string
+  properties: Omit<Partial<IElement>, 'id'>
+}
+
+export interface IDeleteElementByIdOption {
+  id?: string
+  conceptId?: string
+}
+
+export interface IGetElementByIdOption {
+  id?: string
+  conceptId?: string
+}
+
+export interface IInsertElementListOption {
+  isReplace?: boolean
+  isSubmitHistory?: boolean
+  ignoreContextKeys?: Array<keyof IElement>
+}
+
+export interface ISpliceElementListOption {
+  isIgnoreDeletedRule?: boolean
+}

package/src/editor/interface/Event.ts

@@ -0,0 +1,27 @@
+import { IElement } from './Element'
+import { RangeRect } from './Range'
+
+export interface IPasteOption {
+  isPlainText: boolean
+}
+
+export interface ITableInfoByEvent {
+  element: IElement
+  trIndex: number
+  tdIndex: number
+}
+
+export interface IPositionContextByEventResult {
+  pageNo: number
+  element: IElement | null
+  rangeRect: RangeRect | null
+  tableInfo: ITableInfoByEvent | null
+}
+
+export interface IPositionContextByEventOption {
+  isMustDirectHit?: boolean
+}
+
+export interface ICopyOption {
+  isPlainText: boolean
+}

package/src/editor/interface/EventBus.ts

@@ -0,0 +1,46 @@
+import {
+  IContentChange,
+  IControlChange,
+  IControlContentChange,
+  IImageDblclick,
+  IImageMousedown,
+  IImageSizeChange,
+  IInputEventChange,
+  IIntersectionPageNoChange,
+  ILabelMousedown,
+  IMouseEventChange,
+  IPageModeChange,
+  IPageScaleChange,
+  IPageSizeChange,
+  IPositionContextChange,
+  IRangeStyleChange,
+  ISaved,
+  IVisiblePageNoListChange,
+  IZoneChange
+} from './Listener'
+
+export interface EventBusMap {
+  rangeStyleChange: IRangeStyleChange
+  visiblePageNoListChange: IVisiblePageNoListChange
+  intersectionPageNoChange: IIntersectionPageNoChange
+  pageSizeChange: IPageSizeChange
+  pageScaleChange: IPageScaleChange
+  saved: ISaved
+  contentChange: IContentChange
+  controlChange: IControlChange
+  controlContentChange: IControlContentChange
+  pageModeChange: IPageModeChange
+  zoneChange: IZoneChange
+  mousemove: IMouseEventChange
+  mouseleave: IMouseEventChange
+  mouseenter: IMouseEventChange
+  mousedown: IMouseEventChange
+  mouseup: IMouseEventChange
+  click: IMouseEventChange
+  input: IInputEventChange
+  positionContextChange: IPositionContextChange
+  imageSizeChange: IImageSizeChange
+  imageMousedown: IImageMousedown
+  imageDblclick: IImageDblclick
+  labelMousedown: ILabelMousedown
+}

package/src/editor/interface/Footer.ts

@@ -0,0 +1,9 @@
+import { MaxHeightRatio } from '../dataset/enum/Common'
+
+export interface IFooter {
+  bottom?: number
+  inactiveAlpha?: number
+  maxHeightRadio?: MaxHeightRatio
+  disabled?: boolean
+  editable?: boolean
+}

package/src/editor/interface/Graffiti.ts

@@ -0,0 +1,15 @@
+export interface IGraffitiStroke {
+  lineWidth?: number
+  lineColor?: string
+  points: number[]
+}
+
+export interface IGraffitiData {
+  pageNo: number
+  strokes: IGraffitiStroke[]
+}
+
+export interface IGraffitiOption {
+  defaultLineWidth?: number
+  defaultLineColor?: string
+}

package/src/editor/interface/Group.ts

@@ -0,0 +1,8 @@
+export interface IGroup {
+  opacity?: number
+  backgroundColor?: string
+  activeOpacity?: number
+  activeBackgroundColor?: string
+  disabled?: boolean
+  deletable?: boolean
+}

package/src/editor/interface/Header.ts

@@ -0,0 +1,9 @@
+import { MaxHeightRatio } from '../dataset/enum/Common'
+
+export interface IHeader {
+  top?: number
+  inactiveAlpha?: number
+  maxHeightRadio?: MaxHeightRatio
+  disabled?: boolean
+  editable?: boolean
+}

package/src/editor/interface/Label.ts

@@ -0,0 +1,8 @@
+import { IPadding } from './Common'
+
+export interface ILabelOption {
+  defaultColor?: string
+  defaultBackgroundColor?: string
+  defaultBorderRadius?: number
+  defaultPadding?: IPadding
+}

package/src/editor/interface/LineBreak.ts

@@ -0,0 +1,5 @@
+export interface ILineBreakOption {
+  disabled?: boolean
+  color?: string
+  lineWidth?: number
+}

package/src/editor/interface/LineNumber.ts

@@ -0,0 +1,10 @@
+import { LineNumberType } from '../dataset/enum/LineNumber'
+
+export interface ILineNumberOption {
+  size?: number
+  font?: string
+  color?: string
+  disabled?: boolean
+  right?: number
+  type?: LineNumberType
+}

package/src/editor/interface/Listener.ts

@@ -0,0 +1,88 @@
+import { EditorZone, PageMode } from '../dataset/enum/Editor'
+import { ElementType } from '../dataset/enum/Element'
+import { ListStyle, ListType } from '../dataset/enum/List'
+import { RowFlex } from '../dataset/enum/Row'
+import { TitleLevel } from '../dataset/enum/Title'
+import { IControlChangeResult, IControlContentChangeResult } from './Control'
+import { IEditorResult } from './Editor'
+import { IElement } from './Element'
+import { IPositionContext } from './Position'
+import { ITextDecoration } from './Text'
+
+export interface IRangeStyle {
+  type: ElementType | null
+  undo: boolean
+  redo: boolean
+  painter: boolean
+  font: string
+  size: number
+  bold: boolean
+  italic: boolean
+  underline: boolean
+  strikeout: boolean
+  color: string | null
+  highlight: string | null
+  rowFlex: RowFlex | null
+  rowMargin: number
+  dashArray: number[]
+  level: TitleLevel | null
+  listType: ListType | null
+  listStyle: ListStyle | null
+  groupIds: string[] | null
+  textDecoration: ITextDecoration | null
+  extension?: unknown | null
+}
+
+export type IRangeStyleChange = (payload: IRangeStyle) => void
+
+export type IVisiblePageNoListChange = (payload: number[]) => void
+
+export type IIntersectionPageNoChange = (payload: number) => void
+
+export type IPageSizeChange = (payload: number) => void
+
+export type IPageScaleChange = (payload: number) => void
+
+export type ISaved = (payload: IEditorResult) => void
+
+export type IContentChange = () => void
+
+export type IControlChange = (payload: IControlChangeResult) => void
+
+export type IControlContentChange = (
+  payload: IControlContentChangeResult
+) => void
+
+export type IPageModeChange = (payload: PageMode) => void
+
+export type IZoneChange = (payload: EditorZone) => void
+
+export type IMouseEventChange = (evt: MouseEvent) => void
+
+export type IInputEventChange = (evt: Event) => void
+
+export interface IPositionContextChangePayload {
+  value: IPositionContext
+  oldValue: IPositionContext
+}
+
+export type IPositionContextChange = (
+  payload: IPositionContextChangePayload
+) => void
+
+export type IImageSizeChange = (payload: { element: IElement }) => void
+
+export type IImageMousedown = (payload: {
+  evt: MouseEvent
+  element: IElement
+}) => void
+
+export type IImageDblclick = (payload: {
+  evt: MouseEvent
+  element: IElement
+}) => void
+
+export type ILabelMousedown = (payload: {
+  evt: MouseEvent
+  element: IElement
+}) => void

package/src/editor/interface/Margin.ts

@@ -0,0 +1 @@
+export type IMargin = [top: number, right: number, bottom: number, left: number]

package/src/editor/interface/PageBorder.ts

@@ -0,0 +1,8 @@
+import { IPadding } from './Common'
+
+export interface IPageBorderOption {
+  color?: string
+  lineWidth?: number
+  padding?: IPadding
+  disabled?: boolean
+}

package/src/editor/interface/PageBreak.ts

@@ -0,0 +1,5 @@
+export interface IPageBreak {
+  font?: string
+  fontSize?: number
+  lineDash?: number[]
+}

package/src/editor/interface/PageNumber.ts

@@ -0,0 +1,16 @@
+import { NumberType } from '../dataset/enum/Common'
+import { RowFlex } from '../dataset/enum/Row'
+
+export interface IPageNumber {
+  bottom?: number
+  size?: number
+  font?: string
+  color?: string
+  rowFlex?: RowFlex
+  format?: string
+  numberType?: NumberType
+  disabled?: boolean
+  startPageNo?: number
+  fromPageNo?: number
+  maxPageNo?: number | null
+}

package/src/editor/interface/Placeholder.ts

@@ -0,0 +1,7 @@
+export interface IPlaceholder {
+  data: string
+  color?: string
+  opacity?: number
+  size?: number
+  font?: string
+}

package/src/editor/interface/Plugin.ts

@@ -0,0 +1,8 @@
+import Editor from '..'
+
+export type PluginFunction<Options> = (editor: Editor, options?: Options) => void
+
+export type UsePlugin = <Options>(
+  pluginFunction: PluginFunction<Options>,
+  options?: Options
+) => void

package/src/editor/interface/Position.ts

@@ -0,0 +1,113 @@
+import { ImageDisplay } from '../dataset/enum/Common'
+import { EditorZone } from '../dataset/enum/Editor'
+import { IElement, IElementFillRect, IElementPosition } from './Element'
+import { IRange } from './Range'
+import { IRow, IRowElement } from './Row'
+import { ITd } from './table/Td'
+
+export interface ICurrentPosition {
+  index: number
+  x?: number
+  y?: number
+  isCheckbox?: boolean
+  isRadio?: boolean
+  isControl?: boolean
+  isImage?: boolean
+  isLabel?: boolean
+  isTable?: boolean
+  isDirectHit?: boolean
+  trIndex?: number
+  tdIndex?: number
+  tdValueIndex?: number
+  tdId?: string
+  trId?: string
+  tableId?: string
+  zone?: EditorZone
+  hitLineStartIndex?: number
+}
+
+export interface IGetPositionByXYPayload {
+  x: number
+  y: number
+  pageNo?: number
+  isTable?: boolean
+  td?: ITd
+  tablePosition?: IElementPosition
+  elementList?: IElement[]
+  positionList?: IElementPosition[]
+}
+
+export type IGetFloatPositionByXYPayload = IGetPositionByXYPayload & {
+  imgDisplays: ImageDisplay[]
+}
+
+export interface IPositionContext {
+  isTable: boolean
+  isCheckbox?: boolean
+  isRadio?: boolean
+  isControl?: boolean
+  isImage?: boolean
+  isLabel?: boolean
+  isDirectHit?: boolean
+  index?: number
+  trIndex?: number
+  tdIndex?: number
+  tdId?: string
+  trId?: string
+  tableId?: string
+}
+
+export interface IComputeRowPositionPayload {
+  row: IRow
+  innerWidth: number
+}
+
+export interface IComputePageRowPositionPayload {
+  positionList: IElementPosition[]
+  rowList: IRow[]
+  pageNo: number
+  startRowIndex: number
+  startIndex: number
+  startX: number
+  startY: number
+  innerWidth: number
+  isTable?: boolean
+  index?: number
+  tdIndex?: number
+  trIndex?: number
+  tdValueIndex?: number
+  zone?: EditorZone
+}
+
+export interface IComputePageRowPositionResult {
+  x: number
+  y: number
+  index: number
+}
+
+export interface IFloatPosition {
+  pageNo: number
+  element: IElement
+  position: IElementPosition
+  isTable?: boolean
+  index?: number
+  tdIndex?: number
+  trIndex?: number
+  tdValueIndex?: number
+  zone?: EditorZone
+}
+
+export interface ILocationPosition {
+  zone: EditorZone
+  range: IRange
+  positionContext: IPositionContext
+}
+
+export interface ISetSurroundPositionPayload {
+  row: IRow
+  rowElement: IRowElement
+  rowElementRect: IElementFillRect
+  pageNo: number
+  availableWidth: number
+  surroundElementList: IElement[]
+}

package/src/editor/interface/Previewer.ts

@@ -0,0 +1,15 @@
+import { IElement } from './Element'
+
+export interface IPreviewerCreateResult {
+  resizerSelection: HTMLDivElement
+  resizerHandleList: HTMLDivElement[]
+  resizerImageContainer: HTMLDivElement
+  resizerImage: HTMLImageElement
+  resizerSize: HTMLSpanElement
+}
+
+export interface IPreviewerDrawOption {
+  mime?: 'png' | 'jpg' | 'jpeg' | 'svg'
+  srcKey?: keyof Pick<IElement, 'value' | 'laTexSVG'>
+  dragDisable?: boolean
+}