1.0.2 • Published 2 years ago

@qingbing/vue2-editor v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

封装 vue-element-ui 的组件

基于element-ui封装quill的在线编辑器

  • 1.0.0 调试版本
  • 1.0.1 添加readme注释
  • 1.0.2
    • 增加 simple 模式下工具栏的工具数量

1. 下载安装

npm install @qingbing/vue2-editor

2. 使用参数说明

2.1 传递参数

参数名类型是否必填默认描述
customModulesArray[]自定义模块
placeholderString""提示输入信息
valueStringString默认内容
disabledBooleanfalse是否可编辑
toolbarModeString""工具栏模式: simple,common(default),common,code,full
editorToolbarArray[]自定义工具栏,一旦定义, toolbarMode 将无效
editorOptionsObject{}编辑器参数选项
useSourceBooleanfalse是否使用源代码标记,在自定义 toolbar 时无效,将"source"作为一个工具即可
useImageUrlBooleanfalse图片添加已 prompt 的方式输入 url
useImageHandleBooleanfalse图片上传方法,优先级高于 useImageUrl
useMarkdownShortcutsBooleanfalse是否使用 markdown的编辑风格转换

2.2 传递事件

事件名参数描述
readyquill编辑器准备完成
blurquill编辑器失去焦点事件
focusquill编辑器获取焦点事件
inputeditorContent编辑器内容变化
image-addedfile, Editor, cursorLocation开启 useImageHandle 时的上传图片事件
image-removedfile, Editor, cursorLocation开启 useImageHandle 时的删除图片事件
selection-changerange, oldRange, sourceQuill 支持的 selection-change 事件
text-changedelta, oldDelta, sourceQuill 支持的 text-change 事件
......其它 Quill 支持的事件

3. 使用

3.1 导入

import Vue2Editor from "@qingbing/vue2-editor";

3.2 使用

<p>简单模式</p>
<vue2-editor
  v-model="simpleContent"
  :toolbarMode="'simple'"
  :useSource="true"
></vue2-editor>
<p>普通模式(默认)</p>
<vue2-editor
  v-model="commonContent"
  :toolbarMode="'common'"
  :useSource="true"
  :useImageHandle="true"
  @image-upload="handleImageUpload"
></vue2-editor>
<p>文章模式</p>
<vue2-editor
  v-model="articleContent"
  :toolbarMode="'article'"
  :useImageUrl="true"
  :useSource="true"
></vue2-editor>
<p>代码模式</p>
<vue2-editor
  v-model="codeContent"
  :toolbarMode="'code'"
  :useSource="true"
></vue2-editor>
<p>全按钮模式</p>
<vue2-editor
  v-model="fullContent"
  :toolbarMode="'full'"
  :useSource="true"
></vue2-editor>
<p>自定义模式</p>
<vue2-editor
  v-model="customContent"
  :editorToolbar="editorToolbar"
  :editorOptions="editorOptions"
></vue2-editor>
data() {
    return {
      simpleContent: "<p>simpleContent</p>",
      commonContent: "<p>common-default</p>",
      articleContent: "<p>articleContent</p>",
      codeContent: "<p>codeContent</p>",
      fullContent: "<p>fullContent</p>",
      customContent: "<p>customContent</p>",
      editorToolbar: [["source"], ["image"], [{ header: [false, 1, 2, 3, 4, 5, 6] }]],
    };
  }