tiptap/docs/api/nodes/image.md

# Image
[![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 doesn’t upload images to your server, that’s a whole different story.
:::

## Installation
```bash
# 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.                                        |

## Source code
[packages/extension-image/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-image/)

## Usage
<tiptap-demo name="Nodes/Image"></tiptap-demo>
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
+								# Image
-												docs: add badges to all extensions

											
										
										
											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)
-												move everything around, add more content and a first test for images

											
										
										
											2020-11-03 23:43:35 +08:00
+								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.
 								:::
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
 								## Installation
 								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
+								npm install @tiptap/extension-image
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
+								yarn add @tiptap/extension-image
 								```
-												add inline option to image node

											
										
										
											2020-10-30 23:57:55 +08:00
+								## Settings
-												docs: add HTMLAttributes

											
										
										
											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.                                        |
-												add inline option to image node

											
										
										
											2020-10-30 23:57:55 +08:00
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
+								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-image/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-image/)
-												add basic image extension

											
										
										
											2020-10-27 22:32:55 +08:00
 								## Usage
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Nodes/Image"></tiptap-demo>