Canvas-Editor是一个基于Canvas和SVG的富文本编辑器，它提供了丰富的文本编辑功能，并支持通过Canvas和SVG进行渲染。

以下是对Canvas-Editor的详细介绍：

一、主要特点

1. 高性能：利用Canvas和SVG进行图形和矢量图形的渲染，提供高性能的绘图能力。
2. 可扩展性：Canvas-Editor是一个开源项目，支持通过插件机制扩展编辑器的功能，如PDF导出、表格分页等。
3. 丰富的文本编辑功能：支持多种文本编辑操作，如插入表格、分页、性能优化等。

二、技术栈

1. Canvas：用于图形渲染，提供高性能的绘图能力。
2. SVG：用于矢量图形的渲染，支持复杂的图形和动画。
3. Vite：作为项目的构建工具，提供快速的开发和构建体验。
4. Cypress：用于端到端测试，确保项目的稳定性和可靠性。
5. TypeScript：提供静态类型检查，增强代码的可维护性和可读性。

三、安装与配置

1. 准备工作：

   • 确保开发环境中已经安装了Node.js（版本建议为14.x或更高）和npm或yarn（用于包管理）。

2. 安装步骤：

   • 将项目克隆到本地：打开终端并运行git clone https://github.com/Hufe921/canvas-editor.git命令。
   • 进入项目目录：运行cd canvas-editor命令。
   • 使用npm或yarn安装项目所需的依赖包：如果使用npm，请运行npm install命令；如果使用yarn，请运行相应的yarn命令。
   • 启动开发服务器进行开发：运行npm run dev命令（或使用yarn的yarn dev命令）。
   • 构建项目以进行生产环境部署：运行npm run build命令（或使用yarn的yarn build命令）。

四、使用方法

1. 引入并初始化编辑器：

   • 在HTML中准备一个容器，例如<div class="canvas-editor"></div>。
   • 在JavaScript中引入Canvas-Editor并初始化，例如：

    

   import Editor from '@hufe921/canvas-editor';  
   new Editor(document.querySelector('.canvas-editor'), {  
     main: [{ value: 'Hello World' }]  
   });

2. 自定义与扩展：

   • 可以通过API调用实现自定义功能，如添加左侧目录、右侧便签、顶部菜单栏等。
   • 可以下载官方维护的插件仓库，利用插件机制扩展编辑器的功能。

五、简易扩展

        基于官方的提供的demo案例，我们把它封装成了组件库，支持顶部导航栏，底部切换页面大小等。

安装

Install from NPM

npm install diygw-editor

Install from YARN

yarn add diygw-editor

组件调用

<script setup>
import {DiygwEditor} from 'diygw-editor'
</script>

<template>
   <DiygwEditor></DiygwEditor>
</template>

开源地址

https://github.com/html580/diygw-editor.git