tiptap/docs/api/commands/focus.md

focus

This command sets the focus back to the editor.

When a user clicks on a button outside the editor, the browser sets the focus to that button. In most scenarios you want to focus the editor then again. That’s why you’ll see that in basically every demo here.

See also: setTextSelection, blur

Parameters

position: 'start' | 'end' | 'all' | number | boolean | null (false)

By default, it’s restoring the cursor position (and text selection). Pass a position to move the cursor too.

options: { scrollIntoView: boolen }

Defines whether to scroll to the cursor when focusing. Defaults to true.

Usage

// Set the focus to the editor
editor.commands.focus()

// Set the cursor to the first position
editor.commands.focus('start')

// Set the cursor to the last position
editor.commands.focus('end')

// Selects the whole document
editor.commands.focus('all')

// Set the cursor to position 10
editor.commands.focus(10)