Sym - 一个用 Java 实现的现代化社区平台 • 源码 • 注册

Pipe - 小而美的开源博客平台 • 体验 • 皮肤
Solo - 一个用 Java 实现的博客系统,为你或你的团队创建个博客吧! • 源码下载 
Wide - 一个基于 Web 的 Go 语言 IDE • 教程试用

Vditor 使用指南

Start

CommonJS

  • 安装依赖
npm install vditor --save
  • 在代码中引入
import Vditor from 'vditor'
@import "~vditor/src/assets/scss/classic" // 或者使用 dark
  • 初始化对象
const vditor = new Vditor(id, {options...})
vditor.focus()

HTML script

  • 在 HTML 中插入 css 和 js
<!-- 可使用 index.dark.css 或 index.classic.css -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vditor/dist/index.classic.css" />
<script src="https://cdn.jsdelivr.net/npm/vditor/dist/index.min.js"></script>
  • 初始化对象
const vditor = new Vditor(id, {options...})
vditor.focus()

API

options

说明 默认值
cache 是否使用 localStorage 进行缓存 true
height 编辑器总高度 'auto'
width 编辑器总宽度,支持 % 'auto'
placeholder 输入区域为空时的提示 ''
lang 多语言:en_US, zh_CN 'zh_CN'
counter 计数器 0
input 输入后触发 (value: string, previewElement?: HTMLElement): void -
focus 聚焦后触发 (value: string): void -
blur 失焦后触发 (value: string): void -
esc esc 按下后触发 (value: string): void -
ctrlEnter ctrl+enter 按下后触发 (value: string): void -
select 编辑器中选中文字后触发 (value: string): void -
editorName 设置编辑器中的 textarea name -
tab tab 键操作字符串,支持 \t 及任意字符串 -

options.toolbar

  • 工具栏,可使用 name 进行简写:['emoji', 'br', 'bold', '|', 'line']。默认值参见 src/ts/util/OptionsClass.ts
  • name 可枚举为:emoji, headings, bold, italic, strike, |, line, quote, list, ordered-list, check, code, inline-code, undo, redo, upload, link, table, record, preview, fullscreen, info, help, br
说明 默认值
name 唯一标示 -
icon svg 图标 -
tip 提示 -
tipPosition 提示位置:ne, nw -
hotkey 快捷键,目前仅支持 ctrl + 任意键 -
suffix 插入编辑器中的后缀 -
prefix 插入编辑器中的前缀 -

options.preview

说明 默认值
delay 预览 debounce 毫秒间隔 1000
show 是否显示预览区域 false
parse 预览回调 (element: HTMLElement): void -
url md 解析请求 -

options.preview.hljs

说明 默认值
enable 是否启用代码高亮 true
style highlight.js 样式文件名 'atom-one-light'

options.hint

说明 默认值
delay 提示 debounce 毫秒间隔 200
emoji 默认表情,可从 src/ts/emoji/allEmoji.ts 中选取 {'+1': '👍', '-1': '👎', 'heart': '❤️', 'cold_sweat': '😰'}
emojiTail 常用表情提示 -
emojiPath 表情图片地址 https://cdn.jsdelivr.net/npm/vditor/src/assets/emoji
at @用户回调,(value: string): Array,需同步返回数组 [{value:'', html:''}] -

options.upload

说明 默认值
url 上传 url,查看规范 ''
max 上传文件最大 Byte 10 * 1024 * 1024
linkToImgUrl 剪切板中包含图片地址时,使用此 url 重新上传 ''
success 上传成功回调 (textarea: HTMLTextAreaElement, msg: string): void -
error 上传失败回调 (msg: string): void -
token CORS 上传验证,头为 X-Upload-Token -
filename 文件名安全处理 (name: string): string name => name.replace(/\W/g,'')
accept 文件上传类型,同 input accept -
validate 文件上传过滤,返回错误信息或 true (files: File[]) => string | boolean -
handler 自定义文件上传,返回错误信息或 null (files: File[]) => string | null -

options.resize

说明 默认值
enable 是否支持大小拖拽 false
position 拖拽栏位置:top, bottom 'bottom'
after 拖拽结束的回调 (height: number): void -

options.classes

说明 默认值
preview 预览元素上的 className ''

methods

说明
getValue() 获取编辑器内容
getHTML(includeHljs?: boolean) 获取预览区内容(是否输出代码高亮)。该方法需使用异步编程
insertValue(value: string) 在焦点处插入内容
focus() 聚焦到编辑器
blur() 让编辑器失焦
disabled() 禁用编辑器
enable() 接触编辑器禁用
setSelection(start: number, end: number) 选中从 start 开始到 end 结束的字符串
getSelection():string 返回选中的字符串
setValue(value: string) 设置编辑器内容
renderPreview(value?: string) 设置预览区域内容
getCursorPosition():{top: number, left: number} 获取焦点位置
deleteValue() 删除选中内容
updateValue(value: string) 更新选中内容
isUploading() 上传是否还在进行中
clearCache() 清除缓存
disabledCache() 禁用缓存
enableCache() 启用缓存
html2md(value: string) html 转 md。该方法需使用异步编程

static methods

说明
mathRender(element: HTMLElement) 转换 element 中的文本为数学公式
mermaidRender(element: HTMLElement) 转换 element 中的文本为流程图 / 时序图 / 甘特图
codeRender(element: HTMLElement, lang: (keyof II18nLang)) 为 element 中的代码块添加复制按钮

Dev

  1. 安装 node LTS 版本
  2. 下载 最新代码并解压
  3. 根目录运行 npm install
  4. npm run dev 启动 webpack 开发环境
  5. npm run start 启动本地服务器,打开 http://localhost:9000/demo
  6. 修改代码
  7. npm run build 打包代码到 dist 目录

注意事项:


欢迎注册黑客派社区,开启你的博客之旅。让学习和分享成为一种习惯!

34 评论
Vanessa • 2019-02-19
回复 删除

默认是 1s。你的感知很灵敏呀

darren • 2019-03-04
回复 删除

目前正打算使用 vditor,但是发现一些地方不顺手,所以应该算是提出一些建议吧:

  • 服务器渲染预览时请求头的 content-type 希望能设置成 application/json 当前是 text/plain 导致像 SpringMVC 无法直接使用 @RequestBody
  • 文件上传的选择框 允许添加限定选择的文件类型(accept 属性)
  • 希望能添加前端浏览器渲染的功能(这样在有流量限制或者离线断网的环境也能愉快的编辑,别问我为什么有离线使用的情况,那就要问为啥有缓存这个功能呢?哈哈哈)
  • 希望能开放一些 api 供开发者直接调用,如 HTML 转 markdown 的方法(目前只能粘贴的时候转换),这样方便读取页面上原始的一段 HTML,转为 markdown 后直接编辑
  • 编辑器当前是以 div 这 dom 容器作为入口的,所以如果假设原始 div 容器中已经有内容了,希望能直接将原始容器中的 HTML 自动转 markdown 并作为默认值初始化给编辑器
Vanessa • 2019-03-04
回复 删除
BrickCat • 2019-04-19
回复 删除

自定义 ToolBar 时报错了TypeError: this.options.toolbar.forEach is not a function

toolbar:{

    name:['emoji', 'br', 'bold', '|', 'line']
  },