add placeholder extension
This commit is contained in:
29
docs/src/docPages/api/extensions/placeholder.md
Normal file
29
docs/src/docPages/api/extensions/placeholder.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Placeholder
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-placeholder)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-placeholder?minimal=true)
|
||||
|
||||
This extension provides placeholder support.
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
# with npm
|
||||
npm install @tiptap/extension-placeholder
|
||||
|
||||
# with Yarn
|
||||
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. |
|
||||
|
||||
## Source code
|
||||
[packages/extension-placeholder/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-placeholder/)
|
||||
|
||||
## Usage
|
||||
<demo name="Extensions/Placeholder" />
|
||||
Reference in New Issue
Block a user