StarterKit extension
The StarterKit
is a collection of the most popular Tiptap extensions. If you’re just getting started, this extension is for you.
Install
npm install @tiptap/starter-kit
Included extensions
Nodes
Blockquote
BulletList
CodeBlock
Document
HardBreak
Heading
HorizontalRule
ListItem
OrderedList
Paragraph
Text
Marks
Extensions
Dropcursor
Gapcursor
Undo/Redo
ListKeymap
(New in v3)TrailingNode
(New in v3)
Source code
Using the StarterKit extension
Pass StarterKit
to the editor to load all included extension at once.
import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
const editor = new Editor({
content: '<p>Example Text</p>',
extensions: [StarterKit],
})
You can configure the included extensions, or even disable a few of them, like shown below.
import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
const editor = new Editor({
content: '<p>Example Text</p>',
extensions: [
StarterKit.configure({
// Disable an included extension
undoRedo: false,
// Configure an included extension
heading: {
levels: [1, 2],
},
}),
],
})