@hufe921/canvas-editor 1.0.1 → 1.0.3

package/dist/src/editor/core/command/Command.d.ts

@@ -64,6 +64,7 @@ export declare class Command {
     executeAddWatermark: CommandAdapt['addWatermark'];
     executeDeleteWatermark: CommandAdapt['deleteWatermark'];
     executeSearch: CommandAdapt['search'];
+    executeSetSpellcheckRangeList: CommandAdapt['setSpellcheckRangeList'];
     executeSearchNavigatePre: CommandAdapt['searchNavigatePre'];
     executeSearchNavigateNext: CommandAdapt['searchNavigateNext'];
     executeReplace: CommandAdapt['replace'];
@@ -133,6 +134,7 @@ export declare class Command {
     getAreaValue: CommandAdapt['getAreaValue'];
     getHTML: CommandAdapt['getHTML'];
     getText: CommandAdapt['getText'];
+    getSpellcheckWordList: CommandAdapt['getSpellcheckWordList'];
     getWordCount: CommandAdapt['getWordCount'];
     getCursorPosition: CommandAdapt['getCursorPosition'];
     getRemainingContentHeight: CommandAdapt['getRemainingContentHeight'];
@@ -141,6 +143,7 @@ export declare class Command {
     getRangeContext: CommandAdapt['getRangeContext'];
     getRangeRow: CommandAdapt['getRangeRow'];
     getRangeParagraph: CommandAdapt['getRangeParagraph'];
+    getSurroundElementList: CommandAdapt['getSurroundElementList'];
     getKeywordRangeList: CommandAdapt['getKeywordRangeList'];
     getKeywordContext: CommandAdapt['getKeywordContext'];
     getPaperMargin: CommandAdapt['getPaperMargin'];
@@ -148,6 +151,7 @@ export declare class Command {
     getSearchNavigateInfo: CommandAdapt['getSearchNavigateInfo'];
     getLocale: CommandAdapt['getLocale'];
     getGroupIds: CommandAdapt['getGroupIds'];
+    getGroupRectList: CommandAdapt['getGroupRectList'];
     getControlValue: CommandAdapt['getControlValue'];
     getControlList: CommandAdapt['getControlList'];
     getContainer: CommandAdapt['getContainer'];

package/dist/src/editor/core/command/CommandAdapt.d.ts

@@ -16,8 +16,9 @@ import { IColumnOption } from '../../interface/Column';
 import { IDeleteElementByIdOption, IElement, IElementPosition, IGetElementByIdOption, IImageCaption, IImageCrop, IInsertElementListOption, IUpdateElementByIdOption } from '../../interface/Element';
 import { ICopyOption, IPasteOption, IPositionContextByEventOption, IPositionContextByEventResult } from '../../interface/Event';
 import { IMargin } from '../../interface/Margin';
-import { IRange, RangeContext } from '../../interface/Range';
+import { IGetSurroundElementListOption, IRange, RangeContext, RangeRect } from '../../interface/Range';
 import { IReplaceOption, ISearchOption, ISearchResultContext } from '../../interface/Search';
+import type { ISpellcheckRange } from '../../interface/Spellcheck';
 import { ITextDecoration } from '../../interface/Text';
 import { IGetTitleValueOption, IGetTitleValueResult } from '../../interface/Title';
 import { IWatermark } from '../../interface/Watermark';
@@ -109,6 +110,8 @@ export declare class CommandAdapt {
     deleteWatermark(): void;
     image(payload: IDrawImagePayload): string | null;
     search(payload: string | null, options?: ISearchOption): void;
+    setSpellcheckRangeList(payload: ISpellcheckRange[] | null): void;
+    getSpellcheckWordList(): import("../../interface/Spellcheck").ISpellcheckWord[];
     searchNavigatePre(): void;
     searchNavigateNext(): void;
     getSearchNavigateInfo(): null | INavigateInfo;
@@ -135,6 +138,7 @@ export declare class CommandAdapt {
     getRangeContext(): RangeContext | null;
     getRangeRow(): IElement[] | null;
     getRangeParagraph(): IElement[] | null;
+    getSurroundElementList(option?: IGetSurroundElementListOption): IElement[] | null;
     getKeywordRangeList(payload: string): IRange[];
     getKeywordContext(payload: string): ISearchResultContext[] | null;
     pageMode(payload: PageMode): void;
@@ -168,6 +172,7 @@ export declare class CommandAdapt {
     setGroup(): string | null;
     deleteGroup(groupId: string): void;
     getGroupIds(): Promise<string[]>;
+    getGroupRectList(groupId: string): RangeRect[] | null;
     locationGroup(groupId: string): void;
     setZone(zone: EditorZone): void;
     getControlValue(payload: IGetControlValueOption): IGetControlValueResult | null;

package/dist/src/editor/core/draw/Draw.d.ts

@@ -13,6 +13,7 @@ import { Listener } from '../listener/Listener';
 import { Position } from '../position/Position';
 import { RangeManager } from '../range/RangeManager';
 import { Search } from './interactive/Search';
+import { Spellcheck } from './interactive/Spellcheck';
 import { Strikeout } from './richtext/Strikeout';
 import { Underline } from './richtext/Underline';
 import { ImageParticle } from './particle/ImageParticle';
@@ -81,6 +82,7 @@ export declare class Draw {
     private badge;
     private magnifier;
     private search;
+    private spellcheck;
     private group;
     private area;
     private underline;
@@ -210,6 +212,7 @@ export declare class Draw {
     getCtx(): CanvasRenderingContext2D;
     getOptions(): DeepRequired<IEditorOption>;
     getSearch(): Search;
+    getSpellcheck(): Spellcheck;
     getGroup(): Group;
     getArea(): Area;
     getBadge(): Badge;

package/dist/src/editor/core/draw/interactive/Spellcheck.d.ts

@@ -0,0 +1,20 @@
+import type { ISpellcheckContext, ISpellcheckRange, ISpellcheckWord } from '../../../interface/Spellcheck';
+import type { Draw } from '../Draw';
+export declare class Spellcheck {
+    private options;
+    private draw;
+    private position;
+    private segmenter;
+    private spellcheckRangeList;
+    constructor(draw: Draw);
+    private _isElementHidden;
+    getSpellcheckRangeList(): ISpellcheckRange[];
+    private _appendWordList;
+    private _collectWordList;
+    getSpellcheckWordList(): ISpellcheckWord[];
+    setSpellcheckRangeList(payload: ISpellcheckRange[] | null): boolean;
+    private _isSameTablePath;
+    getRangeByIndex(index: number, context?: ISpellcheckContext): ISpellcheckRange | null;
+    private _drawWave;
+    render(ctx: CanvasRenderingContext2D, pageIndex: number): void;
+}

package/dist/src/editor/dataset/constant/Spellcheck.d.ts

@@ -0,0 +1,2 @@
+import type { ISpellcheckOption } from '../../interface/Spellcheck';
+export declare const defaultSpellcheckOption: Readonly<Required<ISpellcheckOption>>;

package/dist/src/editor/dataset/enum/Common.d.ts

@@ -20,6 +20,10 @@ export declare enum LocationPosition {
     OUTER_BEFORE = "outer-before",
     OUTER_AFTER = "outer-after"
 }
+export declare enum SurroundPosition {
+    BEFORE = "before",
+    AFTER = "after"
+}
 export declare enum FlexDirection {
     ROW = "row",
     COLUMN = "column"

package/dist/src/editor/index.d.ts

@@ -4,7 +4,7 @@ import { IElement } from './interface/Element';
 import { Command } from './core/command/Command';
 import { Listener } from './core/listener/Listener';
 import { RowFlex } from './dataset/enum/Row';
-import { FlexDirection, ImageDisplay, LocationPosition } from './dataset/enum/Common';
+import { FlexDirection, ImageDisplay, LocationPosition, SurroundPosition } from './dataset/enum/Common';
 import { ElementType } from './dataset/enum/Element';
 import { Register } from './core/register/Register';
 import { IContextMenuContext, IRegisterContextMenu } from './interface/contextmenu/ContextMenu';
@@ -32,7 +32,7 @@ import { IRangeStyle } from './interface/Listener';
 import { Override } from './core/override/Override';
 import { LETTER_CLASS } from './dataset/constant/Common';
 import { INTERNAL_CONTEXT_MENU_KEY } from './dataset/constant/ContextMenu';
-import { IRange } from './interface/Range';
+import { IRange, RangeRect } from './interface/Range';
 import { splitText } from './utils';
 import { createDomFromElementList, getElementListByHTML, getTextFromElementList, type IGetElementListByHTMLOption } from './utils/element';
 import { BackgroundRepeat, BackgroundSize } from './dataset/enum/Background';
@@ -56,5 +56,5 @@ export default class Editor {
 }
 export { splitText, createDomFromElementList, getElementListByHTML, getTextFromElementList };
 export { EDITOR_COMPONENT, LETTER_CLASS, INTERNAL_CONTEXT_MENU_KEY, INTERNAL_SHORTCUT_KEY, EDITOR_CLIPBOARD };
-export { Editor, RowFlex, VerticalAlign, EditorZone, EditorMode, ElementType, ControlType, EditorComponent, PageMode, RenderMode, ImageDisplay, Command, KeyMap, BlockType, MacroType, PaperDirection, TableBorder, TdBorder, TdSlash, MaxHeightRatio, NumberType, TitleLevel, ListType, ListStyle, WordBreak, ControlIndentation, ControlComponent, BackgroundRepeat, BackgroundSize, TextDecorationStyle, LineNumberType, LocationPosition, AreaMode, ControlState, FlexDirection, WatermarkType, WatermarkLayer };
-export type { IElement, IEditorData, IEditorOption, IEditorResult, IContextMenuContext, IRegisterContextMenu, IWatermark, INavigateInfo, IBlock, ILang, ICatalog, ICatalogItem, IRange, IRangeStyle, IBadge, IGetElementListByHTMLOption };
+export { Editor, RowFlex, VerticalAlign, EditorZone, EditorMode, ElementType, ControlType, EditorComponent, PageMode, RenderMode, ImageDisplay, Command, KeyMap, BlockType, MacroType, PaperDirection, TableBorder, TdBorder, TdSlash, MaxHeightRatio, NumberType, TitleLevel, ListType, ListStyle, WordBreak, ControlIndentation, ControlComponent, BackgroundRepeat, BackgroundSize, TextDecorationStyle, LineNumberType, LocationPosition, SurroundPosition, AreaMode, ControlState, FlexDirection, WatermarkType, WatermarkLayer };
+export type { IElement, IEditorData, IEditorOption, IEditorResult, IContextMenuContext, IRegisterContextMenu, IWatermark, INavigateInfo, IBlock, ILang, ICatalog, ICatalogItem, IRange, IRangeStyle, RangeRect, IBadge, IGetElementListByHTMLOption };

package/dist/src/editor/interface/Control.d.ts

@@ -146,6 +146,7 @@ export interface ISetControlValueOption {
     areaId?: string;
     value: string | IElement[] | null;
     isSubmitHistory?: boolean;
+    isOverwrite?: boolean;
 }
 export interface ISetControlExtensionOption {
     id?: string;

package/dist/src/editor/interface/Editor.d.ts

@@ -33,6 +33,7 @@ import { IAccessibilityOption } from './Accessibility';
 import { ITraceOption } from './Trace';
 import { IRulerOption } from './Ruler';
 import { IHintOption } from './Hint';
+import type { ISpellcheckOption } from './Spellcheck';
 export interface IEditorData {
     header?: IElement[];
     main: IElement[];
@@ -63,6 +64,7 @@ export interface IEditorOption {
     searchMatchColor?: string;
     searchNavigateMatchColor?: string;
     searchMatchAlpha?: number;
+    spellcheck?: ISpellcheckOption;
     highlightAlpha?: number;
     highlightMarginHeight?: number;
     resizerColor?: string;

package/dist/src/editor/interface/EventBus.d.ts

@@ -1,4 +1,5 @@
-import { IContentChange, IControlChange, IControlContentChange, IImageDblclick, IImageMousedown, IImageSizeChange, IInputEventChange, IIntersectionPageNoChange, ILabelMousedown, IMouseEventChange, IPageModeChange, IPageScaleChange, IPageSizeChange, IPositionContextChange, IRangeChange, IRangeStyleChange, ISaved, IVisiblePageNoListChange, IZoneChange } from './Listener';
+import { IContentChange, IControlChange, IControlContentChange, IImageDblclick, IImageMousedown, IImageSizeChange, IInputEventChange, IIntersectionPageNoChange, ILabelMousedown, IMouseEventChange, IPageModeChange, IPageScaleChange, IPageSizeChange, IPositionContextChange, IRangeChange, IRenderChange, IRangeStyleChange, ISaved, IVisiblePageNoListChange, IZoneChange } from './Listener';
+import type { ISpellcheckClick } from './Spellcheck';
 export interface EventBusMap {
     rangeStyleChange: IRangeStyleChange;
     visiblePageNoListChange: IVisiblePageNoListChange;
@@ -24,4 +25,6 @@ export interface EventBusMap {
     imageDblclick: IImageDblclick;
     labelMousedown: ILabelMousedown;
     rangeChange: IRangeChange;
+    renderChange: IRenderChange;
+    spellcheckClick: ISpellcheckClick;
 }

package/dist/src/editor/interface/Listener.d.ts

@@ -39,6 +39,7 @@ export type IPageSizeChange = (payload: number) => void;
 export type IPageScaleChange = (payload: number) => void;
 export type ISaved = (payload: IEditorResult) => void;
 export type IContentChange = () => void;
+export type IRenderChange = () => void;
 export type IControlChange = (payload: IControlChangeResult) => void;
 export type IControlContentChange = (payload: IControlContentChangeResult) => void;
 export type IPageModeChange = (payload: PageMode) => void;

package/dist/src/editor/interface/Range.d.ts

@@ -1,4 +1,5 @@
 import { EditorZone } from '../dataset/enum/Editor';
+import { SurroundPosition } from '../dataset/enum/Common';
 import { IElement, IElementFillRect, IElementStyle } from './Element';
 export interface IRange {
     startIndex: number;
@@ -42,3 +43,7 @@ export interface IRangeParagraphInfo {
     startIndex: number;
 }
 export type IRangeElementStyle = Pick<IElementStyle, 'bold' | 'color' | 'highlight' | 'font' | 'size' | 'italic' | 'underline' | 'strikeout'>;
+export interface IGetSurroundElementListOption {
+    direction?: SurroundPosition;
+    length?: number;
+}

package/dist/src/editor/interface/Spellcheck.d.ts

@@ -0,0 +1,27 @@
+import type { ITablePositionContext } from './Position';
+export interface ISpellcheckOption {
+    disabled?: boolean;
+    color?: string;
+}
+export interface ISpellcheckContext {
+    tableId?: string;
+    tableIndex?: number;
+    trIndex?: number;
+    tdIndex?: number;
+    tablePath?: ITablePositionContext[];
+}
+export interface ISpellcheckWord extends ISpellcheckContext {
+    word: string;
+    startIndex: number;
+    endIndex: number;
+}
+export interface ISpellcheckRange extends ISpellcheckContext {
+    startIndex: number;
+    endIndex: number;
+    data?: unknown;
+}
+export interface ISpellcheckClickPayload {
+    evt: MouseEvent;
+    range: ISpellcheckRange;
+}
+export type ISpellcheckClick = (payload: ISpellcheckClickPayload) => void;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@hufe921/canvas-editor",
   "author": "Hufe",
   "license": "MIT",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Canvas/SVG-based rich text editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -53,24 +53,24 @@
     "@types/jsdom": "^28.0.3",
     "@types/node": "^24.12.4",
     "@types/prismjs": "^1.26.6",
-    "@typescript-eslint/eslint-plugin": "^8.67.0",
-    "@typescript-eslint/parser": "^8.67.0",
-    "@vitest/coverage-v8": "^4.1.6",
-    "cypress": "^15.20.1",
+    "@typescript-eslint/eslint-plugin": "^8.69.0",
+    "@typescript-eslint/parser": "^8.69.0",
+    "@vitest/coverage-v8": "^4.1.11",
+    "cypress": "^15.21.1",
     "cypress-file-upload": "^5.0.8",
-    "eslint": "^10.8.1",
-    "globals": "^17.10.0",
+    "eslint": "^10.9.1",
+    "globals": "^17.12.0",
     "jsdom": "^29.1.1",
-    "simple-git-hooks": "^2.13.1",
+    "simple-git-hooks": "^2.14.0",
     "tslib": "^2.8.1",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.67.0",
-    "vite": "^8.2.1",
+    "typescript-eslint": "^8.69.0",
+    "vite": "^8.2.2",
     "vite-plugin-css-injected-by-js": "^5.0.1",
     "vitepress": "^1.6.4",
-    "vitest": "^4.1.6",
-    "vitest-canvas-mock": "^1.1.4",
-    "vue": "^3.5.41"
+    "vitest": "^4.1.11",
+    "vitest-canvas-mock": "^1.1.5",
+    "vue": "^3.5.42"
   },
   "simple-git-hooks": {
     "pre-commit": "npm run lint && npm run type:check",