Miscellaneous Components — MathJax 4.0 documentation (original) (raw)

There are several miscellaneous components that don’t fit into other categories. These are:

• startup
• ui/safe
• ui/lazy
• ui/menu
• adaptors/liteDOM
• core
• loader

They are described in more detail below.

startup

The startup component is the one that you would use if you are not using a combined component, but are using the load array in the loader section of your MathJax configuration to specify the components you want to load. Like you would a combined component, you load the startup component directly via a <script> tag, as in

This is the component that manages the global MathJax object. It is responsible for creating the needed objects (like the input and output jax), and for adding the typesetting and conversion methods described in the Typesetting Mathematics section.

See the Startup Options section for information about configuring this component.

ui/safe

The ui/safe component is intended for use in situations where your readers will be allowed to enter mathematical notation into your pages themselves, such as a question-and-answer site, or a blog with user comments. It filters the mathematics on the page to make sure that certain values within the mathematics are not misused by the reader to cause problems on your page. For example, the \href macro normally could be used to insert javascript: URLs into the page; the ui/safe extension can be used to prevent that.

See the Safe Extension Options section for more information on what is filtered and how to control the level of filtering being performed. See Typesetting User-Supplied Content for additional details.

ui/lazy

The ui/lazy component changes the way MathJax handles the timing for typesetting expressions in the page. Normally, MathJax will typeset all the expressions in one pass over the page. When there are many expressions in your document, that can take a significant amount of time, and cause a noticeable delay before the mathematics becomes available.

With the lazy extension, MathJax will only typeset expressions when they come into view in the browser. That means the user gets to see the mathematics at the top of the page (or wherever the initial link takes them on your page) right away, and MathJax won’t take time to typeset expressions that are never seen. This makes even pages with a lot of mathematics appear more performant.

If you have pages with many expressions, it may be a good idea for you to use the lazy extension.

See the Lazy Typesetting Options section for more information on See Lazy Typesetting for additional details.

adaptors/liteDOM

The adaptors/liteDOM component implements an alternative to the browser DOM that can be used to parse HTML pages outside of a browser. This can be used in Node applications that don’t have access to a browser DOM, or in webworkers that can’t access the document DOM.

See the The DOM Adaptor section for more information about DOM adaptors in MathJax.

core

The core component includes the code that is required for all other components, including the base classes for input and output jax, math documents, math items within those documents, DOM adaptors, and so on. This component is loaded automatically when needed, so you don’t usually have to load it yourself. But you can include it if you are creating your own combined component.

loader

The loader component contains the code needed to load other components. It is included automatically by thestartup component, but if you don’t want the features created by the startup module, you can use the loader component instead to load the MathJax component you need. You can even use it as a general loader for other javascript, if you want.

See the Loader Options section for information about configuring this component.