vue3中使用highlight.js实现代码高亮显示的代码示例

 更新时间:2025年04月10日 10:16:09   作者:鱼鱼鱼-YYY  
代码高亮是在网页开发中常见的需求之一,它可以使代码在页面上以不同的颜色或样式进行突出显示提高可读性,这篇文章主要介绍了vue3中使用highlight.js实现代码高亮显示的相关资料,需要的朋友可以参考下

1.highlight简介

Internet 上最受欢迎的 JavaScript 语法高亮工具,支持 Node.js 和 Web。

  • 192 种语言和 498 个主题
  • 自动语言检测
  • 适用于任何 HTML 标记
  • 零依赖
  • 兼容任何 JS 框架
  • 支持 Node.js 和 Deno

它里面有多种代码显示主题可供切换

具体可参考官方文档:highlight.js中文网

2.vue中的配置与使用

2.1 npm 下载highlight库 

npm install highlight.js
npm install --save @highlightjs/vue-plugin

2.2 在main.js文件中引入highlight库并进行注册

// 主题样式
import 'highlight.js/styles/atom-one-dark.css'
import 'highlight.js/lib/common'
import hljsVuePlugin from '@highlightjs/vue-plugin'
 
//注册组件
const app = createApp(App)

app.use(hljsVuePlugin)
app.mount('#app')

3 在页面中使用

3.1 直接在template中使用在main.js中注册的组件

<template>
  <highlightjs language="JavaScript" :autodetect="true" :code="code"></highlightjs>
</template>

<script setup>
  let code = `<div>npm install --save highlight.js</div>`
</script>

运行效果如下:

3.2 纯文本代码展示

使用<pre><code></code></pre>标签包裹代码文本

<template>
    <div v-html="message" class="content"></div>
</template>

<script setup>
import hljs from 'highlight.js';
// 引入组件样式
// import 'highlight.js/styles/default.css';
// import "highlight.js/styles/a11y-dark.css";
import "highlight.js/styles/atom-one-dark-reasonable.css";

import { ref, nextTick, watch, onMounted } from 'vue';

const message = ref('');

const codeContent = ref('');

onMounted(() => {
    renderCode();
    nextTick(() => {
        handleButtonClick();
    });
});

const renderCode = () => {
    // 需要展示的代码的纯文本
    const codeMsg = "javascript\n// 这是一个简单的 JavaScript 代码示例\nfunction sayHello() {\n    console.log(\"Hello, World!\");\n}\n\n// 调用函数\nsayHello();\n"

    // 去除字符串首尾的空格和空白字符串等
    codeContent.value = codeMsg.trim();

    const highlightedCode = hljs.highlightAuto(codeContent.value).value;

   message.value = `<pre style="margin-top: 10px;margin-bottom: 10px;position: relative;border-radius:8px;"><button style="position: absolute;top: 10px;right: 10px;cursor: pointer;" id='code'>复制</button><code style="border-radius:8px;" class="hljs">${highlightedCode}</code></pre>`

//     console.log(message.value,123);
    
}

// 添加点击事件
const handleButtonClick = () => {
    let button = document.getElementById(`code`);
    console.log(button,123121);
    
    if (button) {
        button.addEventListener('click', () => {
            copyCode(codeContent.value);
        });
    }
};

// 点击复制代码
const copyCode = (codeContent) => {
    
    navigator.clipboard.writeText(codeContent).then(() => {
      console.log('复制成功');
      alert('复制成功');
    //   ElMessage.success('复制成功');
    }).catch((error) => {
      console.error('复制失败:', error);
    });
};

</script>

<style scoped>
.content{
  line-height: 30px;
  font-size: 16px;
  font-weight: 400;
  color: #333;
  word-break: break-all;
  white-space: pre-wrap;
  margin-bottom: 5px;
}
</style>

运行效果如下

该js库中包含多种代码显示主题,可在不同使用的组件中引入不同的主体样式,以上是一个简单的示例,具体使用请参考Highlight.js 文档Highlight.js — highlight.js 11.9.0 文档

总结

到此这篇关于vue3中使用highlight.js实现代码高亮显示的文章就介绍到这了,更多相关vue3 highlight.js代码高亮显示内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Vue echarts封装实现流程

    Vue echarts封装实现流程

    这篇文章主要介绍了Vue echarts封装的实现,Echarts,它是一个与框架无关的JS图表库,但是它基于JS,这样很多框架都能使用它
    2023-01-01
  • vue安装less-loader依赖失败问题及解决方案

    vue安装less-loader依赖失败问题及解决方案

    这篇文章主要介绍了vue安装less-loader依赖失败问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • vue中的局部过滤器和全局过滤器代码实操

    vue中的局部过滤器和全局过滤器代码实操

    这篇文章主要分享的是vue中的局部过滤器和全局过滤器代码实操,下面文章主要以代码展现,具有一的的知识参考性,需要的小伙伴可以参考一下
    2022-02-02
  • vue cli3 配置proxy代理无效的解决

    vue cli3 配置proxy代理无效的解决

    今天小编就为大家分享一篇vue cli3 配置proxy代理无效的解决,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-10-10
  • 关于Vue Webpack2单元测试示例详解

    关于Vue Webpack2单元测试示例详解

    这篇文章主要给大家介绍了关于Vue Webpack2单元测试的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面跟着小编来一起学习学习吧。
    2017-08-08
  • vue嵌套组件传参实例分享

    vue嵌套组件传参实例分享

    这篇文章主要介绍了vue嵌套组件传参实例分享,本文以一个vue递归组件为例,探究多层嵌套后事件无法触发的问题,我们可以通过查看一Demo,便于快速了解,下文列举例子需要的小伙伴可以参考一下
    2022-04-04
  • Vue项目通过network的ip地址访问注意事项及说明

    Vue项目通过network的ip地址访问注意事项及说明

    这篇文章主要介绍了Vue项目通过network的ip地址访问注意事项及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • Vue.js实现watch属性的示例详解

    Vue.js实现watch属性的示例详解

    本文讨论了watch函数是如何利用副作用函数和options进行封装实现的,也通过调度函数去控制回调函数的立即执行和执行时机,还可以解决竞态问题,感兴趣的可以了解一下
    2022-04-04
  • vue3组件中v-model的使用以及深入讲解

    vue3组件中v-model的使用以及深入讲解

    在vue2中v-model使用的还是挺多的,不过这个指令一般是用在了输入框中,并且这个指令其实就是个语法糖,下面这篇文章主要给大家介绍了关于vue3组件中v-model的使用以及深入讲解的相关资料,需要的朋友可以参考下
    2021-09-09
  • 使用vue编写一个点击数字计时小游戏

    使用vue编写一个点击数字计时小游戏

    这篇文章主要为大家详细介绍了使用vue编写一个点击数字计时小游戏,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08

最新评论