Files
tiptap/docs/src/docPages/api/extensions.md

6.3 KiB
Raw Blame History

Extensions

Table of Contents

Introduction

Extensions are the way to add functionality to tiptap. By default tiptap comes bare, without any of them, but we have a long list of extensions that are ready to be used with tiptap.

A minimalist set of extensions

Youll need at least three extensions: Document, Paragraph and Text. See an example of a tiptap version for minimalists.

Default extensions

You dont have to use it, but we prepared a @tiptap/vue-starter-kit which includes the most common extensions. See how you can use the defaultExtensions().

List of supported extensions

Title Default Extension Source Code
Blockquote Yes GitHub
Bold Yes GitHub
BulletList Yes GitHub
Code Yes GitHub
CodeBlock Yes GitHub
Collaboration GitHub
CollaborationCursor GitHub
Document Yes GitHub
HardBreak Yes GitHub
Heading Yes GitHub
History Yes GitHub
HorizontalRule Yes GitHub
Italic Yes GitHub
Link GitHub
ListItem Yes GitHub
OrderedList GitHub
Paragraph Yes GitHub
Strike Yes GitHub
Text Yes GitHub
Underline GitHub

Community extensions

:::warning Work in Progress This section is not ready yet. Meanwhile, search through GitHub issues to find code snippets. :::

Your custom extensions

Didnt find what youre looking for? No worries, you can build your own extensions.