vue3如何使用VueQuill插入自定义按钮
vue3使用VueQuill插入自定义按钮
在 Vue 3 项目中使用 VueQuill
编辑器时,我们可以自定义内容来满足特定的需求。
本文将介绍如何在 VueQuill
中插入自定义内容,比如插入特定的标签或样式元素。
1. 项目设置和依赖安装
如果你还没有创建 Vue 3 项目,可以使用以下命令来初始化项目:
npm init vue@latest
选择 Vue 3 的相关配置,然后进入项目目录并安装依赖项。
安装 VueQuill
npm install @vueup/vue-quill
此库是 Quill 编辑器的 Vue 3 兼容版本。
2. 基础配置 VueQuill
在 src/components
中创建一个 QuillEditor.vue
文件,并引入 vue3-quill
,将 VueQuillEditor
作为编辑器组件使用。
template
内容
<template> <div class="editor"> <quill-editor ref="quillEditorRef" v-model:content="content" content-type="html" :options="options" :style="styles" @text-change="textChangeFn" /> </div> </template>
options
内容:
import '@vueup/vue-quill/dist/vue-quill.snow.css'; import { Quill } from '@vueup/vue-quill'; const options = ref<any>({ theme: 'snow', bounds: document.body, debug: 'warn', modules: { // 工具栏配置 toolbar: { container: [ ['bold', 'italic', 'underline', 'strike'], // 加粗 斜体 下划线 删除线 ['blockquote', 'code-block'], // 引用 代码块 [{ list: 'ordered' }, { list: 'bullet' }], // 有序、无序列表 [{ indent: '-1' }, { indent: '+1' }], // 缩进 [{ size: ['small', false, 'large', 'huge'] }], // 字体大小 [{ header: [1, 2, 3, 4, 5, 6, false] }], // 标题 [{ color: [] }, { background: [] }], // 字体颜色、字体背景颜色 [{ align: [] }], // 对齐方式 ['clean'], // 清除文本格式 ['link', 'image', 'video'], // 链接、图片、视频 ['newFunction'] // 新添加的按钮 ], handlers: { newFunction: (value: boolean) => { // 添加处理方法 const quill = quillEditorRef.value.getQuill(); // 插入自定义按钮 quill.insertEmbed(0, 'customSpan', 'test'); } } } }, placeholder: props.readOnly ? '' : '请输入内容', readOnly:false });
以上代码创建了一个基础的 VueQuillEditor
组件,我们可以在其中输入和编辑文本。
3. 自定义内容的插入
接下来,我们会在 Quill 编辑器中插入自定义内容,比如一个带特定样式的 span
标签。为此,我们需要创建一个 Quill 的自定义 Blot 元素。
- 新建
CustomSpanBlot.ts
文件
在 src/quill-blots
文件夹下新建 CustomSpanBlot.ts
文件,用于定义我们自定义的 span
标签格式:
import { Quill } from '@vueup/vue-quill'; const Inline = Quill.import("blots/inline"); class CustomSpanBlot extends Inline { static blotName = "customSpan"; static tagName = "span"; static className = "custom-span"; static create(value: string) { const node = super.create(); node.setAttribute("data-custom", value); node.innerHTML = value; return node; } static formats(node: HTMLElement) { return node.getAttribute("data-custom"); } format(name: string, value: string) { if (name === CustomSpanBlot.blotName && value) { this.domNode.setAttribute("data-custom", value); this.domNode.innerHTML = value; } else { super.format(name, value); } } } export { CustomSpanBlot };
4. 插入内容到编辑器
在 QuillEditor.vue
中引入自定义的 CustomSpanBlot
,并编写插入自定义内容的方法:
<script lang="ts"> import { CustomSpanBlot } from './CustomSpanBlot'; // 进行注册 Quill.register(CustomSpanBlot); // 初始化 onMounted(() => { // 新增自定义功能 const newFunctionButton = document.querySelector('.ql-newFunction'); newFunctionButton.setAttribute('style', 'width:80px; border:1px solid #ccc; border-radius:5px'); newFunctionButton.textContent = '新功能'; }); </script>
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
elementUI中的$confirm调换两个按钮位置的实例代码
这篇文章主要介绍了elementUI中的$confirm调换两个按钮位置的实例代码,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧2024-03-03Vue使用codemirror实现一个可插入自定义标签的textarea
这篇文章主要为大家详细介绍了Vue如何使用codemirror实现一个可插入自定义标签的textarea,感兴趣的小伙伴可以跟随小编一起学习一下2024-02-02element-plus el-form表单验证使用方法以及注意事项
这篇文章主要给大家介绍了关于element-plus el-form表单验证使用方法以及注意事项的相关资料,表单验证能通过设置验证规则验证用户的输入,并对不规范的输入做出对应提示,文中通过代码介绍的非常详细,需要的朋友可以参考下2023-12-12Vue指令之 v-cloak、v-text、v-html实例详解
当用户频繁刷新页面或网速慢时,页面未完成 Vue.js 的加载时,导致 Vue 来不及渲染,这就会导致在浏览器中直接暴露插值(表达式),这篇文章主要介绍了Vue指令 v-cloak、v-text、v-html,需要的朋友可以参考下2019-08-08
最新评论