mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-15 11:09:01 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
f6a242438e
tiptap/docs/src/docPages/api/extensions/placeholder.md
Hans Pagel f6a242438e replace link to GitHub repository
2021-04-21 15:31:11 +02:00

1.7 KiB
Raw Blame History

Placeholder

Version Downloads

This extension provides placeholder support. Give your users an idea what they should write with a tiny hint. There is a handful of things to customize, if you feel like it.

Installation

# 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 …'
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/

Usage