boyun/by-onlineeditor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
20 Commits 1 Branch 0 Tags 7.6 MiB
TypeScript 94.6%
CSS 3.4%
HTML 1.9%
JavaScript 0.1%
main
Go to file
hanshiyang 1335932afa feat(iframe): 添加父窗口与iframe间的页面跳转API 
暴露OCDIframeAPI接口，包含getFirstVisiblePageNo和gotoPage方法
移除demo.html中重复实现的页面跳转逻辑，改用新API
2025-12-02 11:26:54 +08:00
.vscode init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
cypress init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
docs init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
public feat(iframe): 添加父窗口与iframe间的页面跳转API 2025-12-02 11:26:54 +08:00
scripts init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
src feat(iframe): 添加父窗口与iframe间的页面跳转API 2025-12-02 11:26:54 +08:00
.editorconfig init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
.eslintrc init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
.gitignore init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
.prettierrc init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
CHANGELOG.md init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
cypress.config.ts init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
demo.html feat(iframe): 添加父窗口与iframe间的页面跳转API 2025-12-02 11:26:54 +08:00
favicon.png init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
LICENSE init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
package.json feat: 添加本地文件读取功能并优化构建脚本 2025-11-20 14:34:58 +08:00
pnpm-lock.yaml init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
pnpm-workspace.yaml init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
README.md init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
tsconfig.json init from https://github.com/Hufe921/canvas-editor 2025-09-23 10:43:28 +08:00
vite.config.ts fix(vite配置): 修正publicDir设置并更新demo页面逻辑 2025-11-28 15:54:46 +08:00
vocd.html docs: 将页面标题从英文改为中文 2025-11-20 14:41:07 +08:00

README.md

canvas-editor

Version Cypress Passing GitHub Contributors License PRs

a rich text editor by canvas/svg

View Demo · View Docs · Report Bug · Request Feature · FAQ

Love the project? Please consider donating(赞助) to help it improve!

Tips

  1. Official plugin: canvas-editor-plugin
  2. The render layer by svg is under development, see feature/svg
  3. The export pdf feature is available now, see feature/pdf
  4. The AI-powered text processing demo, see feature/ai
  5. Table pagination #41 is under active development, see: poc/table-paging · demo

Basic usage

npm i @hufe921/canvas-editor --save

<div class="canvas-editor"></div>

import Editor from '@hufe921/canvas-editor'

new Editor(document.querySelector('.canvas-editor'), {
  main: [
    {
      value: 'Hello World'
    }
  ]
})

Features

  • Rich text operations (Undo, Redo, Font, Size, Bold, Italic, Underline, Strikeout, Superscript, Alignment, Title, List, ...)
  • Insert elements (Table, Image, Link, Code Block, Page Break, Math Formula, Date Picker, Block, ...)
  • Print (Based on canvas to picture, pdf drawing)
  • Controls (Select, Text, Date, Radio, Checkbox)
  • Contextmenu (Internal, Custom)
  • Shortcut keys (Internal, Custom)
  • Drag and Drop(Text, Element, Control)
  • Header, Footer, Page Number
  • Page Margin
  • Watermark
  • Pagination
  • Comment
  • Catalog

Roadmap

  1. Table paging
  2. Control rules
  3. Improve performance
  4. CRDT

Snapshot

image

Install

yarn

Dev

npm run dev

Build

app

npm run build

lib

npm run lib