Install | Tiptap Image Plus

Installation

This package supports both Tiptap v2 and v3. Choose the installation command based on your Tiptap version:

For Tiptap v3

# Install latest version (supports Tiptap v3)
npm install tiptap-image-plus@latest

# Or explicitly install the tiptap-v3 tag
npm install tiptap-image-plus@tiptap-v3

For Tiptap v2

# Install the tiptap-v2 tag
npm install tiptap-image-plus@tiptap-v2

Peer Dependencies

This package works with peer dependencies and requires the following package to be installed in your project:

npm install @tiptap/extension-image

Note: Make sure you have this peer dependency installed as it is required for the package to function properly. The package will not work without this Tiptap extension.

Configuration

ImagePlus extends the default Tiptap image extension. You can pass all @tiptap/extension-image options, plus:

Option	Type	Default	Description
wrapperStyle	object	{ }	CSS properties for the image wrapper
containerStyle	object	{ }	CSS properties for the image container

Example

ImagePlus.configure({
    wrapperStyle: { background: 'gray', borderRadius: '10px' },
    containerStyle: {
        background: "linear-gradient(90deg,rgba(30, 88, 117, 1) 0%, rgba(87, 199, 133, 1) 50%, rgba(237, 221, 83, 1) 100%)",
        padding: "25px",
        borderRadius: "10px",
    }
})