Files

Hans Pagel 0edc57245c docs: add descriptions to all extensions

2021-10-14 00:13:50 +02:00

2.2 KiB

Raw Blame History

description

description
All the popular extensions in a single extension, doesn’t get much better than this.

StarterKit

The StarterKit is a collection of the most popular tiptap extensions. If you’re just getting started, this extension is for you.

Installation

# with npm
npm install @tiptap/starter-kit

# with Yarn
yarn add @tiptap/starter-kit

Included extensions

Nodes

Marks

Extensions

Source code

packages/starter-kit/

Usage

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
      history: false,

      // Configure an included extension
      heading: {
        levels: [1, 2],
      },
    }),
  ],
})

2.2 KiB Raw Blame History Unescape Escape