npm 包 vue-mde 使用教程

介绍

Vue-mde 是一款基于 Vue.js 和 CodeMirror 的 Markdown 编辑器,易于集成和使用。本文将介绍如何使用 vue-mde 包创建 Markdown 编辑器,以及如何进行一些常见操作。

安装

使用 npm 安装 vue-mde:

--- ------- ------- ------

使用

在 Vue 组件中引入 vue-mde:

------ ------ ---- ----------

------ ------- -
  ----------- -
    -------
  --
--

使用 VueMde 组件:

----------
  -----
    -------- --------------------------
  ------
-----------

--------
------ ------- -
  ------ -
    ------ -
      ------ ---
    --
  --
--
---------

通过 v-model 可以将编辑器中的内容绑定到 Vue 中的数据。

配置

vue-mde 提供了一些可配置的选项,下面是一些常用的选项:

选项 描述 类型 默认值
value 绑定的值 String ''
mode 编辑器模式 'gfm' | 'markdown' | ... 'gfm'
toolbar 工具栏按钮 Array 见示例
tabSize 缩进大小 Number 2
lineNumbers 是否启用行号 Boolean false
autofocus 是否自动聚焦 Boolean false
readOnly 是否只读 Boolean false
placeholder 输入框占位符 String ''
minHeight 输入框的最小高度 String 'auto'
maxHeight 输入框的最大高度 String 'auto'

示例配置:

----------
  -----
    -------- --------------- ------------------ -----------------------
  ------
-----------

--------
------ ------- -
  ------ -
    ------ -
      ------ ---
      -------- -
        -
          ----- -------
          ----- --- ---------
          ------ -----
        --
        -
          ----- ---------
          ----- --- -----------
          ------ -----
        --
        -
          ----- ----------
          ----- --- -----------
          ------ -----
        --
        -
          ----- --------
          ----- --- ---------------
          ------ -----
        --
        -
          ----- -------
          ----- --- ---------
          ------ -----
        --
        -
          ----- -------
          ----- --- ---------
          ------ ------
        --
        -
          ----- --------
          ----- --- ----------
          ------ -----
        --
        -
          ----- -----------------
          ----- --- ------------
          ------ -------
        --
        -
          ----- ---------------
          ----- --- ------------
          ------ -------
        --
        -
          ----- ------------------
          ----- --- ----------
          ------ ------
        --
      --
    --
  --
--
---------

以上是一个包含默认工具栏按钮和缩进大小为 2 的示例配置。

事件

vue-mde 提供了一些常见的事件,可以通过 @v-on: 的方式绑定事件:

事件名称 描述 参数
input 输入时触发 当前输入的字符串
blur 失去焦点时触发
focus 获得焦点时触发
change 内容改变时触发 当前输入的字符串
preview 预览时触发 编辑器中的 Markdown
fullscreen 进入或离开全屏模式时触发 是否全屏
insert-image 插入图片时触发 图片的 base64
insert-link 插入链接时触发 插入链接的地址
insert-code 插入代码时触发 插入代码的语言
insert-table 插入表格时触发
bold 粗体按钮点击时触发
italic 斜体按钮点击时触发
heading 标题按钮点击时触发 标题级别 1-6
quote 引用按钮点击时触发
code 代码按钮点击时触发
link 超链接按钮点击时触发
image 图片按钮点击时触发
unordered-list 无序列表按钮点击时触发
ordered-list 有序列表按钮点击时触发
horizontal-rule 分割线按钮点击时触发
fullscreen-exit 离开全屏按钮点击时触发
fullscree-enter 进入全屏按钮点击时触发
insert-link 插入链接按钮点击时触发 链接地址
insert-image 插入图片按钮点击时触发 图片的 base64
insert-code 插入代码按钮点击时触发 插入代码的语言
insert-table 插入表格按钮点击时触发
insert-horizontal-rule 插入分割线按钮点击时触发

示例:

----------
  -----
    --------
      ---------------
      -------------------------------
      ---------------------------------
    -----------
  ------
-----------

--------
------ ------- -
  ------ -
    ------ -
      ------ ---
    --
  --
  -------- -
    ---------------------- -
      ------------------
    --
    ------------------------ -
      -------------------
    --
  --
--
---------

以上演示了如何捕获插入链接和插入图片事件,并在控制台中打印插入的链接和图片 base64。

结语

vue-mde 是一个易于使用和集成的 Markdown 编辑器,可以快速创建一个自定义的编辑器应用。本教程介绍了使用 vue-mde 的基本用法、配置选项和一些常用事件。如果您想了解更多关于 vue-mde 的信息,请查看 官方文档

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60056c5581e8991b448e5d69


猜你喜欢

  • npm包hijup-react-experiments使用教程

    概述 npm是一个包管理系统,它允许开发人员在项目中使用模块来构建应用程序。hijup-react-experiments是一个npm包,旨在为React应用程序中的实验性功能提供支持。

    3 年前
  • npm 包 shadowsocks-client-lib-js 使用教程

    在前端开发中,随着互联网的快速发展和全球化的普及,有时候需要访问国外的网站和资源,但是由于种种原因(如国家政策限制等),我们可能无法直接连接到这些网站。这时,我们可以通过使用 Shadowsocks ...

    3 年前
  • npm 包 oc-registry-graphql-express-middleware 使用教程

    前言 随着前端技术的不断发展,前端开发人员越来越需要使用后端技术来完成一些复杂的业务需求。而 GraphQL 技术的出现,则大大方便了前端开发人员在实现复杂业务逻辑时与后台进行通信。

    3 年前
  • npm 包 react-onclick-toggle-display 使用教程

    前言 React 是一种流行的 JavaScript 库,用于构建用于单页面应用程序(SPA)的界面。 它有一个强大的社区,其中有许多可复用的组件,可以通过 npm 包进行安装。

    3 年前
  • npm 包 interview-radio-nodejs 使用教程

    npm 包 interview-radio-nodejs 使用教程 前言 在前端面试中,常常会遇到手写代码的问题,其中离不开radio组件的使用。如果每次面试时都从头开始写radio组件的话,无疑增加...

    3 年前
  • npm 包 @anonym/rollup-plugin-legacy 使用教程

    介绍 在现代的 Web 开发中,我们经常需要将我们的代码打包成可运行在现代浏览器和旧版浏览器的 bundle 文件。为了适配旧版浏览器,我们需要使用一些兼容性处理的工具。

    3 年前
  • npm 包 hijup-react-masonry-infinite 使用教程

    简介 在网页开发中,使用瀑布流效果是一种非常常见的需求。而 hijup-react-masonry-infinite 是一个npm包,提供了瀑布流布局以及无限滚动的功能。

    3 年前
  • npm 包 @interpals/react-native-image-crop-picker 使用教程

    前言 在开发 React Native 应用时,图片的处理非常重要,但是图片的选择和裁剪等操作在 React Native 中并不是那么方便。这时就需要用到一个强大的 npm 包 @interpals...

    3 年前
  • npm 包 n-files 使用教程

    简介 npm 是 Node.js 的包管理工具,n-files 是一款专门用于读取本地文件的 npm 包。通过 n-files,可以实现读取本地文件的功能,同时还提供了一些操作文件路径和读取文件的方法...

    3 年前
  • npm 包 react-intlstrings 使用教程

    介绍 react-intlstrings 是一个基于 React 环境下的国际化字符串处理 npm 包。利用该包,您可以方便地将您的网站或应用进行本地化,并且无需频繁切换代码和语言。

    3 年前
  • npm 包 caad 使用教程

    前言 在前端开发过程中,我们常常需要用到一些数学计算,例如向量、矩阵、三角函数等等,这些计算涉及的内容较为复杂,为了方便开发,我们可以使用一些成熟的数学库来处理这些问题。

    3 年前
  • npm 包 de.compeople.cordova.screenshot 使用教程

    在前端开发中,截屏是一个非常常见的需求。当我们需要捕捉某个网页的截图,或者在APP中实现截屏功能时,我们可以使用 de.compeople.cordova.screenshot 这个 npm 包。

    3 年前
  • npm 包 aws-cloudwatch-log 使用教程

    很多前端开发人员在开发 web 应用时需要处理日志,aws-cloudwatch-log 是一个优秀的 npm 包,帮助我们将日志集成到 AWS CloudWatch Logs 中,方便我们进行日志管...

    3 年前
  • npm 包 instructions 使用教程

    什么是 npm 包 npm 包(Node Package Manager,官网)是 Node.js 社区中最重要的一部分,它通过将相关的代码封装成通用的可重用的 JavaScript 模块,使得每个人...

    3 年前
  • npm 包 google-map-react-2 使用教程

    简介 google-map-react-2 是一个基于 React 封装的用于展示谷歌地图的 npm 包。它提供了完整的地图组件和 API,使得在 React 应用中展示谷歌地图变得非常容易。

    3 年前
  • npm 包 react-native-passkit 使用教程

    概述 react-native-passkit 是一个用于 React Native 的插件,用于在 iOS 上创建、管理、删除和更新 Passbook Passes,支持 Apple Wallet ...

    3 年前
  • npm包 @schooltube/material-ui 使用教程

    简介 @schooltube/material-ui 是一个基于 Material Design 的 React 组件库。它提供了丰富、美观、易用的 UI 组件,使得开发人员可以快速构建现代化的 We...

    3 年前
  • npm 包 react-native-tv-box 使用教程

    介绍 react-native-tv-box 是一个为 React Native 应用设计的插件,它可以使你的 React Native 应用在电视盒子上更好的运行。

    3 年前
  • npm 包 eslint-config-konrad 使用教程

    前言 现今,前端开发的流程中,代码风格的规范成为了一个不可或缺的环节。而 eslint 是一个开源的 JavaScript 代码检查工具,可以检查常见的代码错误,还可以检查代码风格是否符合规范。

    3 年前
  • npm 包 syncwaiter 使用教程

    简介 在前端开发中,我们经常会遇到异步编程的场景,例如:与服务器通信、数据请求、图片加载等等。异步编程常常会带来一些问题,例如:代码可读性较差、嵌套层数过多、多个异步任务的执行顺序难以控制、代码复杂性...

    3 年前

相关推荐

    暂无文章