富文本编辑器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

相关文章

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

Nginx搭建前端本地预览环境的完整步骤教学

《Nginx搭建前端本地预览环境的完整步骤教学》这篇文章主要为大家详细介绍了Nginx搭建前端本地预览环境的完整步骤教学,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录项目目录结构核心配置文件:nginx.conf脚本化操作:nginx.shnpm 脚本集成总结:对前端的意义很多

前端缓存策略的自解方案全解析

《前端缓存策略的自解方案全解析》缓存从来都是前端的一个痛点,很多前端搞不清楚缓存到底是何物,:本文主要介绍前端缓存的自解方案,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、为什么“清缓存”成了技术圈的梗二、先给缓存“把个脉”:浏览器到底缓存了谁?三、设计思路:把“发版”做成“自愈”四、代码

通过React实现页面的无限滚动效果

《通过React实现页面的无限滚动效果》今天我们来聊聊无限滚动这个现代Web开发中不可或缺的技术,无论你是刷微博、逛知乎还是看脚本,无限滚动都已经渗透到我们日常的浏览体验中,那么,如何优雅地实现它呢?... 目录1. 早期的解决方案2. 交叉观察者:IntersectionObserver2.1 Inter

Vue3视频播放组件 vue3-video-play使用方式

《Vue3视频播放组件vue3-video-play使用方式》vue3-video-play是Vue3的视频播放组件,基于原生video标签开发,支持MP4和HLS流,提供全局/局部引入方式,可监听... 目录一、安装二、全局引入三、局部引入四、基本使用五、事件监听六、播放 HLS 流七、更多功能总结在 v

JS纯前端实现浏览器语音播报、朗读功能的完整代码

《JS纯前端实现浏览器语音播报、朗读功能的完整代码》在现代互联网的发展中,语音技术正逐渐成为改变用户体验的重要一环,下面:本文主要介绍JS纯前端实现浏览器语音播报、朗读功能的相关资料,文中通过代码... 目录一、朗读单条文本:① 语音自选参数,按钮控制语音:② 效果图:二、朗读多条文本:① 语音有默认值:②

vue监听属性watch的用法及使用场景详解

《vue监听属性watch的用法及使用场景详解》watch是vue中常用的监听器,它主要用于侦听数据的变化,在数据发生变化的时候执行一些操作,:本文主要介绍vue监听属性watch的用法及使用场景... 目录1. 监听属性 watch2. 常规用法3. 监听对象和route变化4. 使用场景附Watch 的

前端导出Excel文件出现乱码或文件损坏问题的解决办法

《前端导出Excel文件出现乱码或文件损坏问题的解决办法》在现代网页应用程序中,前端有时需要与后端进行数据交互,包括下载文件,:本文主要介绍前端导出Excel文件出现乱码或文件损坏问题的解决办法,... 目录1. 检查后端返回的数据格式2. 前端正确处理二进制数据方案 1:直接下载(推荐)方案 2:手动构造

Vue实现路由守卫的示例代码

《Vue实现路由守卫的示例代码》Vue路由守卫是控制页面导航的钩子函数,主要用于鉴权、数据预加载等场景,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着... 目录一、概念二、类型三、实战一、概念路由守卫(Navigation Guards)本质上就是 在路

uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)

《uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)》在uni-app开发中,文件上传和图片处理是很常见的需求,但也经常会遇到各种问题,下面:本文主要介绍uni-app小程序项目中实... 目录方式一:使用<canvas>实现图片压缩(推荐,兼容性好)示例代码(小程序平台):方式二:使用uni