Skip to content

Extension Registry

The extension registry controls the default Tiptap extension set. You usually do not need it when using an adapter. Use Core's createEditorExtensions when you need to remove features, replace default extensions, or build a headless editor.

ts
import { createEditorExtensions } from 'tiptap-vue-pro-core'

const extensions = createEditorExtensions({
  placeholderText: 'Write something...',
  markdown: true,
  table: true,
  image: true,
})

Then pass it to an adapter:

vue
<ProEditorElementPlus v-model="content" :extensions="extensions" />

Options

ts
interface EditorExtensionConfig {
  placeholder?: boolean
  placeholderText?: string
  starterKit?: boolean
  characterCount?: boolean
  image?: boolean
  table?: boolean
  typography?: boolean
  highlight?: boolean
  textAlign?: boolean
  blockIndent?: boolean
  codeBlock?: boolean
  script?: boolean
  taskList?: boolean
  markdown?: boolean
}

TIP

Passing extensions replaces the default extension array. If you only want to customize fonts, sizes, palettes, code languages, divider styles, table grid, or similar menu data, prefer toolbarOptions.

When to Use It

GoalRecommendation
Only change toolbar buttonsUse toolbar
Only change fonts, sizes, palettes, code languages, or divider stylesUse toolbarOptions
Only change link target, table headers, image/media accept, or size limitsUse editorBehaviorOptions
Disable a Tiptap extensionUse createEditorExtensions
Add a custom Tiptap extensionAssemble extensions yourself and pass them to the component

A community package built on Tiptap v3 + Vue 3.