Tiptap Docs

StarterKit extension

VersionDownloads

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

Marks

Extensions

Source code

packages/starter-kit/

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],
      },
    }),
  ],
})

Tiptap does not allow two extensions with the same name property. If a custom extension has the same name as one of the extensions included in StarterKit, disable it:

import { Editor, Mark } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import Link from '@tiptap/extension-link'

const CustomLinkExtension = Mark.create({
  name: 'link',
})

const editor = new Editor({
  extensions: [
    StarterKit.configure({
      // Disable the Link extension
      // so it does not conflict with CustomLinkExtension
      link: false,
    }),
    CustomLinkExtension,
  ],
})
PreviouslySelection