ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add moooore content

Browse Source
This commit is contained in:
Hans Pagel
2020-09-24 18:29:53 +02:00
parent e283ec4399
commit ab64afc249
7 changed files with 127 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/src/docPages/guide/custom-extensions.md
View File

@@ -2,14 +2,15 @@
Let’s extend tiptap with a custom extension!
## Option 1: Change defaults
Let’s say you want to change the keyboard shortcuts for the bullet list. You should start by looking at [the source code of the `Bold` extension](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/index.ts) and find the default you’d like to change. In that case, the keyboard shortcut.
Let’s say you want to change the keyboard shortcuts for the bullet list. You should start by looking at [the source code of the `BulletList` extension](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/index.ts) and find the default you’d like to change. In that case, the keyboard shortcut, and just that.
```js
// 1. Import the extension
import BulletList from '@tiptap/extension-bullet-list'
// 2. Overwrite the keyboard shortcuts
const CustomBulletList = new Node()
const CustomBulletList = BulletList()
.keys(({ editor }) => ({
'Mod-l': () => editor.bulletList(),
}))
@@ -24,6 +25,8 @@ new Editor({
})
```
You can overwrite every aspect of an existing extension. [Read more about that here.](/guide/custom-extensions/overwrite-defaults)
## Option 2: Extend existing extensions
## Option 3: Start from scratch