mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-24 01:17:50 +08:00
86 lines
2.4 KiB
Markdown
86 lines
2.4 KiB
Markdown
---
|
||
description: All the popular extensions in a single extension. Doesn’t get much better than this.
|
||
icon: stack-line
|
||
---
|
||
|
||
# StarterKit
|
||
[](https://www.npmjs.com/package/@tiptap/starter-kit)
|
||
[](https://npmcharts.com/compare/@tiptap/starter-kit?minimal=true)
|
||
|
||
The `StarterKit` is a collection of the most popular Tiptap extensions. If you’re just getting started, this extension is for you.
|
||
|
||
## Installation
|
||
```bash
|
||
npm install @tiptap/starter-kit
|
||
```
|
||
|
||
:::warning Are you using Yarn, pNPM, npm 6 or less?
|
||
Unfortunately your package manager does not install peer dependencies automatically and you have to install them by your own. Please [see here](https://tiptap.dev/installation/peer-dependencies#tiptapstarter-kit) which packages are needed and how to install them.
|
||
:::
|
||
|
||
## Included extensions
|
||
|
||
### Nodes
|
||
* [`Blockquote`](/api/nodes/blockquote)
|
||
* [`BulletList`](/api/nodes/bullet-list)
|
||
* [`CodeBlock`](/api/nodes/code-block)
|
||
* [`Document`](/api/nodes/document)
|
||
* [`HardBreak`](/api/nodes/hard-break)
|
||
* [`Heading`](/api/nodes/heading)
|
||
* [`HorizontalRule`](/api/nodes/horizontal-rule)
|
||
* [`ListItem`](/api/nodes/list-item)
|
||
* [`OrderedList`](/api/nodes/ordered-list)
|
||
* [`Paragraph`](/api/nodes/paragraph)
|
||
* [`Text`](/api/nodes/text)
|
||
|
||
### Marks
|
||
* [`Bold`](/api/marks/bold)
|
||
* [`Code`](/api/marks/code)
|
||
* [`Italic`](/api/marks/italic)
|
||
* [`Strike`](/api/marks/strike)
|
||
|
||
### Extensions
|
||
* [`Dropcursor`](/api/extensions/dropcursor)
|
||
* [`Gapcursor`](/api/extensions/gapcursor)
|
||
* [`History`](/api/extensions/history)
|
||
|
||
## Source code
|
||
[packages/starter-kit/](https://github.com/ueberdosis/tiptap/blob/main/packages/starter-kit/)
|
||
|
||
## Usage
|
||
Pass `StarterKit` to the editor to load all included extension at once.
|
||
|
||
```js
|
||
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.
|
||
|
||
```js
|
||
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],
|
||
},
|
||
}),
|
||
],
|
||
})
|
||
```
|