富文本编辑器Quill的简单React封装

2024-01-13 16:58

本文主要是介绍富文本编辑器Quill的简单React封装,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

最近要在React项目中实现富文本编辑器,我在基于不同插件实现多种版本之后,体会到了Quill的强大,决定在项目中使用Quill实现富文本编辑器功能。

大多数富文本编辑器都有所见即所得的(指不能进行扩展)的问题,这意味着我们很难或者不可能对其进行自定义满足一些特定的需求。Quill的强大之处在于通过将自身组织成模块,并提供强大的API来构建额外的模块解决扩展的问题,即所有能看到的,不能看到的功能统统都是一个独立的模块,全部都是可以替换的。

虽然Quilljs是原生js的,但是可以轻松实现React版本的封装。下边是我在React中的简单实现,供参考。

下载及导入

直接npm install quill@1.3.0进行下载,在项目中

 

import Quill from 'quill';
import 'quill/dist/quill.snow.css';

 

html结构

在render()方法中只需要一个div标签,给div一个id或者ref属性,例如:

 

<div ref="textarea"></div>

 

初始化

 

在构造函数中对初始内容进行设置:

 

this.state = {'value':'<p>quill测试文本</p>',};
this.editor=null;

在componentDidMount中进行初始化:

 

 

const textbox = this.refs.textarea;
const options = {debug: 'warn',modules: {toolbar: true},placeholder: '请输入文本...',readOnly: false,theme: 'snow'};

options为配置项,debug为在console中打印信息的时期,可供选择的有‘debug’,‘warn’,‘log’和‘info’;toolbar选为TRUE是指toolbar选用默认功能;readOnly指是否可编辑;theme有‘snow’和‘bubble’两种选择,分别是toolbar部分是否显示。

 

下面是渲染文本编辑器,使用editor.clipboard.dangerouslyPasteHTML进行初始值赋值和绑定‘text-change’事件。

const editor =this.editor= new Quill(textbox,options);
const {value}=this.state;
if (value) editor.clipboard.dangerouslyPasteHTML(value);
editor.on('text-change', this.handleChange.bind(this));

在change处理函数中可以使用this.editor.root.innerHTML获取文本编辑器的html内容。

 

 

handleChange () {let {value}=this.state;value = this.editor.root.innerHTML;this.setState({value});}

这就简单实现了一个文本编辑器,效果如下,

 

 

 

theme指定为‘bubble’时,效果如下:

当然,我们可以配置toolbar,例如:

 

const toolbarOptions = [['bold', 'italic', 'underline', 'strike'],        // toggled buttons['blockquote', 'code-block'],[{ 'header': 1 }, { 'header': 2 }],               // custom button values[{ 'list': 'ordered'}, { 'list': 'bullet' }],[{ 'script': 'sub'}, { 'script': 'super' }],      // superscript/subscript[{ 'indent': '-1'}, { 'indent': '+1' }],          // outdent/indent[{ 'direction': 'rtl' }],                         // text direction[{ 'size': ['small', false, 'large', 'huge'] }],  // custom dropdown[{ 'header': [1, 2, 3, 4, 5, 6, false] }],[{ 'color': [] }, { 'background': [] }],          // dropdown with defaults from theme[{ 'font': [] }],[{ 'align': [] }],['link', 'image', 'video'],['clean']                                         // remove formatting button];

相应的option为

 

 

modules: {toolbar: toolbarOptions},

展示效果为:

 

结束语


这样就完成了一个React版本的简单封装。当然,quill的功能远不止于此,还支持文本的样式,多媒体文件的上传,响应键盘事件,操作历史,公式支持等,如果插件自带的功能不足以实现你的需求,比如你要做一个动画在菜单栏上加一个图标、选项或者什么的。可以对整个菜单栏进行定义和重写,可参考http://www.qingpingshan.com/jb/javascript/202099.html。
quill的详细配置和丰富的API在官网上有详细介绍,可以自定义自己需要的富文本编辑器。
quill.js富文本编辑器的官网地址:https://quilljs.com/
quill.js富文本编辑器配置参数地址:https://quilljs.com/docs/configuration/
quill.js富文本编辑器API方法地址:https://quilljs.com/docs/api/

 

 

 

 

这篇关于富文本编辑器Quill的简单React封装的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/602161

相关文章

Vue和React受控组件的区别小结

《Vue和React受控组件的区别小结》本文主要介绍了Vue和React受控组件的区别小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录背景React 的实现vue3 的实现写法一:直接修改事件参数写法二:通过ref引用 DOMVu

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现:html 转图片完整代码场景 1:转换本地 HTML 文件为图片场景 2:转换 H

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

Vue3绑定props默认值问题

《Vue3绑定props默认值问题》使用Vue3的defineProps配合TypeScript的interface定义props类型,并通过withDefaults设置默认值,使组件能安全访问传入的... 目录前言步骤步骤1:使用 defineProps 定义 Props步骤2:设置默认值总结前言使用T

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

python连接sqlite3简单用法完整例子

《python连接sqlite3简单用法完整例子》SQLite3是一个内置的Python模块,可以通过Python的标准库轻松地使用,无需进行额外安装和配置,:本文主要介绍python连接sqli... 目录1. 连接到数据库2. 创建游标对象3. 创建表4. 插入数据5. 查询数据6. 更新数据7. 删除

Jenkins的安装与简单配置过程

《Jenkins的安装与简单配置过程》本文简述Jenkins在CentOS7.3上安装流程,包括Java环境配置、RPM包安装、修改JENKINS_HOME路径及权限、启动服务、插件安装与系统管理设置... 目录www.chinasem.cnJenkins安装访问并配置JenkinsJenkins配置邮件通知

Python用Flask封装API及调用详解

《Python用Flask封装API及调用详解》本文介绍Flask的优势(轻量、灵活、易扩展),对比GET/POST表单/JSON请求方式,涵盖错误处理、开发建议及生产环境部署注意事项... 目录一、Flask的优势一、基础设置二、GET请求方式服务端代码客户端调用三、POST表单方式服务端代码客户端调用四

基于Python Playwright进行前端性能测试的脚本实现

《基于PythonPlaywright进行前端性能测试的脚本实现》在当今Web应用开发中,性能优化是提升用户体验的关键因素之一,本文将介绍如何使用Playwright构建一个自动化性能测试工具,希望... 目录引言工具概述整体架构核心实现解析1. 浏览器初始化2. 性能数据收集3. 资源分析4. 关键性能指

Python yield与yield from的简单使用方式

《Pythonyield与yieldfrom的简单使用方式》生成器通过yield定义,可在处理I/O时暂停执行并返回部分结果,待其他任务完成后继续,yieldfrom用于将一个生成器的值传递给另一... 目录python yield与yield from的使用代码结构总结Python yield与yield