MathLive

module mathliveClasses

const mf = document.getElementById('mathfield');
mf.executeCommand('selectAll');
mf.executeCommand('copyToClipboard');


Commands return true if they resulted in a dirty state.

Auto-complete

executeCommand("complete"): boolean

executeCommand("nextSuggestion"): boolean

executeCommand("previousSuggestion"): boolean

Clipboard

executeCommand("copyToClipboard"): boolean

executeCommand("cutToClipboard"): boolean

executeCommand("pasteFromClipboard"): boolean

Deleting

executeCommand("deleteAll"): boolean

executeCommand("deleteBackward"): boolean

executeCommand("deleteForward"): boolean

executeCommand("deleteNextWord"): boolean

executeCommand("deletePreviousWord"): boolean

executeCommand("deleteToGroupEnd"): boolean

executeCommand("deleteToGroupStart"): boolean

executeCommand("deleteToMathFieldEnd"): boolean

executeCommand("deleteToMathFieldStart"): boolean

Scrolling

executeCommand("scrollIntoView"): boolean

executeCommand("scrollToEnd"): boolean

executeCommand("scrollToStart"): boolean

Selection

executeCommand("extendSelectionBackward"): boolean

executeCommand("extendSelectionDownward"): boolean

executeCommand("extendSelectionForward"): boolean

executeCommand("extendSelectionUpward"): boolean

executeCommand("extendToGroupEnd"): boolean

executeCommand("extendToGroupStart"): boolean

executeCommand("extendToMathFieldEnd"): boolean

executeCommand("extendToMathFieldStart"): boolean

executeCommand("extendToNextBoundary"): boolean

executeCommand("extendToNextWord"): boolean

executeCommand("extendToPreviousBoundary"): boolean

executeCommand("extendToPreviousWord"): boolean

executeCommand("moveAfterParent"): boolean

executeCommand("moveBeforeParent"): boolean

executeCommand("moveDown"): boolean

executeCommand("moveToGroupEnd"): boolean

executeCommand("moveToGroupStart"): boolean

executeCommand("moveToMathFieldEnd"): boolean

executeCommand("moveToMathFieldStart"): boolean

executeCommand("moveToNextChar"): boolean

executeCommand("moveToNextPlaceholder"): boolean

executeCommand("moveToNextWord"): boolean

executeCommand("moveToOpposite"): boolean

executeCommand("moveToPreviousChar"): boolean

executeCommand("moveToPreviousPlaceholder"): boolean

executeCommand("moveToPreviousWord"): boolean

executeCommand("moveToSubscript"): boolean

executeCommand("moveToSuperscript"): boolean

executeCommand("moveUp"): boolean

executeCommand("selectAll"): boolean

executeCommand("selectGroup"): boolean

Undo/Redo

executeCommand("redo"): boolean

executeCommand("undo"): boolean

Virtual Keyboard

executeCommand("hideVirtualKeyboard"): boolean

executeCommand(["showVirtualKeyboard", theme: VirtualKeyboardTheme]): boolean
theme: VirtualKeyboardTheme

executeCommand(["toggleVirtualKeyboard", theme: VirtualKeyboardTheme]): boolean
theme: VirtualKeyboardTheme

Other

executeCommand(["applyStyle", style: Style]): boolean
style: Style

executeCommand("commit"): boolean

executeCommand(["insert", s: string, options: InsertOptions]): boolean
s: string
options: InsertOptions

executeCommand("insertDecimalSeparator"): boolean

executeCommand(["performWithFeedback", command: string]): boolean
command: string

Perform a command and include interactive feedback such as sound and haptic feedback. This is useful to simulate user interaction, for example for commands from the virtual keyboard

executeCommand(["speak", scope: SpeechScope, options: {withHighlighting: boolean}]): boolean
scope: SpeechScope
options:
withHighlighting: boolean;

In addition to speaking the requested portion of the formula, visually highlight it as it is read (read aloud functionality)

executeCommand(["switchMode", mode: ParseMode]): boolean
mode: ParseMode

executeCommand("toggleKeystrokeCaption"): boolean

executeCommand(["typedText", options: {feedback: boolean; focus: boolean; simulateKeystroke: boolean}]): boolean
options:
feedback: boolean;

If true, provide audio and haptic feedback

focus: boolean;

If true, the mathfield will be focused

simulateKeystroke: boolean;

If true, generate some synthetic keystrokes (useful to trigger inline shortcuts, for example).

Implemented by MathfieldElement

Accessing the Content

getValue(format?)
format?: OutputFormat

The format of the result

Default: "latex"

string

Return a textual representation of the content of the mathfield.

getValue(start: number, end: number, format?: OutputFormat): string

Return the value of the mathfield from start to end

getValue(range: Range | Selection, format?: OutputFormat): string

Return the value of the mathfield in range

setValue(latex?: string, options?: InsertOptions): void

Set the content of the mathfield to the text interpreted as a LaTeX expression.

Changing the Content

insert(s: string, options?: InsertOptions): boolean

Insert a block of text at the current insertion point.

This method can be called explicitly or invoked as a selector with executeCommand("insert").

After the insertion, the selection will be set according to the options.selectionMode.

Focus

blur(): void

focus(): void

hasFocus(): boolean

Return true if the mathfield is currently focused (responds to keyboard input).

Selection

getCaretPoint(): null | {x: number; y: number}

The bottom location of the caret (insertion point) in viewport coordinates.

See also setCaretPoint

Other

applyStyle(style: Style, options?: ApplyStyleOptions): void

Update the style (color, bold, italic, etc…) of the selection or sets the style to be applied to future input.

If there is no selection and no range is specified, the style will apply to the next character typed.

If a range is specified, the style is applied to the range, otherwise, if there is a selection, the style is applied to the selection.

If the operation is "toggle" and the range already has this style, remove it. If the range has the style partially applied (i.e. only some sections), remove it from those sections, and apply it to the entire range.

If the operation is "set", the style is applied to the range, whether it already has the style or not.

The default operation is "set".

executeCommand(command)
command:

A selector, or an array whose first element is a selector, and whose subsequent elements are arguments to the selector.

Selectors can be passed either in camelCase or kebab-case.

// Both calls do the same thing
mfe.executeCommand('selectAll');
mfe.executeCommand('select-all');

boolean

Execute a Commands defined by a selector.

mfe.executeCommand('add-column-after');
mfe.executeCommand(['switch-mode', 'math']);


getOption(key: K): MathfieldOptions[K]

getOptions(): MathfieldOptions

getOptions(keys: K[]): Pick<MathfieldOptions, K>

getPlaceholderField(placeholderId)
placeholderId: string
undefined | Mathfield

Return a nested mathfield element that match the provided placeholderId

select(): void

setCaretPoint(x: number, y: number): boolean

setOptions(options: Partial<MathfieldOptions>): void

Extends HTMLElement

Implements Mathfield

The MathfieldElement class provides special properties and methods to control the display and behavior of <math-field> elements.

It inherits many useful properties and methods from HTMLElement such as style, tabIndex, addEventListener(), getAttribute(), etc…

To create a new MathfieldElement:

// 1. Create a new MathfieldElement
const mfe = new MathfieldElement();
// 2. Attach it to the DOM
document.body.appendChild(mfe);


The MathfieldElement constructor has an optional argument of MathfieldOptions to configure the element. The options can also be modified later:

// Setting options during construction
const mfe = new MathfieldElement({smartFence: false});
// Modifying options after construction
mfe.setOptions({smartFence: true});


CSS Variables

To customize the appearance of the mathfield, declare the following CSS variables (custom properties) in a ruleset that applies to the mathfield.

math-field {
--hue: 10       // Set the highlight color and caret to a reddish hue
}


Alternatively you can set these CSS variables programatically:

  document.body.style.setProperty("--hue", "10");

CSS Variable Usage
--hue Hue of the highlight color and the caret
--highlight Color of the selection
--contains-highlight Backround property for items that contain the caret
--highlight-inactive Color of the selection, when the mathfield is not focused
--caret Color of the caret/insertion point
--primary Primary accent color, used for example in the virtual keyboard
--text-font-family The font stack used in text mode
--smart-fence-opacity Opacity of a smart fence (default is 50%)
--smart-fence-color Color of a smart fence (default is current color)

You can customize the appearance and zindex of the virtual keyboard panel with some CSS variables associated with a selector that applies to the virtual keyboard panel container.

CSS Parts

To style the virtual keyboard toggle, use the virtual-keyboard-toggle CSS part. To use it, define a CSS rule with a ::part() selector for example:

math-field::part(virtual-keyboard-toggle) {
color: red;
}


Attributes

An attribute is a key-value pair set as part of the tag:

<math-field locale="fr"></math-field>


The supported attributes are listed in the table below with their corresponding property.

The property can be changed either directly on the MathfieldElement object, or using setOptions() if it is prefixed with options., for example:

 getElementById('mf').value = '\\sin x';
getElementById('mf').setOptions({horizontalSpacingScale: 1.1});


The values of attributes and properties are reflected, which means you can change one or the other, for example:

getElementById('mf').setAttribute('virtual-keyboard-mode',  'manual');
console.log(getElementById('mf').getOption('virtualKeyboardMode'));
// Result: "manual"
getElementById('mf').setOptions({virtualKeyboardMode: 'onfocus');
console.log(getElementById('mf').getAttribute('virtual-keyboard-mode');
// Result: 'onfocus'


An exception is the value property, which is not reflected on the value attribute: the value attribute remains at its initial value.

Attribute Property
disabled disabled
default-mode options.defaultMode
fonts-directory options.fontsDirectory
sounds-directory options.soundsDirectory
horizontal-spacing-scale options.horizontalSpacingScale
inline-shortcut-timeout options.inlineShortcutTimeout
keypress-vibration options.keypressVibration
keypress-sound options.keypressSound
plonk-sound options.plonkSound
letter-shape-style options.letterShapeStyle
locale options.locale
math-mode-space options.mathModeSpace
read-only options.readOnly
remove-extraneous-parentheses options.removeExtraneousParentheses
smart-fence options.smartFence
smart-mode options.smartMode
smart-superscript options.superscript
speech-engine options.speechEngine
speech-engine-rate options.speechEngineRate
speech-engine-voice options.speechEngineVoice
text-to-speech-markup options.textToSpeechMarkup
text-to-speech-rules options.textToSpeechRules
value value
virtual-keyboard-layout options.keyboardLayout
virtual-keyboard-mode options.keyboardMode
virtual-keyboard-theme options.keyboardTheme
virtual-keyboards options.keyboards

See MathfieldOptions for more details about these options.

In addition, the following global attributes can also be used:

• class
• data-*
• hidden
• id
• item*
• style
• tabindex

Events

Listen to these events by using addEventListener(). For events with additional arguments, the arguments are available in event.detail.

Event Name Description
input The value of the mathfield has been modified. This happens on almost every keystroke in the mathfield.
change The user has committed the value of the mathfield. This happens when the user presses Return or leaves the mathfield.
selection-change The selection (or caret position) in the mathfield has changed
mode-change The mode (math, text) of the mathfield has changed
undo-state-change The state of the undo stack has changed
read-aloud-status-change The status of a read aloud operation has changed
virtual-keyboard-toggle The visibility of the virtual keyboard panel has changed
blur The mathfield is losing focus
focus The mathfield is gaining focus
focus-out The user is navigating out of the mathfield, typically using the tab key
detail: {direction: ‘forward’
move-out The user has pressed an arrow key, but there is nowhere to go. This is an opportunity to change the focus to another element if desired.
detail: {direction: ‘forward’
math-error A parsing or configuration error happened
detail: ErrorListener<ParserErrorCode
keystroke The user typed a keystroke with a physical keyboard
detail: {keystroke: string, event: KeyboardEvent}
mount The element has been attached to the DOM
unmount The element is about to be removed from the DOM

new MathfieldElement(options?: Partial<MathfieldOptions>): MathfieldElement

To create programmatically a new mathfield use:

let mfe = new MathfieldElement();

// Set initial value and options
mfe.value = "\\frac{\\sin(x)}{\\cos(x)}";

// Options can be set either as an attribute (for simple options)...
mfe.setAttribute('virtual-keyboard-layout', 'dvorak');

// ... or using setOptions()
mfe.setOptions({
virtualKeyboardMode: 'manual',
});

// Attach the element to the DOM
document.body.appendChild(mfe);


Accessing and changing the content

applyStyle(style: Style, options?: ApplyStyleOptions): void

Update the style (color, bold, italic, etc…) of the selection or sets the style to be applied to future input.

If there is no selection and no range is specified, the style will apply to the next character typed.

If a range is specified, the style is applied to the range, otherwise, if there is a selection, the style is applied to the selection.

If the operation is "toggle" and the range already has this style, remove it. If the range has the style partially applied (i.e. only some sections), remove it from those sections, and apply it to the entire range.

If the operation is "set", the style is applied to the range, whether it already has the style or not.

The default operation is "set".

getValue(format?)
format?: OutputFormat

The format of the result

Default: "latex"

string

Return a textual representation of the content of the mathfield.

getValue(start: number, end: number, format?: OutputFormat): string

Return the value of the mathfield from start to end

getValue(range: Range, format?: OutputFormat): string

Return the value of the mathfield in range

getValue(selection: Selection, format?: OutputFormat): string

insert(s: string, options?: InsertOptions): boolean

Insert a block of text at the current insertion point.

This method can be called explicitly or invoked as a selector with executeCommand("insert").

After the insertion, the selection will be set according to the options.selectionMode.

setValue(latex?: string, options?: InsertOptions): void

Set the content of the mathfield to the text interpreted as a LaTeX expression.

The content of the mathfield as a LaTeX expression.

document.querySelector('mf').value = '\\frac{1}{\\pi}'


class MathfieldElementcaretPoint: null | {x: number; y: number} Permalink

The bottom location of the caret (insertion point) in viewport coordinates.

The bottom location of the caret (insertion point) in viewport coordinates.

The last valid offset.

The position of the caret/insertion point, from 0 to lastOffset.

select(): void

Select the content of the mathfield.

get selection(): Selection
set selection(number | Selection)

An array of ranges representing the selection.

It is guaranteed there will be at least one element. If a discontinuous selection is present, the result will include more than one element.

setCaretPoint(x: number, y: number): boolean

x and y are in viewport coordinates.

Return true if the location of the point is a valid caret location.

See also caretPoint

Other

type: K
listener: (this: MathfieldElement, ev: HTMLElementEventMap[K]): any
options?:
• | boolean

class MathfieldElementdefaultMode: "math" | "text" | "inline-math" Permalink

executeCommand(command)
command:

A selector, or an array whose first element is a selector, and whose subsequent elements are arguments to the selector.

Selectors can be passed either in camelCase or kebab-case.

// Both calls do the same thing
mfe.executeCommand('selectAll');
mfe.executeCommand('select-all');

boolean

Execute a Commands defined by a selector.

mfe.executeCommand('add-column-after');
mfe.executeCommand(['switch-mode', 'math']);


getOffsetDepth(offset: number): number

The depth of an offset represent the depth in the expression tree.

getPlaceholderField(placeholderId: string): undefined | Mathfield

Return a nested mathfield element that match the provided placeholderId

class MathfieldElementplonkSound: null | string | HTMLAudioElement Permalink

removeEventListener(type, listener, options?)
type: K
listener: (this: MathfieldElement, ev: HTMLElementEventMap[K]): any
options?:
• | boolean
• | EventListenerOptions

class MathfieldElementtextToSpeechMarkup: "" | "ssml" | "ssml_step" | "mac" Permalink

set textToSpeechRule("mathlive" | "sre")

Focus

blur(): void

Remove the focus from the mathfield (will no longer respond to keyboard input).

focus(): void

Sets the focus to the mathfield (will respond to keyboard input).

hasFocus(): boolean

Return true if the mathfield is currently focused (responds to keyboard input).

Options

getOption(key: K): MathfieldOptions[K]

getOptions(keys: K[]): Pick<MathfieldOptions, K>

getOptions(): MathfieldOptions

setOptions(options: Partial<MathfieldOptions>): void

These attributes of the <math-field> element correspond to the [MathfieldOptions] properties.

default-mode: string
fonts-directory: string
horizontal-spacing-scale: string
deprecated

Scaling factor to be applied to horizontal spacing between elements of the formula. A value greater than 1.0 can be used to improve the legibility.

deprecated

Use registers \thinmuskip, \medmuskip and \thickmuskip

inline-shortcut-timeout: string

Maximum time, in milliseconds, between consecutive characters for them to be considered part of the same shortcut sequence.

A value of 0 is the same as infinity: any consecutive character will be candidate for an inline shortcut, regardless of the interval between this character and the previous one.

A value of 750 will indicate that the maximum interval between two characters to be considered part of the same inline shortcut sequence is 3/4 of a second.

This is useful to enter “±” as a sequence of two characters, while also supporting the “±” shortcut with the same sequence.

The first result can be entered by pausing slightly between the first and second character if this option is set to a value of 250 or so.

Note that some operations, such as clicking to change the selection, or losing the focus on the mathfield, will automatically timeout the shortcuts.

keypress-sound: string

When a key on the virtual keyboard is pressed, produce a short audio feedback.

The value of the properties should a string, the name of an audio file in the soundsDirectory directory or ‘none’ to suppress the sound.

keypress-vibration: string
letter-shape-style: string
locale: string

The locale (language + region) to use for string localization.

If none is provided, the locale of the browser is used.

math-mode-space: string

The LaTeX string to insert when the spacebar is pressed (on the physical or virtual keyboard). Empty by default. Use \; for a thick space, \: for a medium space, \, for a thin space.

plonk-sound: string

Sound played to provide feedback when a command has no effect, for example when pressing the spacebar at the root level.

The property is either:

• a string, the name of an audio file in the soundsDirectory directory
• ‘none’ to turn off the sound

When true, the user cannot edit the mathfield.

remove-extraneous-parentheses: boolean
shared-virtual-keyboard-target-origin: string

Specify the targetOrigin parameter for postMessage to send control messages from child to parent frame to remote control of mathfield component.

Default: window.origin

smart-fence: string

When on and an open fence is entered via typedText() it will generate a contextually appropriate markup, for example using \left...\right if applicable.

When off, the literal value of the character will be inserted instead.

smart-mode: string

When on, during text input the field will switch automatically between ‘math’ and ‘text’ mode depending on what is typed and the context of the formula. If necessary, what was previously typed will be ‘fixed’ to account for the new info.

For example, when typing “if x >0”:

Type Interpretation
“i” math mode, imaginary unit
“if” text mode, english word “if”
“if x” all in text mode, maybe the next word is xylophone?
“if x >” “if” stays in text mode, but now “x >” is in math mode
“if x > 0” “if” in text mode, “x > 0” in math mode

Smart Mode is off by default.

Manually switching mode (by typing alt/option+=) will temporarily turn off smart mode.

Examples

• slope = rise/run
• If x > 0, then f(x) = sin(x)
• x^2 + sin (x) when x > 0
• When x<0, x^{2n+1}<0
• Graph x^2 -x+3 =0 for 0<=x<=5
• Divide by x-3 and then add x^2-1 to both sides
• Given g(x) = 4x – 3, when does g(x)=0?
• Let D be the set {(x,y)|0<=x<=1 and 0<=y<=x}
• \int_{the unit square} f(x,y) dx dy
• For all n in NN
smart-superscript: string

When on, when a digit is entered in an empty superscript, the cursor leaps automatically out of the superscript. This makes entry of common polynomials easier and faster. If entering other characters (for example “n+1”) the navigation out of the superscript must be done manually (by using the cursor keys or the spacebar to leap to the next insertion point).

When off, the navigation out of the superscript must always be done manually.

speech-engine: string
speech-engine-rate: string
speech-engine-voice: string
text-to-speech-markup: string
text-to-speech-rules: string
use-shared-virtual-keyboard: boolean

When true, use a shared virtual keyboard for all the mathfield elements in the page, even across iframes.

When setting this option to true, you must create the shared virtual keyboard in the the parent document:

import { makeSharedVirtualKeyboard } from 'mathlive';

makeSharedVirtualKeyboard({
virtualKeyboardToolbar: 'none',
});


You should call makeSharedVirtualKeyboard() as early as possible. makeSharedVirtualKeyboard() only applies to mathfield instances created after it is called.

Default: false

virtual-keyboard-layout: string
virtual-keyboard-mode: VirtualKeyboardMode
• "manual": pressing the virtual keyboard toggle button will show or hide the virtual keyboard. If hidden, the virtual keyboard is not shown when the field is focused until the toggle button is pressed.
• "onfocus": the virtual keyboard will be displayed whenever the field is focused and hidden when the field loses focus. In that case, the virtual keyboard toggle button is not displayed.
• "off": the virtual keyboard toggle button is not displayed, and the virtual keyboard is never triggered.

If the setting is "auto", it will default to "onfocus" on touch-capable devices and to "off" otherwise.

virtual-keyboard-theme: string

The visual theme used for the virtual keyboard.

If empty, the theme will switch automatically based on the device it’s running on. The two supported themes are ‘material’ and ‘apple’ (the default).

virtual-keyboards: string

A space separated list of the keyboards that should be available. The keyboard "all" is synonym with "numeric", "functions", “symbols” "roman" and "greek",

The keyboards will be displayed in the order indicated.

These hooks provide an opportunity to intercept or modify an action. When their return value is a boolean, it indicates if the default handling should proceed.

onExport(from: Mathfield, latex: string, range: Range): string

This hooks is invoked when the user has requested to export the content of the mathfield, for example when pressing ctrl/command+C.

This hook should return as a string what should be exported.

The range argument indicates which portion of the mathfield should be exported. It is not always equal to the current selection, but it can be used to export a format other than LaTeX.

By default this is:

 return \\begin{equation*}${latex}\\end{equation*};  onKeystroke(sender: Mathfield, keystroke: string, ev: KeyboardEvent): boolean deprecated A hook invoked when a keystroke is about to be processed. • keystroke: a string describing the keystroke • ev: the native keyboard event Return false to stop the handling of the event. deprecated Use corresponding events of MathfieldEvent instead onMoveOutOf(sender: Mathfield, direction: "forward" | "backward" | "upward" | "downward"): boolean deprecated A hook invoked when keyboard navigation would cause the insertion point to leave the mathfield. • direction indicates the direction of the navigation, either "forward" or "backward" or "upward" or "downward". Return false if the move has been handled by the hook. Return true for the default behavior, which is playing a “plonk” sound. deprecated Use corresponding events of MathfieldEvent instead onMulticharSymbol(sender: Mathfield, symbol: string): string A hook invoked when a string of characters that could be interpreted as a multichar symbol has been typed. If not a multichar symbol, return the empty string "". If a multichar symbol, return the symbol wrapped appropriately, for example \mathrm{${symbol}}.

onTabOutOf(sender: Mathfield, direction: "forward" | "backward"): boolean
deprecated

This hook is invoked when pressing tab (or shift-tab) would cause the insertion point to leave the mathfield.

direction indicates the direction of the navigation.

By default, the insertion point jumps to the next/previous focussable element.

deprecated

Use corresponding events of MathfieldEvent instead

deprecated

The methods provide a notification that an event is about to occur or has occurred.

In general instead of using this interface you should be listening to the corresponding event on MathfieldElement, i.e.

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


deprecated

Use corresponding events of MathfieldEvent instead

interface MathfieldListenersProperties / Methods

onBlur(sender: Mathfield): void

The mathfield has lost keyboard focus

onCommit(sender: Mathfield): void

onContentDidChange(sender: Mathfield, options: ContentChangeOptions): void

onContentWillChange(sender: Mathfield, options: ContentChangeOptions): boolean

onFocus(sender: Mathfield): void

The mathfield has gained keyboard focus

onModeChange(sender: Mathfield, mode: ParseMode): void

onPlaceholderDidChange(sender: Mathfield, placeholderId: string): void

onSelectionDidChange(sender: Mathfield): void

onSelectionWillChange(sender: Mathfield): void

mathfield: Mathfield

Use a Style object literal to modify the visual appearance of a mathfield or a portion of a mathfield.

You can control the color (“ink”) and background color (“paper”), the font variant, weight (FontSeries), size and more.

backgroundColor?: string
color?: string
fontFamily?: string
fontSeries?: FontSeries
fontShape?: FontShape
fontSize?: "auto" | FontSize
letterShapeStyle?: "tex" | "french" | "iso" | "upright" | "auto"
variant?: Variant
variantStyle?: VariantStyle

classes?: string
command?: string | string[]
label: string
layer?: string
layers?: string[]
tooltip?: string

This interface is implemented by:

• VirtualKeyboard
• VirtualKeyboardDelegate (used when the virtual keyboard is shared amongst mathfield instances)
• RemoteVirtualKeyboard (the shared virtual keyboard instance)

interface VirtualKeyboardInterfaceProperties / Methods

blurMathfield(): void

create(): void

Called once when the keyboard is created

disable(): void

dispose(): void

After calling dispose() the Virtual Keyboard is no longer valid and cannot be brought back. Use disable() for temporarily deactivating the keyboard.

enable(): void

executeCommand(command: string | [string, ...any[]]): boolean

focusMathfield(): void

setOptions(options: CombinedVirtualKeyboardOptions): void

stateChanged(): void

aside: string

Markup displayed with the key label (for example to explain what the symbol of the key is)

class: string

CSS classes to apply to the keycap.

• tex: use the TeX font for its label. Using the tex class is not necessary if using the latex property to define the label.
• modifier: a modifier (shift/option, etc…) keycap
• small: display the label in a smaller size
• action: an “action” keycap (for arrows, return, etc…)
• separator w5: a half-width blank used as a separator. Other widths include w15 (1.5 width), w20 (double width) and w50 (five-wide, used for the space bar).
• bottom, left, right: alignment of the label
command: Selector | [Selector, ...any[]]

Command to perform when the keycap is pressed

content: string

HTML markup to represent the keycap.

This property is only useful when using a custom keycap shape or appearance. Usually, setting the label property is sufficient.

insert: string

LaTeX fragment to insert when the keycap is pressed (ignored if command is specified)

key: string

Key to insert when keycap is pressed (ignored if command, insert or latex is specified)

label: string

The HTML markup displayed for the keycap

latex: string

Label of the key as a LaTeX expression, also the LaTeX inserted if no command or insert property is specified.

layer: string

Name of the layer to shift to when the key is pressed

shifted: string

Markup for the label of the key when the shift key is pressed

shiftedCommand: Selector | [Selector, ...any[]]

Command to perform when the shifted key is pressed

variants: (string | Partial<VirtualKeyboardKeycap>)[]

A set of keycap variants displayed on a long press

variants: [
'\\alpha',    // Same label as value inserted
{ latex: '\\beta', label: 'beta' }
]



backdrop: string

A CSS class name to customize the appearance of the background of the layer

container: string

A CSS class name to customize the appearance of the container the layer

rows: Partial<VirtualKeyboardKeycap>[][]

The rows of keycaps in this layer

styles: string

The CSS stylesheet associated with this layer

version: {computeEngine: string; mathlive: string}

Current version:

The version string of the SDK using the semver convention:

MAJOR.MINOR.PATCH

• MAJOR is incremented for incompatible API changes
• MINOR is incremented for new features
• PATCH is incremented for bug fixes

module mathliveTypes

operation: "set" | "toggle";
range: Range;

TeX: {delimiters: {display: [openDelim: string, closeDelim: string][]; inline: [openDelim: string, closeDelim: string][]}; processEnvironments: boolean};
asciiMath: {delimiters: {display: [openDelim: string, closeDelim: string][]; inline: [openDelim: string, closeDelim: string][]}};
fontsDirectory: string;

A URL fragment pointing to the directory containing the fonts necessary to render a formula.

These fonts are available in the /dist/fonts directory of the SDK.

Customize this value to reflect where you have copied these fonts, or to use the CDN version.

The default value is ‘./fonts’.

Changing this setting after the mathfield has been created will have no effect.

{
// Use the CDN version
fontsDirectory: ''
}

{
// Use a directory called 'fonts', located next to the
// mathlive.js (or mathlive.mjs) file.
fontsDirectory: './fonts'
}

{
// Use a directory located at the top your website
fontsDirectory: 'https://example.com/fonts'
}

ignoreClass: string;

A string used as a regular expression of class names of elements whose content will not be scanned for delimiter

Default: "tex2jax_ignore"

macros: MacroDictionary;

Custom LaTeX macros

namespace: string;

Namespace that is added to data- attributes to avoid collisions with other libraries.

It is empty by default.

The namespace should be a string of lowercase letters.

processClass: string;

A string used as a regular expression of class names of elements whose content will be scanned for delimiters, even if their tag name or parent class name would have prevented them from doing so.

Default: "tex2jax_process"

processScriptType: string;

<script> tags of the indicated type will be processed while others will be ignored.

Default: "math/tex"

If true, generate markup that can be read aloud later using speak

Default: false

registers: Registers;

LaTeX global register overrides

renderAccessibleContent: string;

The format(s) in which to render the math for screen readers:

• "mathml" MathML
• "speakable-text" Spoken representation

You can pass an empty string to turn off the rendering of accessible content. You can pass multiple values separated by spaces, e.g "mathml speakable-text"

Default: "mathml"

skipTags: string[];

An array of tag names whose content will not be scanned for delimiters (unless their class matches the processClass pattern below.

Default: ['math-field', 'noscript', 'style', 'textarea', 'pre', 'code', 'annotation', 'annotation-xml']

createHTML?: (html: string): string;

Support for Trusted Type.

This optional function will be called whenever the DOM is modified by injecting a string of HTML, allowing that string to be sanitized according to a policy defined by the host.

data: string | null;
dataTransfer: DataTransfer | null;
inputType: ContentChangeType;
isComposing: boolean;

• | "insertText"
• | "insertLineBreak"
• | "insertFromPaste"
• | "historyUndo"
• | "historyRedo"
• | "deleteByCut"
• | "deleteContent"
• | "deleteContentBackward"
• | "deleteContentForward"
• | "deleteWordBackward"
• | "deleteWordForward"
• | "deleteSoftLineBackward"
• | "deleteSoftLineForward"
• | "deleteHardLineBackward"
• | "deleteHardLineForward"

fontsDirectory: string;

A URL fragment pointing to the directory containing the fonts necessary to render a formula.

These fonts are available in the /dist/fonts directory of the SDK.

Customize this value to reflect where you have copied these fonts, or to use the CDN version.

The default value is ‘./fonts’.

Changing this setting after the mathfield has been created will have no effect.

{
// Use the CDN version
fontsDirectory: ''
}

{
// Use a directory called 'fonts', located next to the
// mathlive.js (or mathlive.mjs) file.
fontsDirectory: './fonts'
}

{
// Use a directory located at the top your website
fontsDirectory: 'https://example.com/fonts'
}

soundsDirectory: string;

A URL fragment pointing to the directory containing the optional sounds used to provide feedback while typing.

Some default sounds are available in the /dist/sounds directory of the SDK.

createHTML: (html: string): any;

Support for Trusted Type.

This optional function will be called before a string of HTML is injected in the DOM, allowing that string to be sanitized according to a policy defined by the host.

A dimension is used to specify the size of things

dimension: number;
unit: DimensionUnit;

• | "pt"
• | "mm"
• | "cm"
• | "ex"
• | "px"
• | "em"
• | "bp"
• | "dd"
• | "pc"
• | "in"
• | "mu"
• | "fil"
• | "fill"
• | "filll"

decimalSeparator: "," | ".";

The symbol used to separate the integer part from the fractional part of a number.

When "," is used, the corresponding LaTeX string is {,}, in order to ensure proper spacing (otherwise an extra gap is displayed after the comma).

This affects:

• what happens when the , key is pressed (if decimalSeparator is ",", the {,} LaTeX string is inserted when following some digits)
• the label and behavior of the “.” key in the default virtual keyboard

Default: "."

mathModeSpace: string;

The LaTeX string to insert when the spacebar is pressed (on the physical or virtual keyboard).

Use \; for a thick space, \: for a medium space, \, for a thin space.

Do not use   (a regular space), as whitespace is skipped by LaTeX so this will do nothing.

Default: "" (empty string)

When true, the user cannot edit the mathfield. The mathfield can still be modified programatically.

Default: false

removeExtraneousParentheses: boolean;

If true, extra parentheses around a numerator or denominator are removed automatically.

Default: true

scriptDepth: number | [number, number];

This option controls how many levels of subscript/superscript can be entered. For example, if scriptDepth is “1”, there can be one level of superscript or subscript. Attempting to enter a superscript while inside a superscript will be rejected. Setting a value of 0 will prevent entry of any superscript or subscript (but not limits for sum, integrals, etc…)

This can make it easier to enter equations that fit what’s expected for the domain where the mathfield is used.

To control the depth of superscript and subscript independently, provide an array: the first element indicate the maximum depth for subscript and the second element the depth of superscript. Thus, a value of [0, 1] would suppress the entry of subscripts, and allow one level of superscripts.

smartFence: boolean;

When true and an open fence is entered via typedText() it will generate a contextually appropriate markup, for example using \left...\right if applicable.

When false, the literal value of the character will be inserted instead.

smartMode: boolean;

When true, during text input the field will switch automatically between ‘math’ and ‘text’ mode depending on what is typed and the context of the formula. If necessary, what was previously typed will be ‘fixed’ to account for the new info.

For example, when typing “if x >0”:

Type Interpretation
i math mode, imaginary unit
if text mode, english word “if”
if x all in text mode, maybe the next word is xylophone?
if x > “if” stays in text mode, but now “x >” is in math mode
if x > 0 “if” in text mode, “x > 0” in math mode

Default: false

Manually switching mode (by typing alt/option+=) will temporarily turn off smart mode.

Examples

• slope = rise/run
• If x > 0, then f(x) = sin(x)
• x^2 + sin (x) when x > 0
• When x<0, x^{2n+1}<0
• Graph x^2 -x+3 =0 for 0<=x<=5
• Divide by x-3 and then add x^2-1 to both sides
• Given g(x) = 4x – 3, when does g(x)=0?
• Let D be the set {(x,y)|0<=x<=1 and 0<=y<=x}
• \int\_{the unit square} f(x,y) dx dy
• For all n in NN
smartSuperscript: boolean;

When true, when a digit is entered in an empty superscript, the cursor leaps automatically out of the superscript. This makes entry of common polynomials easier and faster. If entering other characters (for example “n+1”) the navigation out of the superscript must be done manually (by using the cursor keys or the spacebar to leap to the next insertion point).

When false, the navigation out of the superscript must always be done manually.

<T> = (err: {after: string; arg: string; before: string; code: T; latex: string}): void

The focus-out event signals that the mathfield has lost focus through keyboard navigation with the tab key.

The event detail.direction property indicates if tab (direction === "forward") or shift+tab (direction === “backward”) was pressed which can be useful to decide which element to focus next.

If the event is canceled by calling ev.preventDefault(), no change of focus will occur (but you can manually change the focus in your event handler: this gives you an opportunity to override the default behavior and selects which element should get the focus, or to prevent from a change of focus altogether).

If the event is not canceled, the default behavior will take place, which is to change the focus to the next/previous focusable element.

mfe.addEventListener('focus-out', (ev) => {
console.log("Losing focus ", ev.detail.direction);
});


direction: "forward" | "backward";

• | "auto"
• | "m"
• | "b"
• | "l"
• | ""

• | "auto"
• | "n"
• | "it"
• | "sl"
• | "sc"
• | ""

• | 1
• | 2
• | 3
• | 4
• | 5
• | 6
• | 7
• | 8
• | 9
• | 10

Glue represents flexible spacing, that is a dimension that can grow (by the grow property) or shrink (by the shrink property).

glue: Dimension;
grow: Dimension;
shrink: Dimension;

An inline shortcut can be specified as a simple string or as an object literal with additional options:

    config.inlineShortcuts = {
half: '\\frac{1}{2}',
in: {
mode: 'math',
after: 'space+letter+digit+symbol+fence',
value: '\\in',
},
};


When using a string, the shortcut will apply in any mode, and regardless of the characters surrounding it.

When using an object literal the value key is required an indicate the shortcut substitution.

The mode key, if present, indicate which mode this shortcut will apply in, either "math" or "text". If the key is not present the shortcut apply in all modes.

The "after" key, if present, indicate in what context (surrounding characters) the shortcut will apply. One or more values can be specified, separated by a ‘|’ character. If any of the values match, the shortcut will be applicable.

Possible values are:

"space" A spacing command, such as \quad
"nothing" The begining of a group
"surd" A square root or n-th root
"frac" A fraction
"function" A function such as \sin or f
"letter" A letter, such as x or n
"digit" 0 through 9
"binop" A binary operator, such as +
"relop" A relational operator, such as =
"punct" A punctuation mark, such as ,
"array" An array, such as a matrix or cases statement
"openfence" An opening fence, such as (
"closefence" A closing fence such as }
"text" Some plain text

• | string
• | {after: string; mode: ParseMode; value: string}

inlineShortcutTimeout: number;

Maximum time, in milliseconds, between consecutive characters for them to be considered part of the same shortcut sequence.

A value of 0 is the same as infinity: any consecutive character will be candidate for an inline shortcut, regardless of the interval between this character and the previous one.

A value of 750 will indicate that the maximum interval between two characters to be considered part of the same inline shortcut sequence is 3/4 of a second.

This is useful to enter “±” as a sequence of two characters, while also supporting the “±” shortcut with the same sequence.

The first result can be entered by pausing slightly between the first and second character if this option is set to a value of 250 or so.

Note that some operations, such as clicking to change the selection, or losing the focus on the mathfield, will automatically timeout the shortcuts.

inlineShortcuts: Record<string, InlineShortcutDefinition>;

The keys of this object literal indicate the sequence of characters that will trigger an inline shortcut.

An inline shortcut can be specified as a simple string or as an object literal with additional options:

    config.inlineShortcuts = {
half: '\\frac{1}{2}',
in: {
mode: 'math',
after: 'space+letter+digit+symbol+fence',
value: '\\in',
},
};


When using a string, the shortcut will apply in any mode, and regardless of the characters surrounding it.

When using an object literal the value key is required an indicate the shortcut substitution.

The mode key, if present, indicate which mode this shortcut will apply in, either "math" or "text". If the key is not present the shortcut apply in all modes.

The "after" key, if present, indicate in what context (surrounding characters) the shortcut will apply. One or more values can be specified, separated by a ‘|’ character. If any of the values match, the shortcut will be applicable.

Possible values are:

"space" A spacing command, such as \quad
"nothing" The begining of a group
"surd" A square root or n-th root
"frac" A fraction
"function" A function such as \sin or f
"letter" A letter, such as x or n
"digit" 0 through 9
"binop" A binary operator, such as +
"relop" A relational operator, such as =
"punct" A punctuation mark, such as ,
"array" An array, such as a matrix or cases statement
"openfence" An opening fence, such as (
"closefence" A closing fence such as }
"text" Some plain text

feedback: boolean;

If true, provide audio and haptic feedback

focus: boolean;

If true, the mathfield will be focused after the insertion

format: OutputFormat | "auto";

The format of the input string:

"auto" The string is LaTeX fragment or command) (default)
"latex" The string is a LaTeX fragment
insertionMode: "replaceSelection" | "replaceAll" | "insertBefore" | "insertAfter";
macros: MacroDictionary;
mode: ParseMode | "auto";

If "auto" or omitted, the current mode is used

registers: Registers;
resetStyle: boolean;

If true, the style after the insertion is the same as the style before. If false, the style after the insertion is the style of the last inserted atom.

scrollIntoView: boolean;

If true, scroll the mathfield into view after insertion such that the insertion point is visible

selectionMode: "placeholder" | "after" | "before" | "item";

Describes where the selection will be after the insertion:

"placeholder" The selection will be the first available placeholder in the text that has been inserted (default)
"after" The selection will be an insertion point after the inserted text
"before" The selection will be an insertion point before the inserted text
"item" The inserted text will be selected
smartFence: boolean;

If true, promote plain fences, e.g. (...), as \left()...\right)

style: Style;

A keybinding associates a combination of physical keyboard keys with a command.

For example:

{
"key": "cmd+a",
"command": "selectAll",
},
{
"key": 'ctrl+[Digit2]',
"ifMode": 'math',
"command": ['insert', '\\sqrt{#0}'],
}


command: Selector | [Selector, ...any[]];

The command is a single selector, or a selector with arguments

ifLayout: string[];
ifMode: ParseMode;

If specified, this indicates in which mode this keybinding will apply. If none is specified, the keybinding will apply in every mode.

ifPlatform: "macos" | "!macos" | "windows" | "!windows" | "linux" | "!linux" | "ios" | "!ios" | "android" | "!android" | "chromeos" | "!chromeos";

If specified, this indicates the OS platform to which this keybinding apply.

For example, if set to !macos this key binding will apply to every platform, except macOS.

key: string;

The pressed keys that will trigger this keybinding.

The key is made up of modifiers and the key itself.

The following modifiers can be used:

Platform Modifiers
macOS, iOS ctrl, shift, alt, cmd
Windows ctrl, shift, alt, win
Linux, Android, ChromeOS ctrl, shift, alt, meta

If the cmd modifier is used, the keybinding will only apply on macOS. If the win modifier is used, the keybinding will only apply to Windows. If the meta modifier is used, the keybinding will apply to platforms other than macOS or Windows.

The alt key is the option key on Apple keyboards.

The following values for keys can be used:

• az, 09
• , -, =, [, ], \, ;, ', ,, ., /
• left, up, right, down, pageup, pagedown, end, home
• tab, enter, escape, space, backspace, delete
• f1f19
• pausebreak, capslock, insert
• numpad0numpad9, numpad_multiply, numpad_add, numpad_separator
• numpad_subtract, numpad_decimal, numpad_divide

The values will be remapped based on the current keyboard layout. So, for example if a is used, on a French AZERTY keyboard the keybinding will be associated with the key labeled ‘A’ (event though it corresponds to the key labeled ‘Q’ on a US QWERTY keyboard).

To associate keybindings with physical keys independent of the keyboard layout, use the following keycodes:

• [KeyA][KeyZ], [Digit0][Digit9]
• [Backquote], [Minus], [Equal], [BracketLeft], [BracketRight], [Backslash], [Semicolon], [Quote], [Comma], [Period], [Slash]
• [ArrowLeft], [ArrowUp], [ArrowRight], [ArrowDown], [PageUp], [PageDown], [End], [Home]
• [Tab], [Enter], [Escape], [Space], [Backspace], [Delete]
• [F1][F19]
• [Pause], [CapsLock], [Insert]
• [Numpad0][Numpad9], [NumpadMultiply], [NumpadAdd], [NumpadComma]
• [NumpadSubtract], [NumpadDecimal], [NumpadDivide]

For example, using [KeyQ] will map to the the key labeled ‘Q’ on a QWERTY keyboard, and to the key labeled ‘A’ on an AZERTY keyboard.

As a general guideline, it is preferable to use the key values az for keybinding that are pseudo-mnemotechnic. For the other, it is generally preferable to use the keycodes.

Consider the key combination: alt+2. With an AZERTY (French) layout, the digits (i.e. ‘2’) are only accessible when shifted. The ‘2’ key produces ‘é’ when not shifted. It is therefore impossible on an AZERTY keyboard to produce the alt+2 key combination, at best it would be alt+shift+2. To indicate that the intended key combination should be alt and the key on the keyboard which has the position of the 2 key on a US keyboard, a key code should be used instead: alt+[Digit2]. This will correspond to a key combination that can be generated on any keyboard.

If a keybinding is invalid (impossible to produce or ambiguous) with the current keyboard layout, an error will be generated, and the onError listener will be called with a invalid-keybinding error code.

Name Platform Display name
"apple.en-intl" Apple English (International)
"apple.french" Apple French (AZERTY)
"apple.german" Apple German (QWERTZ)
"dvorak" English (Dvorak)
"windows.en-intl" Windows English (International)
"windows.french" Windows French (AZERTY)
"windows.german" Windows German (QWERTZ)
"linux.en" Linux English
"linux.french" Linux French (AZERTY)
"linux.german" Linux German (QWERTZ)

• | "apple.en-intl"
• | "apple.french"
• | "apple.german"
• | "apple.spanish"
• | "dvorak"
• | "windows.en-intl"
• | "windows.french"
• | "windows.german"
• | "windows.spanish"
• | "linux.en"
• | "linux.french"
• | "linux.german"
• | "linux.spanish"

keybindings: Keybinding[];

The keystroke event is fired when a keystroke is about to be processed. The event is cancellable, which wills suppress further handling of the event.

event: KeyboardEvent;

The native keyboard event

keystroke: string;

A string descring the keystroke, for example “Alt-KeyU”. See W3C UIEvents for more information on the format of the descriptor.

defaultMode: "inline-math" | "math" | "text";

The mode of the element when it is empty:

• "math": equivalent to \displaystyle (display math mode)
• "inline-math": equivalent to \inlinestyle (inline math mode)
• "text": text mode
horizontalSpacingScale: number;
deprecated

Scaling factor to be applied to horizontal spacing between elements of the formula. A value greater than 1.0 can be used to improve the legibility.

deprecated

Use registers \thinmuskip, \medmuskip and \thickmuskip

letterShapeStyle: "auto" | "tex" | "iso" | "french" | "upright";

Control the letter shape style:

letterShapeStyle xyz ABC αβɣ ΓΔΘ
iso it it it it
tex it it it up
french it up up up
upright up up up up

(it) = italic (up) = upright

The default letter shape style is auto, which indicates that french should be used if the locale is “french”, and tex otherwise.

Historical Note

Where do the “french” rules come from? The TeX standard font, Computer Modern, is based on Monotype 155M, itself based on the Porson greek font which was one of the most widely used Greek fonts in english-speaking countries. This font had upright capitals, but slanted lowercase. In France, the traditional font for greek was Didot, which has both upright capitals and lowercase.

As for roman uppercase, they are recommended by “Lexique des règles typographiques en usage à l’Imprimerie Nationale”. It should be noted that this convention is not universally followed.

macros: MacroDictionary;

A dictionary of LaTeX macros to be used to interpret and render the content.

For example, to add a new macro to the default macro dictionary:

mf.setConfig({
macros: {
...mf.getOption('macros'),
smallfrac: '^{#1}\\!\\!/\\!_{#2}',
},
});


Note that getOption() is called to keep the existing macros and add to them. Otherwise, all the macros are replaced with the new definition.

The code above will support the following notation:

\smallfrac{5}{16}

registers: Registers;

LaTeX global registers override.

backgroundColorMap: (name: string): undefined | string;
colorMap: (name: string): undefined | string;

Map a color name as used in commands such as \textcolor{}{} or \colorbox{}{} to a CSS color value.

Use this option to override the standard mapping of colors such as “yellow” or “red”.

If the name is not one you expected, return undefined and the default color mapping will be applied.

If a backgroundColorMap() function is not provided, the colorMap() function will be used instead.

If colorMap() is not provided, default color mappings are applied.

The following color names have been optimized for a legible foreground and background values, and are recommended:

• red, orange, yellow, lime, green, teal, blue, indigo, purple, magenta, black, dark-grey, grey, light-grey, white

locale: string;

The locale (language + region) to use for string localization.

If none is provided, the locale of the browser is used.

strings: Record<string, Record<string, string>>;

An object whose keys are a locale string, and whose values are an object of string identifier to localized string.

Example

{
"fr-CA": {
"tooltip.undo": "Annuler",
"tooltip.redo": "Refaire",
}
}


This will override the default localized strings.

args: number;
captureSelection: boolean;
def: string;
expand: boolean;

A dictionary of LaTeX macros to be used to interpret and render the content.

For example:

mf.setOptions({
macros: {
smallfrac: '^{#1}\\!\\!/\\!_{#2}',
},
});


The code above will support the following notation:

\smallfrac{5}{16}


captureSelection: boolean;
expand: boolean;
package: Record<string, string | MacroDefinition>;

The math-error custom event signals an error while parsing an expression.

document.getElementById('mf').addEventListener('math-error', (ev) => {
const err = ev.detail;
console.warn(err.code + (err.arg ? ': ' + err.arg : '') +
'\n%c|  ' + err.before + '%c' + err.after +
'\n%c|  ' + String(' ').repeat(err.before.length) +
'▲',
'font-weight: bold',
'font-weight: normal; color: rgba(160, 160, 160)',
'font-weight: bold; color: hsl(4deg, 90%, 50%)'
);
});


after: string;
arg: string;
before: string;
code: ParserErrorCode | MathfieldErrorCode;
latex: string;

• | "invalid-keybinding"
• | "font-not-found"

• LayoutOptions &
• EditingOptions &
• LocalizationOptions &
• InlineShortcutsOptions &
• KeyboardOptions &
• VirtualKeyboardOptions &
• TextToSpeechOptions &
• CoreOptions &
• MathfieldHooks &
• MathfieldListeners &
• onError: ErrorListener<ParserErrorCode | MathfieldErrorCode | string>;

An optional listener function that will be invoked when an error is encountered.

This could be a LaTeX parsing error, for the initial value of the mathfield, a value inserted programmatically later, or through a user interaction (pasting in the mathfield for example). See ParserErrorCode for the list of possible parsing errors.

This could also be another kind of error, such as an invalid keybinding.

originValidator: OriginValidator;

Specify behavior how origin of message from postMessage should be validated.

Default: "same-origin"

sharedVirtualKeyboardTargetOrigin: string;

Specify the targetOrigin parameter for postMessage to send control messages from child to parent frame to remote control of mathfield component.

Default: window.origin

useSharedVirtualKeyboard: boolean;

When true, use a shared virtual keyboard for all the mathfield elements in the page, even across iframes.

When setting this option to true, you must create the shared virtual keyboard in the the parent document. You should call makeSharedVirtualKeyboard() before changing the options of any mathfield or adding new mathfield elements to the DOM.

import { makeSharedVirtualKeyboard } from 'mathlive';

makeSharedVirtualKeyboard();


Default: false

The move-out event signals that the user pressed an arrow key but there was no navigation possible inside the mathfield.

This event provides an opportunity to handle this situation, for example by focusing an element adjacent to the mathfield.

If the event is canceled (i.e. evt.preventDefault() is called inside your event handler), the default behavior is to play a “plonk” sound.

direction: "forward" | "backward" | "upward" | "downward";

A position of the caret/insertion point from the beginning of the formula.

number

Specify behavior for origin validation.

Value Description
"same-origin" The origin of received message must be the same of hosted window, instead exception will throw.
(origin: string) => boolean The callback to verify origin to be expected validation. When callback return false value, message will rejected and exception will throw.
"none" No origin validation for post messages.

• | (origin: string): boolean
• | "same-origin"
• | "none"

Format Description
"ascii-math" A string of ASCIIMath.
"latex" LaTeX rendering of the content, with LaTeX macros not expanded.
"latex-expanded" All macros are recursively expanded to their definition.
"latex-unstyled" Styling (background color, color) is ignored
"math-json" A MathJSON abstract syntax tree, as an object literal formated as a JSON string.
"math-ml" A string of MathML markup.
"spoken" Spoken text rendering, using the default format defined in config, which could be either text or SSML markup.
"spoken-text" A plain spoken text rendering of the content.
"spoken-ssml" A SSML (Speech Synthesis Markup Language) version of the content, which can be used with some text-to-speech engines such as AWS.
"spoken-ssml-with-highlighting" Like "spoken-ssml" but with additional annotations necessary for synchronized highlighting (read aloud).

• | "ascii-math"
• | "latex"
• | "latex-expanded"
• | "latex-unstyled"
• | "math-json"
• | "math-ml"
• | "spoken"
• | "spoken-text"
• | "spoken-ssml"
• | "spoken-ssml-with-highlighting"

The mode that indicates how a portion of content is interpreted

• | "math"
• | "text"
• | "latex"

Error code passed to the ErrorListener function.

font-not-found A required font could not be loaded. The fontDirectory option may not be setup correctly or the ‘fonts’ directory is missing.
invalid-keybinding A keybinding includes a combination of keys which cannot be performed with the current keyboard layout.
unknown-command There is no definition available for this command, e.g. \zin
unknown-environment There is no definition available for this environment, e.g. \begin{foo}
invalid-command This command is not valid in the current mode (e.g. text command in math mode)
unbalanced-braces There are too many or too few { or }
unbalanced-environment An environment was open but never closed (\begin{array}) or the \end command does not match the \begin command (\begin{array*}\end{array})
unbalanced-mode-shift A \$, $$, \( or \[ was not balanced missing-argument A required argument is missing, e.g. \frac{2} too-many-infix-commands A group can include only one infix command (i.e. \choose, \atop). In general it’s best to avoid infix commands. unexpected-command-in-string A command expected a string argument, but there was a command instead missing-unit An argument requiring a dimension was missing an unit. unexpected-delimiter An invalid symbol or command was used as a delimiter. unexpected-token An unexpected character was encountered. unexpected-end-of-string The end of the string was reached, but some required arguments were missing. improper-alphabetic-constant The alphabetic constant prefix  was not followed by a letter or single character command. • | "unknown-command" • | "invalid-command" • | "unbalanced-braces" • | "unknown-environment" • | "unbalanced-environment" • | "unbalanced-mode-shift" • | "missing-argument" • | "too-many-infix-commands" • | "unexpected-command-in-string" • | "missing-unit" • | "unexpected-delimiter" • | "unexpected-token" • | "unexpected-end-of-string" • | "improper-alphabetic-constant" Range Permalink A pair of offsets (boundary points) that can be used to denote a fragment of an expression. A range is said to be collapsed when start and end are equal. When specifying a range, a negative offset can be used to indicate an offset from the last valid offset, i.e. -1 is the last valid offset, -2 is one offset before that, etc… A normalized range will always be such that start <= end, start >= 0, end >= 0, start < lastOffset, end < lastOffset. All the methods return a normalized range. See Also [start: Offset, end: Offset] RegisterValue Permalink Registers Permalink TeX registers represent ‘variables’ and ‘constants’. Changing the values of some registers can modify the layout of math expressions. The following registers might be of interest: • thinmuskip • medmuskip • thickmuskip • nulldelimiterspace • delimitershortfall • jot RemoteVirtualKeyboardOptions Permalink • CombinedVirtualKeyboardOptions & • originValidator: OriginValidator; Specify behavior how origin of message from postMessage should be validated. Default: "same-origin" targetOrigin: string; Specify the targetOrigin parameter for postMessage to send control messages from parent to child frame to remote control of mathfield component. Default: window.origin Selection Permalink A selection is a set of ranges (to support discontinuous selection, for example when selecting a column in a matrix). If there is a single range and that range is collapsed, the selection is collapsed. A selection can also have a direction. While many operations are insensitive to the direction, a few are. For example, when selecting a fragment of an expression from left to right, the direction of this range will be “forward”. Pressing the left arrow key will sets the insertion at the start of the range. Conversely, if the selection is made from right to left, the direction is “backward” and pressing the left arrow key will set the insertion point at the end of the range. See Also direction: "forward" | "backward" | "none"; ranges: Range[]; Selector Permalink Keys<Commands> SpeechScope Permalink How much of the formula should be spoken: all the entire formula selection the selection portion of the formula left the element to the left of the selection right the element to the right of the selection group the group (numerator, root, etc…) the selection is in parent the parent of the selection • | "all" • | "selection" • | "left" • | "right" • | "group" • | "parent" TextToSpeechOptions Permalink speechEngine: "local" | "amazon"; Indicates which speech engine to use for speech output. Use local to use the OS-specific TTS engine. Use amazon for Amazon Text-to-Speech cloud API. You must include the AWS API library and configure it with your API key before use. speechEngineRate: string; Sets the speed of the selected voice. One of x-slow, slow, medium, fast, x-fast or a value as a percentage. Range is 20% to 200% For example 200% to indicate a speaking rate twice the default rate. speechEngineVoice: string; Indicates the voice to use with the speech engine. This is dependent on the speech engine. For Amazon Polly, see here: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html textToSpeechMarkup: "" | "ssml" | "ssml_step" | "mac"; The markup syntax to use for the output of conversion to spoken text. Possible values are ssml for the SSML markup or mac for the macOS markup, i.e. &#91;&#91;ltr&#93;&#93;. textToSpeechRules: "mathlive" | "sre"; Specify which set of text to speech rules to use. A value of mathlive indicates that the simple rules built into MathLive should be used. A value of sre indicates that the Speech Rule Engine from Volker Sorge should be used. Caution SRE is not included or loaded by MathLive. For this option to work SRE should be loaded separately. textToSpeechRulesOptions: Record<string, string>; A set of key/value pairs that can be used to configure the speech rule engine. Which options are available depends on the speech rule engine in use. There are no options available with MathLive’s built-in engine. The options for the SRE engine are documented here readAloudHook: (element: HTMLElement, text: string, config: MathfieldOptions): void; speakHook: (text: string, config: Partial<MathfieldOptions>): void; UndoStateChangeListener Permalink (target: Mathfield, action: "undo" | "redo" | "snapshot"): void Variant Permalink Variants indicate a stylistic alternate for some characters. Typically, those are controlled with explicit commands, such as \mathbb{} or \mathfrak{}. This type is used with the applyStyle method to change the styling of a range of selected characters. In mathematical notation these variants are used not only for visual presentation, but they may have semantic significance. For example, the set ℂ should not be confused with the physical unit 𝖢 (Coulomb). When rendered, these variants can map to some built-in fonts. LaTeX supports a limited set of characters. However, MathLive will map characters not supported by LaTeX fonts(double-stuck variant for digits for example) to a Unicode character (see Mathematical Alphanumeric Symbols on Wikipedia ). normal is a synthetic variant that maps either to main (roman) or math (italic) depending on the symbol and the letterShapeStyle. The math variant has italic characters as well as slightly different letter shape and spacing (a bit more space after the “f” for example), so it’s not completely equivalent to a main variant with italic variant style applied. See Also • | "ams" • | "double-struck" • | "calligraphic" • | "script" • | "fraktur" • | "sans-serif" • | "monospace" • | "normal" • | "main" • | "math" VariantStyle Permalink Some variants support stylistic variations. Note that these stylistic variations support a limited set of characters, typically just uppercase and lowercase letters, and digits 0-9 in some cases. variant up bold italic bolditalic normal ABCabc012 𝐀𝐁𝐂𝐚𝐛𝐜𝟎𝟏𝟐 𝐴𝐵𝐶𝑎𝑏𝑐 𝑨𝑩𝑪𝒂𝒃𝒄 double-struck 𝔸𝔹ℂ𝕒𝕓𝕔𝟘𝟙𝟚 n/a n/a n/a calligraphic 𝒜ℬ𝒞𝒶𝒷𝒸 𝓐𝓑𝓒𝓪𝓫𝓬 n/a n/a fraktur 𝔄𝔅ℭ𝔞𝔟𝔠 𝕬𝕭𝕮𝖆𝖇𝖈 n/a n/a sans-serif 𝖠𝖡𝖢𝖺𝖻𝖼𝟢𝟣𝟤 𝗔𝗕𝗖𝗮𝗯𝗰𝟬𝟭𝟮 𝘈𝘉𝘊𝘢𝘣𝘤 𝘼𝘽𝘾𝙖𝙗𝙘 monospace 𝙰𝙱𝙲𝚊𝚋𝚌 n/a n/a n/a • | "up" • | "bold" • | "italic" • | "bolditalic" • | "" VirtualKeyboardMode Permalink See documentation for the virtual-keyboard-mode option. • | "auto" • | "manual" • | "onfocus" • | "off" VirtualKeyboardOptions Permalink customVirtualKeyboardLayers: Record<string, string | Partial<VirtualKeyboardLayer>>; Custom virtual keyboard layers. A keyboard is made up of one or more layers (think of the main layer and the shift layer on a hardware keyboard). Each key in this object define a new keyboard layer (or replace an existing one). The value of the key should be some HTML markup. customVirtualKeyboards: Record<string, VirtualKeyboardDefinition>; keypressSound: string | HTMLAudioElement | null | {default: null | string | HTMLAudioElement; delete: null | string | HTMLAudioElement; return: null | string | HTMLAudioElement; spacebar: null | string | HTMLAudioElement}; When a key on the virtual keyboard is pressed, produce a short audio feedback. If the property is set to a string or HTMLAudioElement, the same sound is played in all cases. Otherwise, a distinct sound is played: • delete a sound played when the delete key is pressed • return … when the return/tab key is pressed • spacebar … when the spacebar is pressed • default … when any other key is pressed. This key is required, the others are optional. If they are missing, this sound is played as well. The value of the properties should be either a string, the name of an audio file in the soundsDirectory directory, an HTMLAudioElement or null to suppress the sound. keypressVibration: boolean; When a key on the virtual keyboard is pressed, produce a short haptic feedback, if the device supports it. plonkSound: string | HTMLAudioElement | null; Sound played to provide feedback when a command has no effect, for example when pressing the spacebar at the root level. The property is either: • a string, the name of an audio file in the soundsDirectory directory • an HTMLAudioElement • null to turn off the sound virtualKeyboardContainer: null | HTMLElement; Element the virtual keyboard element gets appended to. The position attribute of this element should be relative so that the virtual keyboard can correctly be placed relative to this element. When using full screen elements that contain mathfield, set this property to the full screen element to ensure the virtual keyboard will be visible. Default: document.body virtualKeyboardLayout: "auto" | "qwerty" | "azerty" | "qwertz" | "dvorak" | "colemak"; virtualKeyboardMode: VirtualKeyboardMode; • "manual": pressing the virtual keyboard toggle button will show or hide the virtual keyboard. If hidden, the virtual keyboard is not shown when the field is focused until the toggle button is pressed. • "onfocus": the virtual keyboard will be displayed whenever the field is focused and hidden when the field loses focus. In that case, the virtual keyboard toggle button is not displayed. • "off": the virtual keyboard toggle button is not displayed, and the virtual keyboard is never triggered. • 'auto': "onfocus" on touch-capable devices and "off" otherwise (default). virtualKeyboardTheme: "material" | "apple" | ""; The visual theme of the virtual keyboard. If empty, the theme will switch automatically based on the device it’s running on. The two supported themes are ‘material’ and ‘apple’ (the default). virtualKeyboardToggleGlyph: string; Markup for the virtual keyboard toggle glyph. If none is specified a default keyboard icon is used. virtualKeyboardToolbar: VirtualKeyboardToolbarOptions; The right hand side toolbar configuration. Use none to disable right hand side toolbar of virtual keyboard. virtualKeyboards: "all" | "numeric" | "roman" | "greek" | "functions" | "symbols" | "latex" | string; A space separated list of the keyboards that should be available. The keyboard "all" is synonym with "numeric", "functions", “symbols” "roman" and "greek", The keyboards will be displayed in the order indicated. VirtualKeyboardTheme Permalink • | "apple" • | "material" • | "" VirtualKeyboardToolbarOptions Permalink • | "none" • | "default" module mathliveFunctions Converting Rendering Other Converting convertLatexToMarkup() Permalink convertLatexToMarkup(text, options?) text: string A string of valid LaTeX. It does not have to start with a mode token such as $$ or \(.

options?:
format: string;
letterShapeStyle: "tex" | "french" | "iso" | "upright" | "auto";
macros: MacroDictionary;

A dictionary of LaTeX macros

mathstyle: "displaystyle" | "textstyle";

If "displaystyle" the “display” mode of TeX is used to typeset the formula, which is most appropriate for formulas that are displayed in a standalone block.

If "textstyle" is used, the “text” mode of TeX is used, which is most appropriate when displaying math “inline” with other text (on the same line).

onError: ErrorListener<ParserErrorCode>;

A function invoked when a syntax error is encountered. An attempt to recover will be made even when an error is reported.

registers: Registers;
backgroundColorMap?: (name: string): undefined | string;
colorMap?: (name: string): undefined | string;
string

Convert a LaTeX string to a string of HTML markup.

Note

This function does not interact with the DOM. The function does not load fonts or inject stylesheets in the document. It can be used on the server side.

To get the output of this function to correctly display in a document, use the mathlive static style sheet by adding the following to the <head> of the document:

<link rel="stylesheet" href="https://unpkg.com/mathlive/dist/mathlive-static.css" />


convertLatexToMathMl(latex, options)
latex: string

A string of valid LaTeX. It does not have to start with a mode token such as a $$ or \(. options: Partial<{generateID: boolean; macros: MacroDictionary; onError: ErrorListener<ParserErrorCode>; registers: Registers; backgroundColorMap?: (name: string): undefined | string; colorMap?: (name: string): undefined | string}> string Convert a LaTeX string to a string of MathML markup. convertLatexToSpeakableText() Permalink convertLatexToSpeakableText(latex, options) latex: string A string of valid LaTeX. It does not have to start with a mode token such as a $$ or \(.

options: Partial<TextToSpeechOptions & {macros: MacroDictionary; onError: ErrorListener<ParserErrorCode | MathfieldErrorCode>; registers: Registers; backgroundColorMap?: (name: string): undefined | string; colorMap?: (name: string): undefined | string}>
string

The spoken representation of the input LaTeX.

Convert a LaTeX string to a textual representation ready to be spoken

console.log(convertLatexToSpeakableText('\\frac{1}{2}'));
// 'half'

Rendering

renderMathInDocument(options?: AutoRenderOptions): void

Transform all the elements in the document body that contain LaTeX code into typeset math.

Caution

This is a very expensive call, as it needs to parse the entire DOM tree to determine which elements need to be processed. In most cases this should only be called once per document, once the DOM has been loaded.

To render a specific element, use renderMathInElement()

import { renderMathInDocument } from 'https://unpkg.com/mathlive?module';
document.addEventListener("load", () => renderMathInDocument());

renderMathInElement(element, options?)
element:
• | string
• | HTMLElement

An HTML DOM element, or a string containing the ID of an element.

options?: AutoRenderOptions

Transform all the children of element that contain LaTeX code into typeset math, recursively.

Other

makeSharedVirtualKeyboard(options?)
options?: Partial<RemoteVirtualKeyboardOptions>

Options to configure the shared virtual keyboard.

<iframe src="...">
<!-- The iframe page content -->
<math-field virtual-keyboard-mode="onfocus" use-shared-virtual-keyboard />

<script type="module">
import 'https://unpkg.com/mathlive?module';
</script>
</iframe>

 import { makeSharedVirtualKeyboard } from 'https://unpkg.com/mathlive?module';

makeSharedVirtualKeyboard();


RemoteVirtualKeyboard

Setup the document to use a single shared virtual keyboard amongst all <math-field> instances in the document, including those in iframes.

makeSharedVirtualKeyboard() should be called as early as possible, and before any new mathfield element is created: it doesn’t apply retroactively.

<math-field> elements in an iframe should have the use-shared-virtual-keyboard attribute.

The shared virtual keyboard coordinates focus between multiple mathfield elements and renders the virtual keyboard with the options passed by param of this method.

Calling setOptions() on a mathfield with options related to the keyboard will affect this shared virtual keyboard instance when the mathfield is focused.

setKeyboardLayout(name: "auto" | KeyboardLayoutName): void

Change the current physical keyboard layout.

Note that this affects some keybindings, but not general text input.

If set to auto the keyboard layout is guessed.

Documentation built with grok`