mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-14 02:09:01 +08:00
52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
---
|
||
description: Keep track of where the cursor is, and let the user know you know it.
|
||
icon: focus-line
|
||
---
|
||
|
||
# Focus
|
||
[](https://www.npmjs.com/package/@tiptap/extension-focus)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-focus?minimal=true)
|
||
|
||
The Focus extension adds a CSS class to focused nodes. By default it adds `.has-focus`, but you can change that.
|
||
|
||
Note that it’s only a class, the styling is totally up to you. The usage example below has some CSS for that class.
|
||
|
||
## Installation
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-focus
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-focus
|
||
```
|
||
|
||
## Settings
|
||
|
||
### className
|
||
The class that is applied to the focused element.
|
||
|
||
Default: `'has-focus'`
|
||
|
||
```js
|
||
Focus.configure({
|
||
className: 'focus',
|
||
})
|
||
```
|
||
|
||
### mode
|
||
Apply the class to `'all'`, the `'shallowest'` or the `'deepest'` node.
|
||
|
||
Default: `'all'`
|
||
|
||
```js
|
||
Focus.configure({
|
||
mode: 'deepest',
|
||
})
|
||
```
|
||
|
||
## Source code
|
||
[packages/extension-focus/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-focus/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Extensions/Focus"></tiptap-demo>
|