mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 08:55:15 +02:00
Code Issues Projects Releases Wiki Activity

MDL-79042 filter_mathjax: Notify on render completion

Browse Source
This commit is contained in:
Andrew Nicols 2023-08-25 14:25:12 +08:00
parent 9bfcd77d51
commit 92117d2bed
No known key found for this signature in database
GPG Key ID: 6D1E3157C8CFBF14
3 changed files with 44 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
filter/mathjaxloader/amd/build/loader.min.js vendored
View File

@ -2,10 +2,10 @@ define("filter_mathjaxloader/loader",["exports","core_filters/events"],(function
/**
* Mathjax JS Loader.
*
* @module filter_mathjaxloader
* @module filter_mathjaxloader/loader
* @copyright 2014 Damyon Wiese <damyon@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
let lang="",configured=!1;_exports.configure=params=>{let script=document.createElement("script");script.type="text/x-mathjax-config",script[window.opera?"innerHTML":"text"]=params.mathjaxconfig,document.getElementsByTagName("head")[0].appendChild(script),lang=params.lang,document.addEventListener(_events.eventTypes.filterContentUpdated,contentUpdated)};const setLocale=()=>{configured||void 0!==window.MathJax&&(window.MathJax.Hub.Queue((function(){window.MathJax.Localization.setLocale(lang)})),window.MathJax.Hub.Configured(),configured=!0)};_exports.typeset=()=>{if(!configured){setLocale();const elements=document.getElementsByClassName("filter_mathjaxloader_equation");elements&&elements.forEach((element=>{void 0!==window.MathJax&&window.MathJax.Hub.Queue(["Typeset",window.MathJax.Hub,element])}))}};const contentUpdated=event=>{if(void 0===window.MathJax)return;const processDelay=window.MathJax.Hub.processSectionDelay;window.MathJax.Hub.processSectionDelay=0,window.MathJax.Hub.Config({positionToHash:!1}),setLocale(),event.detail.nodes.forEach((node=>{if(!(node instanceof HTMLElement))return;node.getElementsByClassName("filter_mathjaxloader_equation").forEach((node=>{window.MathJax.Hub.Queue(["Typeset",window.MathJax.Hub,node])}))})),window.MathJax.Hub.processSectionDelay=processDelay};_exports.contentUpdated=contentUpdated}));
let lang="",configured=!1;_exports.configure=params=>{const script=document.createElement("script");script.type="text/x-mathjax-config",script[window.opera?"innerHTML":"text"]=params.mathjaxconfig,document.getElementsByTagName("head")[0].appendChild(script),lang=params.lang,document.addEventListener(_events.eventTypes.filterContentUpdated,contentUpdated)};const setLocale=()=>{configured||void 0!==window.MathJax&&(window.MathJax.Hub.Queue((function(){window.MathJax.Localization.setLocale(lang)})),window.MathJax.Hub.Configured(),configured=!0)},typesetNode=node=>{node instanceof HTMLElement&&(window.MathJax.Hub.Queue(["Typeset",window.MathJax.Hub,node]),window.MathJax.Hub.Queue([node=>{(0,_events.notifyFilterContentRenderingComplete)([node])},node]))};_exports.typeset=()=>{if(!configured){setLocale();const elements=document.getElementsByClassName("filter_mathjaxloader_equation");for(const element of elements)void 0!==window.MathJax&&typesetNode(element)}};const contentUpdated=event=>{if(void 0===window.MathJax)return;const processDelay=window.MathJax.Hub.processSectionDelay;window.MathJax.Hub.processSectionDelay=0,window.MathJax.Hub.Config({positionToHash:!1}),setLocale(),event.detail.nodes.forEach((node=>{if(!(node instanceof HTMLElement))return;node.querySelectorAll(".filter_mathjaxloader_equation").forEach((node=>typesetNode(node)))})),window.MathJax.Hub.processSectionDelay=processDelay};_exports.contentUpdated=contentUpdated}));
//# sourceMappingURL=loader.min.js.map

2
filter/mathjaxloader/amd/build/loader.min.js.map
View File

File diff suppressed because one or more lines are too long

60
filter/mathjaxloader/amd/src/loader.js
View File

@ -15,11 +15,14 @@
/**
* Mathjax JS Loader.
*
* @module filter_mathjaxloader
* @module filter_mathjaxloader/loader
* @copyright 2014 Damyon Wiese <damyon@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
import {eventTypes} from 'core_filters/events';
import {
eventTypes,
notifyFilterContentRenderingComplete,
} from 'core_filters/events';
/**
* The users current language - this can't be set until MathJax is loaded - so we need to store it.
@ -42,13 +45,12 @@ let configured = false;
* This does not load MathJAX yet - it addes the configuration to the head incase it gets loaded later.
* It also subscribes to the filter-content-updated event so MathJax can respond to content loaded by Ajax.
*
* @method configure
* @param {Object} params List of configuration params containing mathjaxconfig (text) and lang
*/
export const configure = (params) => {
// Add a js configuration object to the head.
// See "http://docs.mathjax.org/en/latest/dynamic.html#ajax-mathjax"
let script = document.createElement("script");
// See "https://docs.mathjax.org/en/v2.7-latest/advanced/dynamic.html"
const script = document.createElement("script");
script.type = "text/x-mathjax-config";
script[(window.opera ? "innerHTML" : "text")] = params.mathjaxconfig;
document.getElementsByTagName("head")[0].appendChild(script);
@ -64,7 +66,6 @@ export const configure = (params) => {
/**
* Set the correct language for the MathJax menus. Only do this once.
*
* @method setLocale
* @private
*/
const setLocale = () => {
@ -80,20 +81,44 @@ const setLocale = () => {
};
/**
* Called by the filter when an equation is found while rendering the page.
* Add the node to the typeset queue.
*
* @method typeset
* @param {HTMLElement} node The Node to be processed by MathJax
* @private
*/
const typesetNode = (node) => {
if (!(node instanceof HTMLElement)) {
// We may have been passed a #text node.
// These cannot be formatted.
return;
}
// MathJax 2.X does not notify when complete. The best we can do, according to their docs, is to queue a callback.
// See https://docs.mathjax.org/en/v2.7-latest/advanced/typeset.html
// Note that the MathJax.Hub.Queue() method will return immediately, regardless of whether the typesetting has taken place
// or not, so you can not assume that the mathematics is visible after you make this call.
// That means that things like the size of the container for the mathematics may not yet reflect the size of the
// typeset mathematics. If you need to perform actions that depend on the mathematics being typeset, you should push those
// actions onto the MathJax.Hub.queue as well.
window.MathJax.Hub.Queue(["Typeset", window.MathJax.Hub, node]);
window.MathJax.Hub.Queue([(node) => {
// The notifyFilterContentRenderingComplete event takes an Array of NodeElements or a NodeList.
// We cannot create a NodeList so we use an HTMLElement[].
notifyFilterContentRenderingComplete([node]);
}, node]);
};
/**
* Called by the filter when an equation is found while rendering the page.
*/
export const typeset = () => {
if (!configured) {
setLocale();
const elements = document.getElementsByClassName('filter_mathjaxloader_equation');
if (elements) {
elements.forEach((element) => {
if (typeof window.MathJax !== "undefined") {
window.MathJax.Hub.Queue(["Typeset", window.MathJax.Hub, element]);
}
});
for (const element of elements) {
if (typeof window.MathJax !== "undefined") {
typesetNode(element);
}
}
}
};
@ -101,7 +126,6 @@ export const typeset = () => {
/**
* Handle content updated events - typeset the new content.
*
* @method contentUpdated
* @param {CustomEvent} event - Custom event with "nodes" indicating the root of the updated nodes.
*/
export const contentUpdated = (event) => {
@ -120,10 +144,8 @@ export const contentUpdated = (event) => {
// We may have been passed a #text node.
return;
}
const mathjaxElements = node.getElementsByClassName('filter_mathjaxloader_equation');
mathjaxElements.forEach((node) => {
window.MathJax.Hub.Queue(["Typeset", window.MathJax.Hub, node]);
});
const mathjaxElements = node.querySelectorAll('.filter_mathjaxloader_equation');
mathjaxElements.forEach((node) => typesetNode(node));
});
window.MathJax.Hub.processSectionDelay = processDelay;
};