docs(docs): 📝 add missing documentation for commands
This commit is contained in:
@@ -1,5 +1,26 @@
|
||||
# toggleMark
|
||||
The `toggleMark` command toggles a specific mark on and off at the current selection.
|
||||
|
||||
:::warning
|
||||
Oops, we didn’t 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, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis)
|
||||
:::
|
||||
## Parameters
|
||||
`typeOrName: string | MarkType`
|
||||
|
||||
The type of mark that should be toggled.
|
||||
|
||||
`attributes?: Record<string, any>`
|
||||
|
||||
The attributes that should be applied to the mark. **This is optional.**
|
||||
|
||||
`options?: Record<string, any>`
|
||||
* `extendEmptyMarkRange: boolean` - Removes the mark even across the current selection. Defaults to `false`
|
||||
|
||||
## Usage
|
||||
```js
|
||||
// toggles a bold mark
|
||||
editor.commands.toggleMark('bold')
|
||||
|
||||
// toggles bold mark with a color attribute
|
||||
editor.commands.toggleMark('bold', { color: 'red' })
|
||||
|
||||
// toggles a bold mark with a color attribute and removes the mark across the current selection
|
||||
editor.commands.toggleMark('bold', { color: 'red' }, { extendEmptyMarkRange: true })
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user