1.6 KiB
1.6 KiB
Image
Use this extension to render <img> HTML tags. By default, those images are blocks. If you want to render images in line with text set the inline option to true.
:::warning Restrictions This extension does only the rendering of images. It doesn’t upload images to your server, that’s a whole different story. :::
Installation
# with npm
npm install @tiptap/extension-image
# with Yarn
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. |
Commands
setImage()
Makes the current node an image.
editor.commands.setImage({ src: 'https://example.com/foobar.png')
editor.commands.setImage({ src: 'https://example.com/foobar.png', alt: 'A boring example image', title: 'An example' })