mathlive - npm Package Versions

0.66.0 2021-05-20

Breaking Changes

• The horizontalSpacingScale option is deprecated. It will be removed in an upcoming version and replaced by the standard TeX registers \thinmuskip, \medmuskip and \thickmuskip.

Improvements

• When the default-mode attribute (or the defaultMode property) of a <math-field> element is set to "inline-math", the element will be displayed as an inline element. Previously, the defaultMode affected the layout of the math content, but the element still behaved as a block.
• renderMathInDocument() now creates a <div> when using Display Style, and a <span> when using Text Style (inline math).

New Features

• #946 Support addding a custom stylesheet to a <math-field> when using the \class command.
• The mathfield options which are reflected as attributes (e.g. virtual-keyboard-mode) are now reflected as a property on the element mf.virtualKeyboardMode as a shortcut to mf.setOptions({virtualKeyboardMode:...}. This also allows to set these properties before the component is connected to the document.
• Added the following attributes to <math-field>: plonk-sound, keypress-sound. Setting them to 'none' turn off these sounds.
• Added support for definition of macro packages (see MacroPackageDefinition)
• Added support to selectively expand macro definitions. This avoid expanding common macro definitions (for example from amsmath.sty) when copying/pasting, while still expanding custom macros for improved compatibility.
• Added support for MediaWiki commands:

• \darr
• \dArr
• \Darr
• \lang
• \rang
• \uarr
• \uArr
• \Uarr
• \N
• \R
• \Z
• \alef
• \alefsym
• \Alpha
• \Beta
• \bull
• \Chi
• \clubs
• \cnums
• \Complex
• \Dagger
• \diamonds
• \empty
• \Epsilon
• \Eta
• \exist
• \harr
• \hArr
• \Harr
• \hearts
• \image
• \infin
• \Iota
• \isin
• \Kappa
• \larr
• \lArr
• \Larr
• \lrarr
• \lrArr
• \Lrarr
• \Mu
• \natnums
• \Nu
• \Omicron
• \plusmn
• \rarr
• \rArr
• \Rarr
• \real
• \reals
• \Reals
• \Rho
• \sdot
• \sect
• \spades
• \sub
• \sube
• \supe
• \Tau
• \thetasym
• \weierp
• \Zeta

• Added support for some additional amsmath commands:

• \varGamma
• \varDelta
• \varTheta
• \varLambda
• \varXi
• \varPi
• \varSigma
• \varUpsilon
• \varPhi
• \varPsi
• \varOmega

• Added support for the \displaylimits command

See Supported TeX/LaTeX Commands for more details.

Issues Resolved

• When a mathfield is created, then immediately removed from the document, do not crash. The creation of the mathfield triggered an asynchronous rendering and by the time the rendering was executed the mathfield was no longer valid. This situattion happened when using "tippyjs" and possibly other libraries.
• When a mathfield is read-only, do not display the focus outline.
• #943 When a tooltip for a custom virtual keyboard was provided, the label was set to "undefined".
• The DVIPS colors were case sensitive, they should be case sensitive. (i.e. LimeGreen is a valid color, Limegreen is not)
• #945 Preserve more aggressively verbatim LaTeX. Also, avoid serializing superfluous spaces in Spacing atoms.
• #770 Correctly handle attaching limits to \int command using the keyboard.
• Return the correct value for the mathfield element when it is not attached yet, even if the output format is not specified.
• Color specified with the rgb() function would not render correctly if the arguments contained some spaces, e.g.rgb ( 255 , 255 , 255 ).

0.65.0 2021-05-14

Breaking Changes

• The substituteTextArea option has been removed. This option was in fact not working so removing it will presumably have no impact.

New Features

• #939 Added access to \underline, \underbrace, \xleftarrow, etc... to the virtual keyboard.

Improvements

• On iPad OS and relevant Windows devices, support the detachable keyboard.
• In LaTeX mode, don't consider \\ (double-dash, i.e. end of line in tabular mode) as a valid command prefix.
• In LaTeX mode, don't recommend \{ as a command by default.
• Added \bigstar symbol
• Improved performance of renderMathInDocument() when there are many formulas on the page.

Architecture

• Renamed Span to Box.

Issues Resolved

• When using Firefox on Windows, the layout of the formula could shift by a fraction of a pixel when moving the caret.
• In LaTeX mode with nested expressions, the edited LaTeX was incorrect.

0.64.0 2021-05-09

Breaking Changes

• The FontSize type is now an integer between 1 and 10. It previously was size1, size2, etc... The default font size is 5, the smallest is 1. However, when using applyStyle(), the size can still be specified with size1, etc... The following size values can also be used: tiny, scriptsize, footnotesize, small, normal or normalSize, large, Large, LARGE, huge, Huge.

• Previously, named colors (yellow, red...) mapped to the dvips color set. They can now map to different values to improve their legibility. To ensure that a particular color is used, specify the colors as a hex triplet (#dd2233). See also the colorMap option.

  The following color names are recommended: they will map to values that have been optimized for legibility as a foreground or background color, they cover all the hues of the color circle and have been adjusted to provide similar apparent brightness and intensity:

  • colors: orange, yellow, lime, green, teal, blue, indigo, purple, magenta
  • shades of grey: black, dark-grey, grey, light-grey, white

New Features

• The background of fractions, radicals and parentheses group (\left/\right commands) is now highlighted when they contain the caret. This makes it easier to distinguish some cases when the cursor is at the edge of the element and could be either inside or outside. The appearance of the highliting can be controlled with the <del>--contains-highlight</del> --contains-highlight-background-color CSS variable. Set it to transparent to restore the previous behavior.

• colorMap option. To map a color name such as "yellow" to a custom RGB color, set the colorMap or backgroundColorMap option to a function that takes the color name as an argument and return a matching CSS RGB string. Return undefined to proceed with the default mapping.

• In macro dictionary, added option to expand or not the macro when using the latex-expanded output format (when copying to the clipboard, for example).

• Added the \overunderset{}{}{} command.

• Added the \lparen and \rparen delimiters.

• Added the \mod, \pmod and \bmod commands, defined as macros.

• Added support for dashed column separators in matrix, using ":" in the matrix preamble. See the arydshln package.

• Added support for optional below argument to \stackrel and \stackbin as per the stackrel package

• When using renderMathInDocument() or renderMathInElement(), ASCII Math format can be used. The default delimiters for ASCII Math are "" (backtick) and can be changed with the asciiMath.delimitersoption. To turn off this conversion and revert to the previous behavior, call renderMathInDocument({ asciiMath: null })`

Layout Improvements

• Substantial rewrite of the stacked layout algorithm (fractions, superscripts, etc...). The previous algorithm did not work correctly when mixing absolute sizing commands (\Huge) and relative ones (\scriptstyle) and had various issues and inconsistencies with what TeX produced. The result is now close to TeX.

• Display the placeholder symbol using the caret color.

• Added the --smart-fence-opacity and --smart-fence-color CSS variables.

• In the layout of superscript/subscript and accents, use the correct font metrics for spacing and layout (previously, the font metric for the base size was always used). This may result in very slightly different placement of superscripts, subscripts and limits (but closer to TeX).

• Fixed cases where the inter-atom spacing was incorrect (when spacing atoms or super/subscripts were used with a binary atom, or when some other atom types were used, such as BoxAtom and more).

Clipboard Improvements

• When pasting from the clipboard, recognize text bracketed with \begin{math}...\end{math} or \begin{displaymath}...\end{displaymath} as LaTeX (in addition to $, $$, \[...\] and \(...\) which were recognized before). Also, recognize text that may contain a LaTeX expression surrounded by regular text (i.e. "if $x > 0$").

• When pasting ASCIIMath, recognize more expression using standard functions such as the trig functions.

• Recognize text content surrounded with "`" (backtick) delimiters as ASCII Math.

• When copying to the clipboard, roundtrip verbatim latex when available, i.e. the content of the clipboard will be exactly what has been pasted in if the formula has not been edited.

Other Improvements

• The default color mapping function now returns different values when used as a line color or as a background color. This improves the legibility of colors. See MathLive Guide: Customizing.

• Paste operations are now undoable.

Architecture

• Avoid generating unnecessary empty span for limits and other constructs.

• Avoid repeating color attributes on child elements by lifting them to an appropriate parent. As a consequence, when a background color is applied it is displayed more uniformly than previously.

• Reduced the size of the font-metrics table.

• Increased the number of automated and static tests.

Issues Resolved

• The size and spacing of fractions in superscript did not match the TeX layout.
• Correctly apply TeX inter-atom spacing rules as per TeXBook p. 270. The spacing of two consecutive binary atoms (e.g. +-) was incorrect, as well as some other combinations.
• Correctly render \sqrt, \placeholder and many other atoms when a mathstyle is applied with commands such as \textstyle, \scriptstyle, etc...
• Correctly render selection rectangle of accent commands (\widehat).
• If a document called renderMathInDocument() and the document contained a mathfield with a value that contained exclusively an environment, the mathfield would not render (the \begin{} would be incorrectly rendered by renderMathInDocument()).
• When using renderMathInElement() or renderMathInDocument() use the same default letterShapeStyle as when using a mathfield, that is, french if the locale is French, tex otherwise.
• Fixed verbatim latex: when the value of the mathfield is set, if it is not modified, getValue('latex') will return exactly what was input.
• Fixed latex output of \exponentialE: when a superscript/subscript was applied to a macro, the latex output would become blank.
• Math characters with a bold italic style were displayed in regular italic.
• An input consisting of only \scriptstyle would crash.
• Allow navigation inside an empty skipBoundary atom.
• After a copy (command/control+C) command, the content of clipboard was incorrect if the end of the selection included some content in text mode.
• When rendering a placeholder in static mode, use a non-breaking space instead of nothing, which helps preserve a more accurate layout in some cases (for example in \sqrt[\placeholder{}}{x}
• Rules (e.g. from \rule{}{}) were not clickable and did not appear selected.
• Correctly roundtrip \char command when using latex-expanded format.

0.63.0 2021-04-24

New Features

• #788 Added virtualKeyboardState property to indicate if the virtual keyboard is currently visible or hidden. The property can also be modified to show or hide the virtual keyboard.
• In read-only mode, do not attempt to load the sounds and do not allow the virtual keyboard to be shown.
• Export version (previously available as MathLive.version).
• #199 Added infty and int inline shortcuts.

Issues Resolved

• #708 Pressing on the bottom part of the virtual keyboard keycap did not trigger the key action.
• The asset directory (fonts/sounds) was not properly located in some browsers when using a CDN to load MathLive.
• Correctly focus the mathfield when the virtual keyboard is invoked.

0.62.0 2021-04-23

Improvements

• #794 When a keycap on the virtual keyboard with associated alternate keys is long pressed, the other UI elements on the screen are ignored (a scrim element is inserted behind the panel to capture events).
• On iPad OS prevent the document selection from being altered after long-pressing an alternate key in some cases.

Issues Resolved

• A $$\chi_{13}$$ (0.1em) gap between the nucleus and the above element was missing in OverUnder atoms (\overset, etc...).
• On Safari iOS, correctly display the keyboard toggle glyph.
• #907 When using renderMathInElement() or renderMathInDocument(), formulas containing styling information would get too aggressively coalesced, dropping some styling.
• #910 Fixed an issue introduced in 0.61.0 where some content would not get rendered when calling renderMathInElement() or renderMathInDocument().

0.61.0 2021-04-22

Breaking Changes

• 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 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 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 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 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.