天天看点

在vue中渲染数学公式 - MathJax

在vue中渲染数学公式 - MathJax

1.开发背景

目前在使用

vue

+

elementui

做一个考试管理系统,在做学生考试页面时需要用到数学公式,但是后台解析出来后不是图片,而且如果是图片的话放在题目里很怪,所以需要使用到

MathJax

去解析后台传过来的公式

后台返回的数据:

2.使用MathJax

2.1 引入CDN

在使用MathJax之前,需要通过CDN引入, 在

<body>

标签中添加:

注意 :如果是国内的话建议使用下面的链接

<link rel="dns-prefetch" href="//cdn.bootcss.com" />
<script type="text/javascript" src="//cdn.bootcss.com/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
           

2.2 配置MathJax

MathJax

的配置封装成一个函数:

详细配置可以参考

MathJax

官网,放在了文档最后。

let isMathjaxConfig = false; // 防止重复调用Config,造成性能损耗

const initMathjaxConfig = () => {
  if (!window.MathJax) {
    return;
  }
  window.MathJax.Hub.Config({
    showProcessingMessages: false, //关闭js加载过程信息
    messageStyle: "none", //不显示信息
    jax: ["input/TeX", "output/HTML-CSS"],
    tex2jax: {
      inlineMath: [["$", "$"], ["\\(", "\\)"]], //行内公式选择符
      displayMath: [["$$", "$$"], ["\\[", "\\]"]], //段内公式选择符
      skipTags: ["script", "noscript", "style", "textarea", "pre", "code", "a"] //避开某些标签
    },
    "HTML-CSS": {
      availableFonts: ["STIX", "TeX"], //可选字体
      showMathMenu: false //关闭右击菜单显示
    }
  });
  isMathjaxConfig = true; // 
};
           

2.3 使用MathJax渲染

MathJax

提供了

window.MathJax.Hub.Queue

来执行渲染。在执行完文本获取操作后,进行渲染操作:

if (isMathjaxConfig === false) { // 如果:没有配置MathJax
  initMathjaxConfig();
}

// 如果,不传入第三个参数,则渲染整个document
// 因为使用的Vuejs,所以指明#app,以提高速度
window.MathJax.Hub.Queue(["Typeset", MathJax.Hub, document.getElementById('app')]);
           
你也可以在组件中指定

Id

名称去渲染公式

2.4 修改默认样式

MathJax

默认样式在被鼠标

focus

的时候,会有蓝色边框出现。对于超长的数学公式,x方向也会溢出。

添加以下样式代码,覆盖原有样式,从而解决上述问题:

/* MathJax v2.7.5 from 'cdnjs.cloudflare.com' */
.mjx-chtml {
  outline: 0;
}
.MJXc-display {
  overflow-x: auto;
  overflow-y: hidden;
}
           

3. 注意事项

3.1 不要使用

npm

尽量不要使用

npm

,会出现很多未知问题,而且包的体积很大

如果是

vue

项目,直接在

public

文件夹的

index

文件的头部或者尾部添加

<script>

标签(CDN链接)

3.2多处使用

如果在很多地方都需要用到

MathJax

,可以在单独把配置项封装成一个JS文件,然后在main.js文件中导入并注册为全局JS

JS文件(globalVariable.js):

let isMathjaxConfig = false;//用于标识是否配置
const initMathjaxConfig = () => {
    if (!window.MathJax) {
        return;
    }
    window.MathJax.Hub.Config({
        showProcessingMessages: false, //关闭js加载过程信息
        messageStyle: "none", //不显示信息
        jax: ["input/TeX", "output/HTML-CSS"],
        tex2jax: {
            inlineMath: [["$", "$"], ["\\(", "\\)"]], //行内公式选择符
            displayMath: [["$$", "$$"], ["\\[", "\\]"]], //段内公式选择符
            skipTags: ["script", "noscript", "style", "textarea", "pre"] //避开某些标签
        },
        "HTML-CSS": {
            availableFonts: ["STIX", "TeX"], //可选字体
            showMathMenu: false //关闭右击菜单显示
        }
    });
    isMathjaxConfig = true; //配置完成,改为true
};
const MathQueue = function (elementId) {
  if (!window.MathJax) {
      return;
  }
  window.MathJax.Hub.Queue(["Typeset", window.MathJax.Hub, document.getElementById(elementId)]);//这里可以用原生的js调用name,class,id。
};
export default {
  isMathjaxConfig,
  initMathjaxConfig,
  MathQueue,
}
           

main.js文件中添加:

import globalVariable from './assets/js/globalVariable'
Vue.prototype.commonsVariable = globalVariable;
           

使用:如果是

vue

就在

mounted

钩子函数中写

this.$nextTick(function () { //这里要注意,使用$nextTick等组件数据渲染完之后再调用MathJax渲染方法,要不然会获取不到数据
    if(this.commonsVariable.isMathjaxConfig){//判断是否初始配置,若无则配置。
        this.commonsVariable.initMathjaxConfig();
    }
    this.commonsVariable.MathQueue("question-id");//传入组件id,让组件被MathJax渲染
})
           

3.3动态数据

在SPA单页应用中,数据是通过

Ajax

获取的。此时,需要在数据获取后,再执行渲染。

如果习惯

es5

,可以在回调函数中调用

window.MathJax.Hub.Queue

。但是更推荐

es6

,配合

Promise

async/await

来避免“回调地域”。

3.4第一次不显示问题,刷新后显示

这种何况应该是网速慢所以可以加一个定时器

setTimeout(() => {
            this.$nextTick(function () { //这里要注意,使用$nextTick等组件数据渲染完之后再调用MathJax渲染方法,要不然会获取不到数据
                if(this.commonsVariable.isMathjaxConfig){//判断是否初始配置,若无则配置。
                    this.commonsVariable.initMathjaxConfig();
                }
                this.commonsVariable.MathQueue("question-id");//传入组件id,让组件被MathJax渲染
            })
        },1000)
           

3.4 版本问题

对于不同版本或者不同CDN的

MathJax

,第二部分的样式覆盖的

class

名称不同。比如在

cdnboot

v2.7.0

版本中,样式覆盖的代码应该是下面这段:

/* MathJax v2.7.0 from 'cdn.bootcss.com' */
.MathJax {
  outline: 0;
}
.MathJax_Display {
  overflow-x: auto;
  overflow-y: hidden;
}
           

4. 更多资料

  • Mathjax官网
  • Mathjax中文文档

参考文档:https://www.cnblogs.com/geyouneihan/p/9743302.html

个人博客:http://www.aeiherumuh10.com/zeno-blog/

继续阅读