docs: remove most of the tables from the content (to improve the searchability)

This commit is contained in:
Hans Pagel
2021-10-07 21:02:30 +02:00
parent 9ed883edd4
commit c5f025909e
8 changed files with 183 additions and 104 deletions

View File

@@ -5,17 +5,52 @@
This utility helps with all kinds of suggestions in the editor. Have a look at the [`Mention`](/api/nodes/mention), [`Hashtag`](/api/nodes/hashtag) or [`Emoji`](/api/nodes/emoji) node to see it in action.
## Settings
| Option | Type | Default | Description |
| --------------- | ----------- | --------------------- | ----------------------------------------------------------- |
| char | `String` | `'@'` | The character that triggers the autocomplete popup. |
| pluginKey | `PluginKey` | `SuggestionPluginKey` | A ProseMirror PluginKey. |
| allowSpaces | `Boolean` | `false` | Allows or disallows spaces in suggested items. |
| startOfLine | `Boolean` | `false` | Trigger the autocomplete popup at the start of a line only. |
| decorationTag | `String` | `'span'` | The HTML tag that should be rendered for the suggestion. |
| decorationClass | `String` | `'suggestion'` | A CSS class that should be added to the suggestion. |
| command | `Function` | `() => {}'` | Executed when a suggestion is selected. |
| items | `Function` | `() => {}` | Pass an array of filtered suggestions, can be async. |
| render | `Function` | `() => ({})` | A render function for the autocomplete popup. |
### char
The character that triggers the autocomplete popup.
Default: `'@'`
### pluginKey
A ProseMirror PluginKey.
Default: `SuggestionPluginKey`
### allowSpaces
Allows or disallows spaces in suggested items.
Default: `false`
### startOfLine
Trigger the autocomplete popup at the start of a line only.
Default: `false`
### decorationTag
The HTML tag that should be rendered for the suggestion.
Default: `'span'`
### decorationClass
A CSS class that should be added to the suggestion.
Default: `'suggestion'`
### command
Executed when a suggestion is selected.
Default: `() => {}'`
### items
Pass an array of filtered suggestions, can be async.
Default: `() => {}`
### render
A render function for the autocomplete popup.
Default: `() => ({})`
## Source code
[packages/suggestion/](https://github.com/ueberdosis/tiptap/blob/main/packages/suggestion/)