docs: make all extenion settings a list
This commit is contained in:
@@ -14,13 +14,76 @@ yarn add @tiptap/extension-placeholder
|
||||
```
|
||||
|
||||
## Settings
|
||||
| Option | Type | Default | Description |
|
||||
| -------------------- | ------------------- | --------------------- | ----------------------------------------------------------- |
|
||||
| emptyEditorClass | `String` | `'is-editor-empty'` | The added CSS class if the editor is empty. |
|
||||
| emptyNodeClass | `String` | `'is-empty'` | The added CSS class if the node is empty. |
|
||||
| placeholder | `String | Function` | `'Write something …'` | The placeholder text added as `data-placeholder` attribute. |
|
||||
| showOnlyWhenEditable | `Boolean` | `true` | Show decorations only when editor is editable. |
|
||||
| showOnlyCurrent | `Boolean` | `true` | Show decorations only in currently selected node. |
|
||||
|
||||
### emptyEditorClass
|
||||
The added CSS class if the editor is empty.
|
||||
|
||||
Default: `'is-editor-empty'`
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
emptyEditorClass: 'is-editor-empty',
|
||||
})
|
||||
```
|
||||
|
||||
### emptyNodeClass
|
||||
The added CSS class if the node is empty.
|
||||
|
||||
Default: `'is-empty'`
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
emptyNodeClass: 'my-custom-is-empty-class',
|
||||
})
|
||||
```
|
||||
|
||||
### placeholder
|
||||
The placeholder text added as `data-placeholder` attribute.
|
||||
|
||||
Default: `'Write something …'`
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
placeholder: 'My Custom Placeholder',
|
||||
})
|
||||
```
|
||||
|
||||
You can even use a function to add placeholder depending on the node:
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
placeholder: ({ node }) => {
|
||||
if (node.type.name === 'heading') {
|
||||
return 'What’s the title?'
|
||||
}
|
||||
|
||||
return 'Can you add some further context?'
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### showOnlyWhenEditable
|
||||
Show decorations only when editor is editable.
|
||||
|
||||
Default: `true`
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
showOnlyWhenEditable: false,
|
||||
})
|
||||
```
|
||||
|
||||
### showOnlyCurrent
|
||||
Show decorations only in currently selected node.
|
||||
|
||||
Default: `true`
|
||||
|
||||
```js
|
||||
Placeholder.configure({
|
||||
showOnlyCurrent: false
|
||||
})
|
||||
```
|
||||
|
||||
|
||||
## Source code
|
||||
[packages/extension-placeholder/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-placeholder/)
|
||||
|
||||
Reference in New Issue
Block a user