1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-15 12:40:28 +00:00
TiddlyWiki5/plugins/tiddlywiki/katex/wrapper.js
Jieao Song 62610f0666
Add custom macro editor for KaTeX plugin (#5933)
* Add custom macro editor for KaTeX plugin

* Use list

* Better escape

* Tweaks

* Remove const

* Catch bad macros

* Capitalize tags

* Name KaTeX-macro tiddlers properly

* UI tweaks

* Move input string to temp

* Improve UI; import macros using LaTeX cmd directly
2021-09-10 21:28:13 +01:00

100 lines
2.5 KiB
JavaScript

/*\
title: $:/plugins/tiddlywiki/katex/wrapper.js
type: application/javascript
module-type: widget
Wrapper for `katex.min.js` that provides a `<$latex>` widget. It is also available under the alias `<$katex>`
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
var katex = require("$:/plugins/tiddlywiki/katex/katex.min.js"),
chemParse = require("$:/plugins/tiddlywiki/katex/mhchem.min.js"),
Widget = require("$:/core/modules/widgets/widget.js").widget;
katex.macros = {};
katex.updateMacros = function() {
var tiddlers = $tw.wiki.getTiddlersWithTag("$:/tags/KaTeX/Macro"),
regex = /#\d/g, // Remove the arguments like #1#2
tid, macro, cmd;
for (var i=0; i < tiddlers.length; i++) {
tid = $tw.wiki.getTiddler(tiddlers[i]);
try {
macro = tid.fields["caption"];
macro = macro.replace(regex, "");
cmd = tid.fields["text"];
katex.macros[macro] = cmd;
} catch(ex) {// Catch the bad ones
};
};
};
var KaTeXWidget = function(parseTreeNode,options) {
this.initialise(parseTreeNode,options);
};
/*
Inherit from the base widget class
*/
KaTeXWidget.prototype = new Widget();
/*
Render this widget into the DOM
*/
KaTeXWidget.prototype.render = function(parent,nextSibling) {
// Housekeeping
this.parentDomNode = parent;
this.computeAttributes();
this.execute();
// Get the source text
var text = this.getAttribute("text",this.parseTreeNode.text || "");
var displayMode = this.getAttribute("displayMode",this.parseTreeNode.displayMode || "false") === "true";
katex.updateMacros();
// Render it into a span
var span = this.document.createElement("span"),
options = {throwOnError: false, displayMode: displayMode, macros: katex.macros};
try {
if(!this.document.isTiddlyWikiFakeDom) {
katex.render(text,span,options);
} else {
span.innerHTML = katex.renderToString(text,options);
}
} catch(ex) {
span.className = "tc-error";
span.textContent = ex;
}
// Insert it into the DOM
parent.insertBefore(span,nextSibling);
this.domNodes.push(span);
};
/*
Compute the internal state of the widget
*/
KaTeXWidget.prototype.execute = function() {
// Nothing to do for a katex widget
};
/*
Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
*/
KaTeXWidget.prototype.refresh = function(changedTiddlers) {
var changedAttributes = this.computeAttributes();
if(changedAttributes.text) {
this.refreshSelf();
return true;
} else {
return false;
}
};
exports.latex = KaTeXWidget;
exports.katex = KaTeXWidget;
})();