tiptap/docs/api/nodes/document.md
2021-10-14 21:20:21 +02:00

1.3 KiB
Raw Blame History

description icon
Everyone needs it, nobody talks about it: the Document extension. file-line

Document

Version Downloads

The Document extension is required, no matter what you build with tiptap. Its a so called “topNode”, a node thats the home to all other nodes. Think of it like the <body> tag for your document.

The node is very tiny though. It defines a name of the node (doc), is configured to be a top node (topNode: true) and that it can contain multiple other nodes (block+). Thats all. But have a look yourself:

:::warning Breaking Change from 1.x → 2.x tiptap 1 tried to hide that node from you, but it has always been there. You have to explicitly import it from now on (or use StarterKit). :::

Installation

# with npm
npm install @tiptap/extension-document

# with Yarn
yarn add @tiptap/extension-document

Source code

packages/extension-document/

Usage