angular-katex v0.10.0

angular-katex

Display math with KaTex and AngularJS.

Requirements

• AngularJS
• KaTeX

Load into your app

You can get it from Bower

bower install angular-katex

or npm

npm install angular-katex

Load the script files in your application:

<script type="text/javascript" src="bower_components/angular/angular.js"></script>
<script type="text/javascript" src="bower_components/katex/dist/katex.min.js"></script>
<script type="text/javascript" src="bower_components/angular-katex/angular-katex.js"></script>

Add the specific module to your dependencies:

angular.module('myApp', ['katex', ...])

Usage examples

Live demo

<!-- Tag element -->
<katex>x^2</katex>

<!-- Attribute -->
<div katex>x^2</div>

<!-- Attribute value -->
<div katex="x^2"></div>

<!-- expr attribute value -->
<katex expr="x^2"></katex>

<!-- Bind to scope
  $scope.tex = {pow: 'x^2'}
  -->
<katex bind="tex.pow"></katex>

<!-- Set display mode -->
<katex expr="x^2" display-mode></katex>

<!-- Set error handler -->
<!-- on-error locals:
  $expr: (string) expression
  $err: (object) error
  $setText: (function) set element text
  -->
<katex expr="\" on-error="$setText('Bad Expression: ' + $expr + ' . ' + $err)"></katex>

<!-- Use auto-render -->
<div katex auto-render>
  <p>The following formula is rendered</p>
  $$x^2$$
</div>

To use the auto-render extension, the file auto-render.min.js is needed. If you installed katex with bower, it is inside bower_components/katex/dist/contrib.

Configuration

katexConfigProvider have the following properties:

• defaultOptions: object that is passed to the katex.render function as the options parameter. By default, it is {}.
• errorHandler: function that is called when there is an error while parsing the expression. It has three parameters: error, expression, element. It does not get called if katexOnError directive is used. By default, it appends a span element with the error message and the katex-error class: <span class="katex-error">Error: message</span>. This function can be used to use MathJax as a fallback.