docs: make all extenion settings a list
This commit is contained in:
@@ -18,10 +18,30 @@ yarn add @tiptap/extension-image
|
||||
```
|
||||
|
||||
## Settings
|
||||
| Option | Type | Default | Description |
|
||||
| -------------- | --------- | ------- | --------------------------------------------------------------------- |
|
||||
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
||||
| inline | `Boolean` | `false` | Renders the image node inline. |
|
||||
|
||||
### HTMLAttributes
|
||||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||||
|
||||
```js
|
||||
Image.configure({
|
||||
HTMLAttributes: {
|
||||
class: 'my-custom-class',
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### inline
|
||||
Renders the image node inline, for example in a paragraph tag: `<p><img src="spacer.gif"></p>`. By default images are on the same level as paragraphs.
|
||||
|
||||
It totally depends on what kind of editing experience you’d like to have, but can be useful if you (for example) migrate from Quill to tiptap.
|
||||
|
||||
Default: `false`
|
||||
|
||||
```js
|
||||
Image.configure({
|
||||
inline: true,
|
||||
})
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
|
||||
Reference in New Issue
Block a user