Find out what's new in Tiptap Editor 3.0
Tiptap Docs

PageKit

Restricted ReleaseAlpha

PageKit is a convenience extension that bundles the Pages and Table extensions together. It lets you configure both at once for a paginated, table-ready editor.

1. Install the Pages extension 

npm install @tiptap-pro/extension-page-kit

2. Import and use PageKit 

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import { PageKit } from '@tiptap-pro/extension-page-kit'

const editor = new Editor({
  extensions: [
    StarterKit,
    PageKit.configure({
      pages: {
        pageFormat: 'A4',
        headerLeft: 'My Project',
        footerRight: 'Page {page} of {total}',
      },
      table: {
        // Table options go here (optional)
        resizable: true,
      },
    }),
  ],
})

How it works

PageKit configures both the Pages and Table extensions for you. Pass your Pages options under pages and your Table options under table.

3. When to use PageKit?

  • Use PageKit for the fastest setup if you want both pagination and tables.
  • If you need to deeply customize Table or Pages, import and configure them individually.

4. Next steps