mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-16 11:49:02 +08:00
34 lines
1012 B
Markdown
34 lines
1012 B
Markdown
# 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](/api/commands/set-text-selection), [blur](/api/commands/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: boolean }`
|
||
|
||
Defines whether to scroll to the cursor when focusing. Defaults to `true`.
|
||
|
||
## Usage
|
||
```js
|
||
// 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)
|
||
```
|