2020-08-13 15:47:32 +08:00
# Extensions
2020-08-31 23:34:09 +08:00
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.
2020-08-21 04:20:56 +08:00
2020-09-27 16:29:01 +08:00
## Table of Contents
2020-08-21 04:20:56 +08:00
## A minimalist set of extensions
2020-09-25 03:47:04 +08:00
You’ ll need at least three extensions: `Document` , `Paragraph` and `Text` . See [an example of a tiptap version for minimalists ](/examples/minimalist ).
2020-08-21 04:20:56 +08:00
2020-08-31 23:34:09 +08:00
## Default extensions
You don’ t 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()` ](/examples/basic ).
## List of supported extensions
2020-09-27 03:11:42 +08:00
| Title | Default Extension | Source Code |
| ----------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------ |
| [Blockquote ](/api/extensions/blockquote ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/ ) |
| [Bold ](/api/extensions/bold ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/ ) |
| [BulletList ](/api/extensions/bullet-list ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/ ) |
| [Code ](/api/extensions/code ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/ ) |
| [CodeBlock ](/api/extensions/code-block ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/ ) |
| [Collaboration ](/api/extensions/collaboration ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration/ ) |
| [CollaborationCursor ](/api/extensions/collaboration-cursor ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration-cursor/ ) |
| [Document ](/api/extensions/document ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/ ) |
| [HardBreak ](/api/extensions/hard-break ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/ ) |
| [Heading ](/api/extensions/heading ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/ ) |
| [History ](/api/extensions/history ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/ ) |
| [HorizontalRule ](/api/extensions/horizontal-rule ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/ ) |
| [Italic ](/api/extensions/italic ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/ ) |
| [Link ](/api/extensions/link ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/ ) |
| [ListItem ](/api/extensions/list-item ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/ ) |
| [OrderedList ](/api/extensions/ordered-list ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/ ) |
| [Paragraph ](/api/extensions/paragraph ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/ ) |
| [Strike ](/api/extensions/strike ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/ ) |
| [Text ](/api/extensions/text ) | Yes | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/ ) |
2020-09-27 16:38:59 +08:00
| [Underline ](/api/extensions/underline ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/ ) |
2020-08-21 04:20:56 +08:00
2020-09-08 20:26:17 +08:00
<!-- | [CodeBlockHighlight ](/api/extensions/code-block-highlight ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packagescode-block-highlight/extension-/ ) -->
<!-- | [Mention ](/api/extensions/mention ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-mention/ ) -->
<!-- | [Placeholder ](/api/extensions/placeholder ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-placeholder/ ) -->
<!-- | [TableCell ](/api/extensions/table-cell ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-cell/ ) -->
<!-- | [TableHeader ](/api/extensions/table-header ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-header/ ) -->
<!-- | [TableRow ](/api/extensions/table-row ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-row/ ) -->
<!-- | [TodoItem ](/api/extensions/todo-item ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-item/ ) -->
<!-- | [TodoList ](/api/extensions/todo-list ) | – | [GitHub ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-list/ ) -->
2020-08-21 04:20:56 +08:00
## Community extensions
2020-08-31 23:34:09 +08:00
:::warning Work in Progress
2020-09-15 23:30:01 +08:00
This section is not ready yet. Meanwhile, [search through GitHub issues ](https://github.com/ueberdosis/tiptap/issues ) to find code snippets.
2020-08-31 23:34:09 +08:00
:::
2020-08-21 04:20:56 +08:00
## Your custom extensions
2020-08-31 23:34:09 +08:00
Didn’ t find what you’ re looking for? No worries, [you can build your own extensions ](/guide/custom-extensions ).