tiptap/docs/src/docPages/api/nodes/image.md

31 lines
1.3 KiB
Markdown
Raw Normal View History

2020-10-27 22:32:55 +08:00
# Image
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-image.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-image)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-image.svg)](https://npmcharts.com/compare/@tiptap/extension-image?minimal=true)
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 doesnt upload images to your server, thats a whole different story.
:::
2020-10-27 22:32:55 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-10-27 22:32:55 +08:00
npm install @tiptap/extension-image
2020-10-30 21:24:16 +08:00
# with Yarn
2020-10-27 22:32:55 +08:00
yarn add @tiptap/extension-image
```
2020-10-30 23:57:55 +08:00
## Settings
2020-11-18 19:12:34 +08:00
| 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. |
2020-10-30 23:57:55 +08:00
2020-10-27 22:32:55 +08:00
## Source code
[packages/extension-image/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-image/)
## Usage
<demo name="Nodes/Image" />