Commands

TyX commands are based on Lexical and Mathfield commands. The keyboard shortcuts correspond to command sequences, which are commands separated by a semicolon.

Commands consist of a command function followed by optional arguments. This page lists the available commands (stored in the commands file <https://github.com/tyx-editor/TyX/tree/main/src/commands.ts>_).

Toggle Keyboard Map

Given a keyboard map name (or null), if the current keyboard map is that given keyboard map, turn it off. Otherwise, turn it on.

Example: toggleKeyboardMap Hebrew

Format Element

Format the alignment of the current element to one of 'left', 'start', 'center', 'right', 'end', 'justify' or ''.

Example: formatElement center

Format Text

Toggle the format of the current selected text in one of 'bold', 'underline', 'strikethrough', 'italic', 'highlight', 'code', 'subscript', 'superscript'

Example: formatText bold

Clear Formatting

Clear all formatting of the selected text.

Example: clearFormatting

Undo

Undo the last command.

Example: undo

Redo

Redo the last command.

Example: redo

Insert Math

Inserts a math inline/block node according to the second parameter "inline". Setting it to true adds an inline math node.

Example: insertMath true

Insert Ordered List

Insert an ordered list.

Example: insertOrderedList

Insert Unordered List

Insert an unordered list.

Example: insertUnorderedList

Insert Line Break

Insert a line break. Moves to the new line if the second argument is true.

Example: insertUnorderedList true

Insert Horizontal Line

Insert a horizontal line.

Example: insertHorizontalLine

Insert Quote

Insert a quote node.

Example: insertQuote

Insert Code Block

Insert a code block node.

Example: insertCodeBlock

Insert Heading

Insert a heading node of the specified level.

Example: insertHeading 1

Example: insertHeading 6

Insert Typst Code

Insert a typst code node.

Example: insertTypstCode

Insert Image

Insert an image node with the given source URL. If no argument is given, open a dialog to pick an image.

Note: images are not supported on the web version due to local storage limit concerns.

Example: insertImage ./example.png

Example: insertImage

Insert Function Call

Insert a function call node with the given function (and optionally initial parameter values or inline customization).

If no parameters are passed, a modal is used to pick the function.

Example: insertFunctionCall footnote

Example: insertFunctionCall ["h", [{"type": "length", "value": "10", "unit": "pt"}]]

Example: insertFunctionCall

Set Function Call

Changes the currently selected function call to be the specified function.

If the definition's positional and named parameters is exactly the same, keeps the existing values.

If no function call is currently selected, inserts the specified function call.

Example: setFunctionCall h

Example: setFunctionCall v

Toggle Math Inline

Toggles the current math node between inline/block, or inserts a new block math node if no math node is selected.

Example: toggleMathInline

Math

Runs the given Mathfield command <https://cortexjs.io/mathfield/guides/commands/>_ in the currently selected math editor.

Example: math insert \alpha

Indent

Indents the current paragraph or list item (increases the indentation level by one).

Example: indent

Outdent

Outdents the current paragraph or list item (reduces the indentation level by one).

Example: outdent

Insert Table

Inserts a table with the given amount of rows/columns and whether headers are present.

Example: insertTable {"rows": 3, "columns": 3}

Example: insertTable {"rows": 2, "columns": 2, "includeHeaders": false}

Example: insertTable {"rows": 2, "columns": 2, "includeHeaders": {"rows": false, "columns": true}}

Table Insert Row Below

Inserts a row below the current row in the current table.

Example: tableInsertRowBelow

Table Insert Column Right

Inserts a column to the right of the current column in the current table.

Example: tableInsertColumnRight

Table Remove Row

Removes the current row in the current table.

Example: tableRemoveRow

Table Remove Column

Removes the current column in the current table.

Example: tableRemoveColumn

Set Link

Sets the link of the currently selected text to equal the given URL.

Example: setLink https://tyx-editor.com

Open Link Popup

Opens the link popup to choose a URL to toggle the currently selected text to link to.

Example: openLinkPopup

File Open

Opens the file open dialog.

Example: fileOpen

File New

Opens the new file dialog.

Example: fileNew

File New From Template

Opens the templates dialog to create a new file.

Example: fileNewFromTemplate

File Save

Save the current file.

Example: fileSave

File Save As

Opens the file save as dialog.

Example: fileSaveAs

File Export

Exports the file to the given format. Currently only typst is supported.

Example: fileExport typst

File Close

Closes the current file or the file at the specified index.

Example: fileClose

Example: fileClose 0

File Preview

Previews the current file as a PDF.

Example: filePreview

Open Settings

Opens the app settings modal.

Example: openSettings

Open Document Settings

Opens the document settings modal.

Example: openDocumentSettings