Some format options have been renamed:

| Before | Now | | :------------------------------- | :-------------------------------- | | "spoken-ssml-withHighlighting" | "spoken-ssml-with-highlighting" | | "mathML" | "math-ml" | | "ASCIIMath" | "ascii-math" |

The old spelling is still accepted at runtime but it has been deprecated and you will be removed in a future update.

Improvements

In many cases, the layout of the formula is closer to the TeX layout.
Improved performance of hit testing, selection tracking and selection rendering for complex formulas.
Improved accuracy of hit-testing. Prevent children of elements with a captureSelection flag from being selectable.
More efficient rendering by generating simpler markup in some cases.
Dropped woff fonts. This change should be transparent, as all supported browsers support woff2 at this point.
Apply sizing commands (e.g. \Huge) to math mode. TeX is inconsistent in how it handles those. We choose to always apply them in math mode.
Added support for dcases environment: like cases but in displaystyle by default.
Correctly round trip \mbox by avoiding wrapping it with an unnecessary \text command.

New Features

#898. Setting the plonkSound or keypressSound option to null will suppress sound feedback.
PR#905. Added option to specify the container of the virtual keyboard. Contributed by Dominik Janković (https://github.com/djankovic). Thanks, Dominik!
Simplified the specification of virtual keyboards: the keycap class no longer needs to be specified for each keycap.
The defaultMode property or the default-mode attribute can be set to a value of inline-math to set the mathfield in inline math \textstyle by default.

Issues Resolved

Fixed LaTeX output of \htmlData, \cssId and \class commands.
Ignore commands that are only applicable in some modes when they are used in an incorrect mode.
Fixed styling of some characters, such as the ones from \cdot. The incorrect styling resulted in incorrect measurement and vertical layout of some characters.
Fixed rendering of \ne, \neq and \not.
When using renderMathInElement() or renderMathInDocument() do not duplicate the accessible node.
Correctly display e^x and d/dx in the functions virtual keyboard
Ensure the correct spacing around fractions.
In Safari, the fonts would not load. This was a regression due to a change in the behavior of the API to test if a font is loaded. Safari lies and always answer yes (to prevent fingerprinting).
Correctly parse the \displaystyle, \textstyle, \scriptstyle and \scriptscriptstyle commands: they apply to the commands to their right.
In a tabular environment (matrix, etc...) \displaystyle applies to the current cell only (not the whole array).
Moving forward in a group with the skipBoundary flag would not skip it.
In a sequence of atoms with skipBoundary, only the first one would be skipped.
In the virtual keyboard, some keycaps in the greek keyboard were displayed with the system font instead of the TeX font.
The selection rectangle for \int now accounts for the slant of the symbol.
When using convertLatexToMarkup() or renderMathInDocument() properly wrap the generated atoms in a root atom. Without it, some atoms render differently in static mode than in interactive mode.
#654 Added ASCII Math output for tabular environments (array, matrix, etc...)
If the basefont of the mathfield was large (>48px) the virtual keyboard toggle button would not be vertically centered in the field.
Correctly layout superscripts after \overset (they are adjacent, not over, unlike \overbrace).
The cases environment should be in inline mode (textstyle) by default.
Fixed keyboard navigation of \overbrace, \underbrace, etc...

0.60.1

Diff

arnog

published 0.60.1 • 3 years ago

Changelog

Source

0.60.1 2021-04-13

New Features

#793. Added '%' inline shortcut

Issues Resolved

#896. Touch events were not properly detected on FireFox.
When using the vite bundler, the library location could not be determined correctly. As a result, the assets (fonts and sounds) could not be loaded when in their default location.
#864 Fixed layout of \enclose{roundedbox} and other variants.
#822 When using the Vue.js wrapper, the caret would jump to end of input field when typing a character in the middle of the formula
When changing options with setOptions() avoid changing the selection unless necessary (react-mathlive issue #4).

0.60.0

Diff

arnog

published 0.60.0 • 3 years ago

Changelog

Source

0.60.0 2021-04-12

Breaking Change

Renamed getCaretPosition() and setCaretPosition() to get/set caretPoint.

"Position" refers to where the caret/insertion point is, as an offset inside the expression. These methods return client screen coordinates and the new name better reflect the correct terminology.
Removed deprecated (April 2019) method enterCommandMode()
Replaced ignoreSpacebarInMathMode option with mathModeSpace. The ignoreSpacebarInMathMode was accidentally not working (#859). However, the boolean form is problematic as an element attribute (it defaults to true, but element attributes default to false). It has been replaced with mathModeSpace which is more flexible (you can specify which space to use) and doesn't have the issue of the default boolean value.

New Features

Support for iframes. Multiple mathfields in a single document but in different iframes can now share a single virtual keyboard. In the main document, use:
```
makeSharedVirtualKeyboard({
  virtualKeyboardLayout: 'dvorak',
});
```
And in the iframes, use the use-shared-virtual-keyboard attribute:
```
<math-field use-shared-virtual-keyboard></math-field>
```
See examples/iframe for more info.

Contribution by https://github.com/alexprey. Thanks!
#555 Support for IME (Input Method Engines) for Japanese, Chinese, Korean and other complex scripts.
applyStyle() has now more options. Previously it always toggled the style of the selection. Now it can either toggle or set the style, and modify the selection or a specific range.
#387 find() method to search the fragments of an expression that match a LaTeX string or regular expression.

For example the following code snippet will add a yellow background to the fractions in the expression:
```
mf.find(/^\\frac{[^}]*}{[^}]*}\$/).forEach((x) => {
  mf.applyStyle({ backgroundColor: 'yellow' }, x, {
    suppressChangeNotifications: true,
  });
});
```
#387 replace() method to replace fragments of an expression.

This method is similar to the replace() method of the String class. The search pattern can be specified using a string or regular expression, and the replacement pattern can be a string or a function. If using a regular expression, it can contain capture groups, and those can be references in the replacement pattern.

The following snippet will invert fractions in a formula:
```
mf.replace(/^\\frac{([^}]*)}{([^}]*)}$/, '\\frac{$2}{$1}');
```
New LaTeX Mode

This mode replaces the previous Command Mode. While the Command Mode (triggered by pressing the \ or ESC key) was only intended to insert a single LaTeX command (e.g. "\aleph"), the LaTeX Mode is a more comprehensive LaTeX editing mode.

To enter the LaTeX Mode, press the ESC key or the \ key. While in this mode, a complex LaTeX expression can be edited. Press the ESC or Return key to return to regular editing mode.

To quickly peek at the LaTeX code of an expression, select it, then press ESC. Press ESC again to return to the regular editing mode.

To insert a command, press the \ key, followed by the command name. Press the TAB key to accept a suggestion, then the RETURN key to return to regular editing mode (previously pressing the TAB key would have exited the command mode).
Added soundsDirectory option to customize the location of the sound files, similarly to fontsDirectory.
Enabled audio feedback by default.
#707 added support for \begin{rcases}\end{rcases} (reverse cases, with brace trailing instead of leading)
#730 added new CSS variables to control the height of the virtual keyboard:
- --keycap-height
- --keycap-font-size
- --keycap-small-font-size (only if needed)
- --keycap-extra-small-font-size (only if needed)
- --keycap-tt-font-size (only if needed)
#732 Support for Dvorak keyboard layout
Synchronize the virtual keyboard layout (QWERTY, AZERTY, etc...) with the physical keyboard layout.
Added \htmlData command, which takes as argument a comma-delimited string of key/value pairs, e.g. \htmlData{foo=green,bar=blue}. A corresponding data-foo and data-bar DOM attribute is generated to the rendered DOM.

Issues Resolved

#805: exponent towers did not display correctly
#857: when a mathfield was in read-only mode, it was still possible to delete a portion of it by pressing the backspace key.
#818: on iPad OS 14 and later, Safari pretends to be macOS ("Desktop Mode"). This interfered with the handling of the MathLive virtual keyboard.
The selection in an expression could render incorrectly if it was displayed before the fonts were fully loaded. This situation is now handled correctly and the selection is redrawn when fonts finish loading.
The typedText selector dropped its options argument. As a result, the sound feedback from the virtual keyboard only played for some keys.
#697 When using the <math-field> element the command popover did not display correctly.
Fixed issues with copy/paste. Copying from a text zone will copy the text (and not a latex representation of it). Copy from a LaTeX zone now works.
#816 Fixed some issues with keybindings on some keyboards, such as Swiss German. The physical keyboard layout was not always recognized, and some keybindings conflicted with each other.

Improvements

Improved handling of paste commands: if a JSON item is on the clipboard it is used in priority, before a plain/text item.
It is now possible to type dead keys such as alt+e, and they are properly displayed as a composition (side effect of the fix for #555).
#807 Support for AZERTY keyboard layout on Linux.

Architecture

Complete rewrite of selection handling.

This is mostly an internal change, but it will offer some benefits for new capabilities in the public API as well.

Warning: This is a very disruptive change, and there might be some edge cases that will need to be cleaned up.

The position of the insertion point is no longer represented by a path. It is now an offset from the start of the expression, with each possible insertion point position being assigned a sequential value.

The selection is no longer represented with a path and a sibling-relative offset. It is now a range, i.e. a start and end offset. More precisely, the selection is an array of ranges (to represent discontinuous selections, for example a column in a matrix) and a direction.

These changes have these benefits:
- The selection related code is more expressive and much simpler to read and debug
- The code is also simpler to change so that changes in UI behavior are much easier to implement. There are several open issues that will be much easier to fix now. In particular, the onDelete function now regroups all the special handling when pressing the Backspace and Delete keys.
- Instead of the esoteric paths, the concept of position as an offset is much easier to explain and understand, and can now be exposed in the public API. Consequently, new functionality can be exposed, such as the find() method which returns its results as an array of ranges. It is also possible now to query and change the current selection, and to apply styling to a portion of the expression other than the selection.
- The selection is represented as an array of ranges to support discontinuous selections, which are useful to select for example all the cells in the column of a matrix column. This kind of selection was not previously possible.
- Incidentally this fixes a circular dependency, which was a smell test that there was a problem with the previous architecture.
On a historical note, the reason for the original implementation with paths was based on the TeX implementation: when rendering a tree of atoms (which TeX calls nodes), the TeX layout algorithm never needs to find the parent of an atom. The MathLive rendering engine was implemented in the same way. However, for interactive editing, being able to locate the parent of an atom is frequently necessary. The paths were a mechanism to maintain a separate data structure from the one needed by the rendering engine. However, they were a complex and clumsy mechanism. Now, a parent property has been introduced in instance of Atom, even though it is not necessary for the rendering phase. It does make the handling of the interactive manipulation of the formula much easier, though.
Changes to the handling of sentinel atoms (type "first")

This is an internal change that does not affect the public API.

Sentinel atoms are atoms of type "first" that are inserted as the first element in atom branches. Their purpose is to simplify the handling of "empty" lists, for example an empty numerator or superscript.

Previously, these atoms where added when an editable atom tree was created, i.e. in the editor code branch, since they are not needed for pure rendering. However, this created situations where the tree had to be 'corrected' by inserting missing "first". This code was complex and resulted in some unexpected operations having the side effect of modifying the tree.

The "first" atoms are now created during parsing and are present in editable and non-editable atom trees.
Refactoring of Atom classes

This is an internal change that does not affect the public API.

Each 'kind' of atom (fraction, extensible symbol, boxed expression, etc...) is now represented by a separate class extending the Atom base class (for example GenfracAtom). Each of those classes have a render() method that generates a set of DOM virtual nodes representing the Atom and a serialize() method which generates a LaTeX string representing the atom.

Previously the handling of the different kind of atoms was done procedurally and all over the code base. The core code is now much smaller and easier to read, while the specialized code specific to each kind of atom is grouped in their respective classes.
Unit testing using Jest snapshot

Rewrote the unit tests to use Jest snapshots for more comprehensive validation.

0.59.0

Diff

arnog

published 0.59.0 • 4 years ago

Changelog

Source

0.59.0 2020-11-04

Issues Resolved

#685 Virtual keyboard event listeners were not properly released when the mathfield was removed from the DOM

0.58.0

Diff

arnog

published 0.58.0 • 4 years ago

Changelog

Source

0.58.0 2020-10-11

New Features

#225 Added onCommit listener to mf.options. This listener is invoked when the user presses Enter or Return key, or when the field loses focus and its value has changed since it acquired it. In addition, a change event is triggered when using a MathfieldElement. The event previously named change has been renamed to input. This mimics the behavior of <input> and <textarea> elements.
#225 Changed the keyboard shortcuts to add columns and rows:

| Shortcut | Command | | :-------------------------------------------------- | :---------------- | | ctrl/cmd + Return/Enter | addRowAfter | | ctrl/cmd + shift + Return/Enter | addRowBefore | | ctrl/cmd + ; | addRowAfter | | ctrl/cmd + shift + ; | addRowBefore | | ctrl/cmd + , | addColumnAfter | | ctrl/cmd + shift + , | addColumnBefore |

Note that Enter/Return no longer create a matrix/vector when inside a parenthesized expression. Use ctrl/cmd + Return/Enter instead.
Added a commit command to programmatically trigger the onCommit listener change event.
Added mount and unmount events to MathfieldElement
The $text() method, which is deprecated, was accidentally prematurely removed. It has been added back.

Issues Resolved

Inline shortcuts would not always be triggered correctly, for example x=sin → x\sin instead of x=\sin
The text in tooltip was not vertically centered in narrow layouts (mobile devices)
#668 Extensible symbols, such as \xrightarrow were incorrectly treated as if they had an invisible boundary, resulting in the cursor being positioned incorrectly when navigating with the keyboard.

0.57.0

Diff

arnog

published 0.57.0 • 4 years ago

Changelog

Source

0.57.0 2020-10-09

Major New Feature

This release introduce two major new features which will require code changes. For now, the older API remains supported but it will be dropped in an upcoming release.

#665: Web Component

Support for MathfieldElement custom element/web component and <math-field> tag.

The makeMathField() function is still supported, but it will be removed in an upcoming version. You should transition to using <math-field> or MathfieldElement instead.

This transition require the following changes:

Create mathfields using MathfieldElement or declaratively

// Before
let mf = MathLive.makeMathField(document.createElement('div'), {
  virtualKeyboardMode: 'manual',
});
mf.$latex('f(x) = \\sin x');
document.body.appendChild(mf.$el());

// After
let mfe = new MathfieldElement({
  virtualKeyboardMode: 'manual',
});
mfe.value = 'f(x) = \\sin x';
document.body.appendChild(mfe);

or:

<math-field virtual-keyboard-mode="manual">f(x) = \sin x</math-field>

Use events instead of callbacks

    // Before
    mf.setConfig({ onContentDidChange: (mf) => {
        console.log(mf.$latex())
    });

    // After
    mfe.addEventListener('input', (ev) => {
        console.log(mfe.value);
    });

#667 Modernized Public API

Support for web component is an opportunity to revisit the MathLive public API and modernize it.

The goals are:

clarity. For example, the $latex() can be used to read or change the content of the mathfield.
expressiveness. For example, $selectedText() can return the value of the selection, but there is no way to inspect (or save/restore) the selection.
consistency with web platform APIs when applicable, otherwise following the monaco (VSCode editor) or CodeMirror conventions primarily. As part of this proposal, the APIs of TinyMCE, CKEditor and QuillJS were also considered. For example, the method equivalent to getConfig() is called getOptions() in most Javascript text editor libraries.

Mathfield methods

The following Mathfield methods have been renamed as indicated:

The methods indicated with "n/a" in the After column have been dropped.

Only the new methods are available on MathfieldElement (i.e. when using web components). The Mathfield class retains both the old methods and the new ones to facilitate the transition, but the old ones will be dropped in an upcoming version.

There is also a new selection property on Mathfield and MathfieldElement which can be used to inspect and change the selection and a position property to inspect and change the insertion point (caret).

The getValue() method also now take an (optional) Range, which is the type of the selection property, to extract a fragment of the expression.

Default Exports

While default exports have the benefits of expediency, particularly when converting an existing code base to ES Modules, they are problematic for effective tree shaking. Therefore the default export will be eliminated.

This means that instead of:

import MathLive from 'mathlive';
MathLive.renderMathInDocument();

you will need to use:

import { renderMathInDocument } from 'mathlive';
renderMathInDocument();

The following functions have been renamed:

New Features

#101: added getCaretPosition() and setCaretPosition()

Improvements

The Typescript types for Selector has been improved
The Typescript type for getOptions() (getConfig()) are more accurate
The "sqrt" inline shortcut now inserts an argument
Don't throw an error if the first argument of \enclose is empty
#591: add upward and downward hooks when navigating out of the mathfield (now also sent as a focus-out event)
Improved layout of the virtual keyboard on narrow mobile devices (fill the available width).

Issues Resolved

#198: typing backspace while typing inline shortcuts would prevent the shortcuts from being recognized
#573: brackets were not properly styled (i.e. color applied to them)
#543: spurious focus/blur events were dispatched if tabIndex was set to 0 on the mathfield and some area of the mathfield were clicked on. The issue was that with tabIndex="0" the mathfield frame would be focusable and when that happened the focus would correctly switch to the invisible <textarea> element which is normally focused to receive keyboard events, but this generated an incorrect blur event (for the container losing focus) and an incorrect focus event (for the <textarea> gaining focus)
#599: some characters, for example "ü", would not be correctly parsed or displayed. Note that technically, those characters are ignored by TeX, but it's a reasonable behavior nowadays to accept them as input.
#628: typing "e" repeatedly inside a matrix would corrupt the emitted
#637: in Chrome, thin lines, such as fraction bars or square root lines would not display at some zoom levels
The locale was not properly taking into account when it was set manually
The config.strings property did not reflect the state of the localization strings
When configs was updated (e.g. new macros added), the content of the mathfield was not properly re-parsed and rendered
When making the virtual keyboard visible, the mathfield would not be focused
The virtual keyboard would not display correctly when the mathfield was inside a shadow DOM

Special Thanks

Thanks to @stefnotch for contributing several of the improvements in this release

0.56.0

Diff

arnog

published 0.56.0 • 4 years ago

Changelog

Source

0.56.0 2020-08-22

New Features

Added support for \phantom, \vphantom, \hphantom and \smash[]
#182 Added support for the mhchem package, with the commands \ce and \pu, to display chemical equations

0.55.0

Diff

arnog

published 0.55.0 • 4 years ago

Changelog

Source

0.55.0 2020-08-17

New Features

WebPack issues workaround and font loading configuration

Follow up to #508. The fonts can now be loaded either statically or dynamically.
- dynamic loading by default, the fonts will get loaded programmatically when they are needed and the rendering will be deferred until the fonts are available to avoid unnecessary redrawing. Use this technique if you have a simple build/bundle workflow. You can still customize the relative path to the fonts folder using the fontsDirectory configuration option.
- static loading include the mathlive-fonts.css stylesheet in your page. The loading of this file will trigget the font to be loaded asynchronously by the browser. Use this technique if you are using WebPack or have a build/bundle workflow that renames the font files or in general require the bundler to know about the required assets.
New packaging options. The distribution files have been split between minified and non-minified version. In the more common cases, the minified version (mathlive.min.js and mathlive.min.mjs should be used). The non-minified version (mathlive.js and mathlive.mjs can be used to help in debugging issues or to apply patches).

Issues Resolved

The fonts failed to load when loading MathLive using a <script> tag and a CDN. The fonts folder is now resolved correctly with the following configurations:
```
- `<script>` tag and CDN
- `<script>` tag and local file
- `import` and CDN
- `import` and local file
```

0.54.1

Diff

arnog

published 0.54.1 • 4 years ago

0.54.0

Diff

arnog

published 0.54.0 • 4 years ago

Changelog

Source

0.54.0 2020-06-24

Issues Resolved

#490 Firefox does not load fonts There is a bug in Firefox (https://bugzilla.mozilla.org/show_bug.cgi?id=1252821) where the status of fonts is reported incorrectly.

Implemented a workaround by always loading fonts in Firefox.
#506 Chrome was outputing a harmless warning about passive event listeners. The warning has been silenced.
#505 Chrome was outputing a harmless warning about passive event listeners. The warning has been silenced with extreme prejudice.
#503 Dynamic styles were not applied inside of shadow DOM

…

mathlive - npm Package Versions

0.61.0

.css-1z04cui{margin-bottom:var(--chakra-space-4);font-size:var(--chakra-fontSizes-md);}0.61.0 2021-04-22

Breaking Changes

Improvements

New Features

Issues Resolved

0.60.1

0.60.1 2021-04-13

New Features

Issues Resolved

0.60.0

0.60.0 2021-04-12

Breaking Change

New Features

Issues Resolved

Improvements

Architecture

0.59.0

0.59.0 2020-11-04

Issues Resolved

0.58.0

0.58.0 2020-10-11

New Features

Issues Resolved

0.57.0

0.57.0 2020-10-09

Major New Feature

#665: Web Component

#667 Modernized Public API

New Features

Improvements

Issues Resolved

Special Thanks

0.56.0

0.56.0 2020-08-22

New Features

0.55.0

0.55.0 2020-08-17

New Features

Issues Resolved

0.54.1

0.54.0

0.54.0 2020-06-24

Issues Resolved

0.61.0 2021-04-22