组件简介
vue-code-view
是一个基于 vue 2.x
、轻量级的代码交互组件,在网页中实时编辑运行代码、预览效果的代码交互组件。
使用此组件, 不论 vue
页面还是 Markdown
文档中的示例代码,效果如下:
组件的由来
当项目中页面或者 Markdown
文档包含大量代码时,使用 highlight.js
进行代码高亮后极大的增大了阅读性,但是当我们阅读时想要对当前代码进行编辑调试时,只能打开本地开发环境或者跳转至 codepen
codesandbox
等在线项目示例。即使是很简单的代码示例仍然避免不了上述场景的繁琐步骤!如果遇到网络不好,或者本地开发环境没有安装配置的情况,那就很遗憾了!
目前大多开源项目的 Markdown
文档示例大多支持了示例代码的实时渲染,可以在文档页面中看到源码的运行效果,提供了在线项目的跳转功能。当需要调试代码时,还是需要重复上述步骤,体验不是太友好。
那么能不能有这么一个组件能支持在页面中编辑代码,实时运行预览效果?在网络找了好久,没有找到 vue
版本,只看到了 react-code-view,受其启发,自已编写了一个 vue
版本组件 vue-code-view
!
组件功能
目前组件已实现的主要功能特性:
- 💻 代码可以在线编辑,实时预览效果。
- 🎨 代码编辑器支持代码高亮、光标行背景高亮、括号/标签匹配自动关闭、代码折叠。
- 🌈 基于vue的
SFC
解析,支持<template>
<script>
<style>
代码逻辑。 - 🌈 支持
<style>
CSS 预处理,目前实现sass
。 - 📑 支持
Markdown
示例实时渲染,需要自定义 loader 。
组件props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
theme | theme mode,支持 light / dark | light | dark |
dark |
showCode | 是否显示代码编辑器 | boolean | false |
source | 示例代码 | string | - |
renderToolbar | 自定义工具栏展示 | function | - |
errorHandler | 错误处理函数 | function | - |
debounceDelay | 错误处理防抖延迟(ms) | number | 300 |
项目资源列表
-
Github项目地址:vue-code-view
-
项目网站及在线示例: vue-code-view
-
NPM地址: vue-code-view
使用示例
安装
使用 npm
或 yarn
安装组件包。
npm i v