docs(docs): 📝 add missing documentation for commands

This commit is contained in:
Dominik Biedebach
2022-06-08 12:41:14 +02:00
parent 43f8843c3e
commit 4abd7c8827
12 changed files with 151 additions and 44 deletions

View File

@@ -1,5 +1,20 @@
# toggleList
`toggleList` will toggle between different types of lists.
:::warning
Oops, we didnt find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, its still a side project for us. Lets change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis)
:::
## Parameters
`listTypeOrName: string | NodeType`
The type of node that should be used for the wrapping list
`itemTypeOrName: string | NodeType`
The type of node that should be used for the list items
## Usage
```js
// toggle a bullet list with list items
editor.commands.toggleList('bullet_list', 'list_item')
// toggle a numbered list with list items
editor.commands.toggleList('ordered_list', 'list_item')
```