资讯专栏INFORMATION COLUMN

zx-editor 移动端(HTML5)富文本编辑器,可与原生App混合(hybrid)开发

lansheng228 / 3891人阅读

摘要:移动端文档富文本编辑器,支持图文混排引用大标题无序列表,字体颜色加粗斜体。可用于独立项目开发,也可以用于与原生混合开发。,图片文件最大尺寸限制,单位,默认,编辑器左右内边距,默认像素,是否显示底部工具栏图片标签连接添加等图标。

ZxEditor 移动端HTML文档(富文本)编辑器,支持图文混排、引用、大标题、无序列表,字体颜色、加粗、斜体。

可用于独立web项目开发,也可以用于与原生App混合(hybrid)开发。

源码地址:https://github.com/capricornc...

本地运行 Build Setup
# 安装依赖
npm i

# 运行开发模式
# 通过 `http://localhost:9001` 可以访问
npm run dev

# 生成项目文件
npm run build
使用 Use

npm

  npm install zx-editor --save-dev

html

注意:添加照片时,判断照片方向,并自动旋转需要依赖插件 exif.js

ES6+

import { ZxEditor } from "zx-editor"
// import { ZxEditor } from "./src/js/zx-editor/index.js"
参数 options

autoSave: Number,自动保存编辑内容至localStorage,单位秒。等于0则不自动保存编辑内容。

bottom: Number,底部距离。

fixed: Boolean,编辑器是否绝对定位,默认为false。

imageMaxSize: Number,图片文件最大尺寸限制,单位MB,默认20

padding: Number,编辑器左右内边距,默认15像素,

showToolbar: Array|Boolean,是否显示底部工具栏(图片、标签、连接添加等图标)。

默认为true,显示全部图标。

Array可选值:["pic", "emoji", "text", "link"],数组中元素顺序,决定按钮的显示顺序。

top: Number,顶部距离,绝对定位时,相对于WebView顶部的距离。

属性 property

dialog: Object 消息提示框

alert、confirm、loading对话框

方法 说明
alert(msg, callback) msg:提示消息, callback():回调函数
confirm(msg, callback) msg:提示消息, callback(true或false):回调函数
loading(msg) msg:提示消息,默认loading...
removeLoading() 移除loading元素节点
zxEditor.dialog.alert("这是alert提示框", function () {
  // do something ...
})

storage: Object 本地存储

localStorage/sessionStorage

方法 说明
set(key, data, isSessionStorage) key:存储键名,会自动加默认前缀, data:需要存储的数据
get(key, isSessionStorage) key:存储键名,返回null或data
remove(key, isSessionStorage) 删除key对应的本地数据

isSessionStorage,可选参数。默认值为false。

zxEditor.storage.set("content", {title: "标题", content: "内容"})

方法 methods

on(notifyName, callback)

监听编辑器部分通知

notifyName callback(参数) 说明
add-link next() 点击底部添加连接图标时触发。监听此通知,将阻止编辑器默认处理逻辑执行
debug messge 消息通知
error {code: 1, msg: "message"} 错误异常通知
select-picture - 点击底部选择图片图标时触发。监听此通知,将阻止编辑器默认处理逻辑执行
show-emoji - 点击底部emoji图标时触发
show-textstyle - 点击底部文字样式图标时触发

例子:

// 自定义选择图片
zxEditor.on("select-picture", _ => {
  // hybrid模式开发时,此处可以调用原生App提供的接口,访问图片文件选择列表
  // 执行图片文件数据获取,
  // 或者获取由原生App处理并上传完成的图片url
  zxEditor.addImage("图片url地址或base64图片数据")
  // 其他操作...
})
// 自定义添加链接
zxEditor.on("add-link", next => {
  // hybrid模式开发时,此处可以调用原生App提供的接口,访问剪贴板是否有url地址数据
  // 获取到url地址、及其文档title
  // 将链接添加至编辑器中
  next(url, title)
})

addFooterButton(option)

底部工具栏添加按钮,option: Object|Array

// 底部工具栏添加一个“导语”按钮
zxEditor.addFooterButton({
  name: "summary",
  // 按钮外容器样式名称
  class: "demo-summary-button",
  // 按钮内i元素样式名
  icon: "",
  // 需要注册的监听事件名
  on: "summary-button"
})

// 或者
zxEditor.addFooterButton(
  [
    {
      name: "summary",
      class: "demo-summary-button",
      icon: "",
      on: "summary-button"
    }
  ]
)

addImage(src|base64)

向正文焦点处添加一张图片,支持图片url地址或base64数据

addMedia(url, type)

向正文焦点处添加图片/音频/视频

图片url地址或base64数据

音频/视频只支持url地址

url: String url地址

type: String, img|audio|video

getBase64Images()

获取正文中所有base64数据的图片,返回一个数组

@return array

  [
    {
      id: "zxEditor_img_1500001511111",
      base64: "data:image/jpeg;base64,/9j4AAQSkZJDAAkGB+wgH....",
      blob: "Blob数据,可以用于直接上传,或通过方法toBlobData(base64)转换"
    }
  ]

insertElm($el, tag)

向正文焦点处添加任意dom元素$el

$el: HTMLElement

tag: String, 可选参数,dom元素标签,如img/div/h2等

toBlobData(base64)

将图片base64转换为原始数据类型Blob(),该数据和表单中提交上传的数据同类型,故可以直接上传

@return new Blob() 返回Blob()数据

setImageSrc(imgId, imgUrl)

将ID为imgId的图片base64地址,替换为新的imgUrl。需配合getBase64Images()方法使用。

@return boolean

getContent(isInnerText)

获取正文内容html。

@params "isInnerText"可选,默认为false,获取编辑器innerHTML。否则获取innerText。

setContent(innerHTML)

设置编辑器内容,可用于初始化编辑器数据。

stopAutoSave()

开启自动保存时有效。停止自动保存编辑数据。

save()

保存编辑器内容

removeSave()

移除本地存储的content内容

filesToBase64(files, opts, callback)

图片文件数据转为base64/blob

参数 类型 说明
files 文件类型 文件数据数组
opts Object 图片压缩或裁剪参数{width:100,height:100,clip:true}
callback(errorArray, dataArray) errorArray:`null Array, dataArray:null Array` 文件处理完成回调函数

dataArray

null
// 或者
[
  {
    // 处理完成的dom节点对象
    element: "canvasElement|imageElement",
    // 文件类型
    type: "image/png",
    // 处理完成的图片宽度,根据传入的参数定
    width: 100,
    // 处理完成的图片高度
    height: 100,
    // blob数据
    data: "blob数据",
    // base64数据
    base64: "base64",
    // 文件大小B
    size: 15455,
    // blob url地址
    url: "blobUrl",
    // 原始图片数据参数
    rawdata: {}
  }
]

源码地址:https://github.com/capricornc...

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/96691.html

相关文章

  • GitHub 值得收藏的前项目[每月更新...]

    摘要:也是一款优秀的响应式框架站点所使用的一套框架为微信服务量身设计的一套框架一组很小的,响应式的组件,你可以在网页的项目上到处使用一个可定制的文件,使浏览器呈现的所有元素,更一致和符合现代标准。 GitHub 值得收藏的前端项目 整理与收集的一些比较优秀github项目,方便自己阅读,顺便分享出来,大家一起学习,本篇文章会持续更新,版权归原作者所有。欢迎github star与fork 预...

    maxmin 评论0 收藏0
  • 混合app开发框架

    摘要:混合式开发做出的手机应用无论在性能还是易用性方面都很接近原生应用。下面介绍几个流行的混合式开发框架。相比于其他开发框架,更加轻量,体积小巧。 目前混合式开发已经逐渐成熟,混合式app开发只需要要求开发者会使用css和js前端代码就可以实现手机app应用的开发,而不需要再去学习安卓或苹果开发,降低了app开发的门槛。混合式开发做出的手机应用无论在性能还是易用性方面都很接近原生app应用。...

    hot_pot_Leo 评论0 收藏0
  • 混合app开发框架

    摘要:混合式开发做出的手机应用无论在性能还是易用性方面都很接近原生应用。下面介绍几个流行的混合式开发框架。相比于其他开发框架,更加轻量,体积小巧。 目前混合式开发已经逐渐成熟,混合式app开发只需要要求开发者会使用css和js前端代码就可以实现手机app应用的开发,而不需要再去学习安卓或苹果开发,降低了app开发的门槛。混合式开发做出的手机应用无论在性能还是易用性方面都很接近原生app应用。...

    darkbug 评论0 收藏0

发表评论

0条评论

lansheng228

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<