0

0

在 Angular 应用中动态刷新 Prism.js 语法高亮

花韻仙語

花韻仙語

发布时间:2025-10-04 12:27:12

|

522人浏览过

|

来源于php中文网

原创

在 angular 应用中动态刷新 prism.js 语法高亮

本文旨在解决 Angular 应用中,从数据库加载动态代码内容后,Prism.js 语法高亮无法自动更新的问题。通过利用 Prism.highlightElement() 方法,结合 Angular 的数据绑定和生命周期钩子,实现对特定代码块的精准高效刷新,确保动态加载的代码始终以正确的语法高亮形式呈现,提升用户体验。

引言

在现代 Web 应用中,展示代码片段并进行语法高亮是一个常见需求。Prism.js 是一个轻量级、可扩展的语法高亮库,因其简洁高效而广受欢迎。然而,当代码内容不是静态存在于 HTML 中,而是从数据库或其他异步源动态加载到 Angular 组件时,Prism.js 往往不会自动对新内容进行高亮。这通常会导致新加载的代码显示为纯文本,而非预期的带颜色高亮效果。

本教程将详细阐述如何在 Angular 应用中解决这一问题,确保动态加载的代码内容能够被 Prism.js 正确识别并高亮显示。

问题分析:Prism.js 的工作机制与动态内容

Prism.js 在页面加载时会扫描 DOM,查找带有特定 language-xxx 类的

 结构,并对其内容进行语法高亮。当通过 JavaScript 或 Angular 的数据绑定动态更改这些 
 标签内的文本内容时,Prism.js 不会默认重新扫描并高亮这些更新。为了使新内容生效,我们需要手动触发 Prism.js 的高亮机制。

Prism.js 提供了两种主要的刷新方法:

  • Prism.highlightAll(): 重新扫描整个 DOM 并高亮所有符合条件的元素。这在页面初始化时非常有用,但在动态更新时效率较低,因为它会处理所有元素,即使它们没有改变。
  • Prism.highlightElement(element): 仅对指定的 DOM 元素进行高亮。这是处理动态内容的理想选择,因为它允许我们精确控制需要刷新的代码块,从而提高性能。

解决方案:结合 Angular 生命周期与 Prism.highlightElement()

为了在 Angular 应用中动态刷新 Prism.js 高亮,我们需要在代码内容更新后,且 DOM 已经渲染了新内容时,调用 Prism.highlightElement() 方法。Angular 的数据绑定和生命周期钩子提供了完美的集成点。

科威旅游管理系统
科威旅游管理系统

该软件是以php+MySQL进行开发的旅游管理网站系统。系统前端采用可视化布局,能自动适应不同尺寸屏幕,一起建站,不同设备使用,免去兼容性烦恼。系统提供列表、表格、地图三种列表显示方式,让用户以最快的速度找到所需行程,大幅提高效率。系统可设置推荐、优惠行程,可将相应行程高亮显示,对重点行程有效推广,可实现网站盈利。系统支持中文、英文,您还可以在后台添加新的语言,关键字单独列出,在后台即可快速翻译。

下载

1. HTML 模板结构

首先,确保您的 HTML 模板遵循 Prism.js 的推荐结构,通常是

 组合,并绑定动态内容和语言类型。textarea 用于用户输入或显示原始文本,而 pre/code 组合用于高亮显示。

      {{currentCode}}
    

关键点:

  • #textArea: 用于引用
  • #pre: 用于引用
     元素,通常用于滚动同步和行号。
  • #codeContent: 用于引用 元素,这是 Prism.js 实际高亮的目标。
  • {{currentCode}}: Angular 数据绑定,将组件中的 currentCode 属性值显示在 标签内。
  • [ngClass]="['code', 'language-' + codeType]": 动态设置 code 和 language-xxx 类,codeType 属性决定了高亮的语言。

2. Angular 组件逻辑

在 Angular 组件中,我们需要管理代码内容、触发更新,并在 DOM 更新后通知 Prism.js 进行高亮。

import { Component, OnInit, AfterViewInit, AfterViewChecked, OnDestroy, ViewChild, ElementRef, Renderer2 } from '@angular/core';
import { FormBuilder, FormGroup } from '@angular/forms';
import { Subscription, fromEvent } from 'rxjs';
import * as Prism from 'prismjs'; // 确保正确导入 Prism.js

// 假设 DataService, ApiService, PrismService 已经定义
// PrismService 可能是一个封装了 Prism.js 方法的自定义服务,
// 但为了直接演示,我们此处直接使用 Prism 模块。

@Component({
  selector: 'app-display-sourcecode',
  templateUrl: './display-sourcecode.component.html',
  styleUrls: ['./display-sourcecode.component.css']
})
export class DisplaySourcecodeComponent implements OnInit, AfterViewInit, AfterViewChecked, OnDestroy {
  codeList: any[] = [];
  currentCode = ''; // 绑定到  标签的内容
  codeType = 'java'; // 初始代码语言

  form: FormGroup; // 表单组,用于管理 textarea 内容

  // 获取模板中的元素引用
  @ViewChild('textArea', { static: true }) textArea!: ElementRef;
  @ViewChild('codeContent', { static: true }) codeContent!: ElementRef;
  @ViewChild('pre', { static: true }) pre!: ElementRef; // 确保 pre 标签存在于模板中

  private sub!: Subscription; // 用于管理订阅

  // 标志位,用于控制 ngAfterViewChecked 中的高亮逻辑
  highlighted = false;

  constructor(
    private data_service: any, // 替换为实际的服务类型
    private api_service: any, // 替换为实际的服务类型
    private prismService: any, // 替换为实际的服务类型,如果存在
    private fb: FormBuilder,
    private renderer: Renderer2
  ) {
    this.form = this.fb.group({
      content: [''] // 初始化表单控件
    });
  }

  ngOnInit(): void {
    this.listenForm(); // 监听表单变化
    this.synchronizeScroll(); // 同步滚动
    this.loadSourceCodes(); // 页面初始化时加载代码
  }

  ngAfterViewInit() {
    // 视图初始化后,对初始内容进行高亮
    // 确保 Prism.js 脚本已加载且 codeContent 元素存在
    if (this.codeContent && this.codeContent.nativeElement.textContent && typeof Prism !== 'undefined' && Prism.highlightElement) {
      Prism.highlightElement(this.codeContent.nativeElement);
    }
  }

  ngAfterViewChecked() {
    // ngAfterViewChecked 在每次 Angular 检查完组件视图及其子视图后调用。
    // 我们利用 'highlighted' 标志来精确控制何时重新高亮。
    if (this.highlighted && this.codeContent && this.codeContent.nativeElement) {
      if (typeof Prism !== 'undefined' && Prism.highlightElement) {
        Prism.highlightElement(this.codeContent.nativeElement);
      } else {
        console.warn('Prism.highlightElement is not available. Ensure Prism.js is loaded correctly.');
      }
      this.highlighted = false; // 重置标志,避免不必要的重复高亮
    }
  }

  ngOnDestroy() {
    this.sub?.unsubscribe(); // 取消所有订阅,防止内存泄漏
  }

  // 监听 textarea 内容变化,并更新 code 块
  private listenForm() {
    this.sub = this.form.valueChanges.subscribe((val) => {
      // 假设 prismService.convertHtmlIntoString 负责将 textarea 内容转换为纯文本
      const modifiedContent = this.prismService.convertHtmlIntoString(val.content);
      this.renderer.setProperty(this.codeContent.nativeElement, 'innerHTML', modifiedContent);
      this.highlighted = true; // 设置标志,在 ngAfterViewChecked 中触发高亮
    });
  }

  // 同步 textarea 和 pre 标签的滚动
  private synchronizeScroll() {
    const localSub = fromEvent(this.textArea.nativeElement, 'scroll').subscribe(() => {
      const toTop = this.textArea.nativeElement.scrollTop;
      const toLeft = this.textArea.nativeElement.scrollLeft;

      if (this.pre) { // 确保 pre 元素存在
        this.renderer.setProperty(this.pre.nativeElement, 'scrollTop', toTop);
        this.renderer.setProperty(this.pre.nativeElement, 'scrollLeft', toLeft + 0.2);
      }
    });
    this.sub.add(localSub);
  }

  // 从数据库加载代码后,显示特定代码片段的方法
  displaySourceCode(item: any): void {
    // 1. 更新绑定到 `` 标签的 `currentCode` 属性
    this.currentCode = item.code;
    this.codeType = item.language || 'java'; // 假设 item 中包含语言信息

    // 2. 如果 `textarea` 也需要显示此内容,则更新表单控件
    // 使用 { emitEvent: false } 避免触发 `valueChanges` 订阅,从而防止无限循环。
    this.form.get('content')?.setValue(item.code, { emitEvent: false });

    // 3. 设置 `highlighted` 标志,通知 `ngAfterViewChecked` 进行高亮刷新
    this.highlighted = true;
  }

  // 从 API 加载所有代码列表
  loadSourceCodes(): void {
    this.codeList = [];
    this.api_service.getSourceCodes().subscribe((data: any[]) => {
      this.codeList = data;
      // 示例:加载后显示第一段代码
      if (this.codeList.length > 0) {
        this.displaySourceCode(this.codeList[0]);
      }
    });
  }
}

3. 关键点解析

  1. *`import as Prism from 'prismjs';`**: 确保在组件中正确导入 Prism.js。如果 Prism.js 是通过 CDN 或全局脚本加载的,则可能不需要此导入,但建议通过 npm 安装并导入以获得更好的类型支持和模块化。
  2. @ViewChild('codeContent', { static: true }) codeContent!: ElementRef;: 获取对 元素的引用。static: true 表示该元素在组件初始化时就存在于 DOM 中。
  3. currentCode 属性与数据绑定: {{currentCode}} 负责将组件中的 currentCode 值绑定到 标签的文本内容。当 currentCode 更新时,Angular 会自动更新 DOM。
  4. highlighted 标志: 这是一个布尔值标志,用于精确控制 ngAfterViewChecked 何时执行 Prism.js 高亮。只有当 highlighted 为 true 时,才会触发高亮逻辑。
  5. ngAfterViewChecked() 生命周期钩子:
    • 此钩子在 Angular 每次完成变更检测后执行。
    • 当 displaySourceCode 方法更新了 currentCode 并设置 highlighted = true 后,ngAfterViewChecked 会被触发。
    • 在 ngAfterViewChecked 内部

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

557

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

395

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

756

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

478

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

474

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1051

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

659

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

2

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3万人学习

CSS教程
CSS教程

共754课时 | 22.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号