plainleaf/docs/API/editor.md

#api/syscall

The Editor API provides functions for interacting with the editor interface.

editor.getCurrentPage()

Returns the Names of the page (or document) currently open in the editor.

Example: ${editor.getCurrentPage()}

editor.getCurrentPageMeta()

Returns the meta data of the page (or document) currently open in the editor.

Example: ${editor.getCurrentPageMeta()}

editor.getCurrentPath()

Returns the Paths of the page or document currently open in the editor.

Example: ${editor.getCurrentPath()}

editor.getCurrentEditor()

Returns the name of the currently open editor.

Example:

local editorName = editor.getCurrentEditor()
print(editorName)

editor.getText()

Returns the full text of the currently open page.

Example:

local text = editor.getText()
print("Document length: " .. #text)

editor.getCurrentLine()

Returns the current line range and text.

Example:

local line = editor.getCurrentLine()
print("from " .. line.from .. " to " .. line.to .. " text " .. line.text .. " text with cursor " .. line.textWithCursor)

editor.setText(text, isolateHistory)

Updates the editor text while preserving cursor location.

Example:

local text = editor.getText()
editor.setText(text:upper(), false)  -- Convert to uppercase

editor.insertAtPos(text, pos)

Insert text at the specified position.

Example:

editor.insertAtPos("Hello!", 0)  -- Insert at beginning

editor.replaceRange(from, to, text)

Replace text in the specified range.

Example:

editor.replaceRange(0, 5, "New text")

editor.insertAtCursor(text, scrollIntoView?)

Insert text at the current cursor position.

Example:

editor.insertAtCursor("Inserted at cursor")

editor.getCursor()

Returns the cursor position as character offset.

Example:

local pos = editor.getCursor()
print("Cursor at position: " .. pos)

editor.getSelection()

Returns the current selection range.

Example:

local sel = editor.getSelection()
print("Selection from " .. sel.from .. " to " .. sel.to)

editor.setSelection(from, to)

Sets the current selection range.

Example:

editor.setSelection(0, 10)  -- Select first 10 characters

editor.moveCursor(pos, center)

Move the cursor to a specific position.

Example:

editor.moveCursor(0, true)  -- Move to start and center

editor.moveCursorToLine(line, column, center)

Move the cursor to a specific line and column.

Example:

editor.moveCursorToLine(1, 1, true)  -- Move to start of first line

editor.invokeCommand(name, args?)

Invokes a client command by name.

Example:

editor.invokeCommand("Stats: Show")

editor.save()

Force saves the current page.

Example:

editor.save()

editor.navigate(ref, replaceState?, newWindow?)

Navigates to the specified page reference.

Parameters:

• ref: The (string) reference to navigate to, see ../Link#Link syntax (String refs)
• replaceState: Whether to replace the current history state
• newWindow: Whether to open in a new window

Example:

editor.navigate("CHANGELOG@123")

editor.open(ref, replaceState?, newWindow?)

Opens the specified page reference. Unlike editor.navigate, which always opens the page fresh (at the top, or at an explicit pointer such as #header/@pos), editor.open does a best-effort restore of the cursor and scroll position you last had on that page during this session. An explicit pointer in the ref still takes precedence.

Parameters:

• ref: The (string) reference to open, see ../Link#Link syntax (String refs)
• replaceState: Whether to replace the current history state
• newWindow: Whether to open in a new window

Example:

editor.open("CHANGELOG")

editor.openPageNavigator(mode)

Opens the page navigator.

Example:

editor.openPageNavigator("page")

editor.openCommandPalette()

Opens the command palette.

Example:

editor.openCommandPalette()

editor.reloadPage()

Force reloads the current page.

Example:

editor.reloadPage()

editor.reloadUI()

Force reloads the browser UI.

Example:

editor.reloadUI()

editor.rebuildEditorState()

Rebuilds the editor state to ensure the dispatch updates the state.

Example:

editor.rebuildEditorState()

editor.reloadConfigAndCommands()

Reloads the config and commands, also in the server.

Example:

editor.reloadConfigAndCommands()

editor.openUrl(url, existingWindow?)

Opens the specified URL in the browser.

Example:

editor.openUrl("https://example.com")

editor.newWindow()

Opens a new window.

Example:

editor.newWindow()

editor.goHistory(delta)

Moves in the browser history.

Example:

editor.goHistory(-1)  -- Go back

editor.showPanel(id, mode, html, script)

Shows a panel in the editor.

Example:

editor.showPanel("rhs", 1, "<h1>Hello</h1>")

editor.hidePanel(id)

Hides a panel in the editor.

Example:

editor.hidePanel("rhs")

editor.flashNotification(message, type, options?)

Shows a flash notification.

Parameters:

• message: The message to display
• type: Notification type — "info" (default), "error", or "warning"
• options (optional): Table with additional options:
  • timeout: Dismiss timeout in milliseconds. Use 0 for persistent notifications (default: 4000/5000/8000 depending on type)
  • actions: List of action buttons, each with:
    • name: Button label
    • run: Function to call when clicked (auto-dismisses the notification)

Example:

-- Simple notification
editor.flashNotification("Operation completed", "info")

-- Persistent notification with action button
editor.flashNotification("Update available", "warning", {
  timeout = 0,
  actions = {
    {
      name = "Reload",
      run = function()
        editor.reloadUI()
      end
    }
  }
})

editor.downloadFile(filename, dataUrl)

Triggers a file download in the browser.

Example:

editor.downloadFile("test.txt", "data:text/plain;base64,SGVsbG8=")

editor.uploadFile(accept, capture)

Opens a file upload dialog.

Example:

local file = editor.uploadFile(".txt", nil)
print("Uploaded: " .. file.name)

editor.copyToClipboard(data)

Copies data to the clipboard.

Note

Note Requires HTTPS, see Install/Network and Internet

Example:

editor.copyToClipboard("Copied text")

editor.filterBox(label, options, helpText?, placeHolder?)

Shows a filter box UI.

Example:

local result = editor.filterBox("Select:", {
    { name="Option 1", value="1" },
    { name="Option 2", value="2", description="More details about 2" }
})

editor.toggleFold()

Toggles code folding at the current position.

Example:

editor.toggleFold()

editor.foldAll()

Folds all foldable regions.

Example:

editor.foldAll()

editor.unfoldAll()

Unfolds all folded regions.

Example:

editor.unfoldAll()

editor.undo()

Undoes the last change.

Example:

editor.undo()

editor.redo()

Redoes the last undone change.

Example:

editor.redo()

editor.openSearchPanel()

Opens the editor's search panel.

Example:

editor.openSearchPanel()

editor.deleteLine()

Deletes the current line.

Example:

editor.deleteLine()

editor.toggleComment()

Comments or uncomments the current line.

Example:

editor.toggleComment()

editor.moveLineUp()

Moves the current line up.

Example:

editor.moveLineUp()

editor.moveLineDown()

Moves the current line down.

Example:

editor.moveLineDown()

editor.vimEx(exCommand)

Executes a Vim ex command.

Example:

editor.vimEx(":w")

editor.sendMessage(type, data?)

Sends a message to the editor.

Example:

editor.sendMessage("custom-event", { data: "value" })

editor.prompt(message, defaultValue?)

Shows a prompt dialog.

Example:

local result = editor.prompt("Enter your name:", "John")

editor.confirm(message)

Shows a confirmation dialog.

Example:

local confirmed = editor.confirm("Are you sure?")

editor.alert(message)

Shows an alert dialog.

Example:

editor.alert("Operation completed")

editor.getUiOption(key)

Gets a UI option value.

Example:

local theme = editor.getUiOption("theme")

editor.setUiOption(key, value)

Sets a UI option value.

Example:

editor.setUiOption("theme", "dark")