2020-11-02 22:54:15 +08:00
|
|
|
|
# Focus
|
2021-01-25 17:35:52 +08:00
|
|
|
|
[![Version](https://img.shields.io/npm/v/@tiptap/extension-focus.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-focus)
|
|
|
|
|
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-focus.svg)](https://npmcharts.com/compare/@tiptap/extension-focus?minimal=true)
|
|
|
|
|
|
2020-11-06 04:57:25 +08:00
|
|
|
|
The Focus extension adds a CSS class to focused nodes. By default it adds `.has-class`, 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.
|
2020-11-02 22:54:15 +08:00
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
```bash
|
|
|
|
|
# with npm
|
|
|
|
|
npm install @tiptap/extension-focus
|
|
|
|
|
|
|
|
|
|
# with Yarn
|
|
|
|
|
yarn add @tiptap/extension-focus
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Settings
|
2021-02-06 01:13:51 +08:00
|
|
|
|
| Option | Type | Default | Description |
|
|
|
|
|
| --------- | -------- | ------------- | ---------------------------------------------------------------------------- |
|
|
|
|
|
| className | `String` | `'has-focus'` | The class that is applied to the focused element. |
|
2021-02-06 01:14:18 +08:00
|
|
|
|
| mode | `String` | `'all'` | Apply the class to `'all'`, the `'shallowest'` or the `'deepest'` node. |
|
2020-11-02 22:54:15 +08:00
|
|
|
|
|
|
|
|
|
## Source code
|
2021-04-21 21:31:11 +08:00
|
|
|
|
[packages/extension-focus/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-focus/)
|
2020-11-02 22:54:15 +08:00
|
|
|
|
|
|
|
|
|
## Usage
|
2020-11-06 21:49:40 +08:00
|
|
|
|
<demo name="Extensions/Focus" highlight="12,34-37" />
|