CKEditor Ecosystem Documentation
Search
Contribute to this guide
Home/CKEditor 5/Features

guideLinking images

The LinkImage plugin lets you use images as links.

# Demo

Click one of the images to open the contextual toolbar. Use the link icon Link to add a link to the image. After you do this, an icon will appear in the top-right corner of the image, indicating there is a link attached to it.

This demo presents a limited set of features. Visit the feature-rich editor example to see more in action.

# Additional feature information

Here are some use cases where linking images can be useful:

  • Linking to a high-resolution version of an image.
  • Using images as thumbnails linking to an article or product page.
  • Creating banners linking to other pages.

The image link can be added or edited via the image toolbar. An icon in top right corner of the image indicates the presence of a link.

An example source code for block image would look similar to this one:

<figure class="image">
    <a href="...">
        <img src="..." alt="...">
    </a>
    <figcaption>Image caption</figcaption>
</figure>

An inline image code would look more like this:

<a href="...">
    Some text <img src="..." alt="..." style="width: 20px">
</a>

# Installation

The image linking feature is not enabled by default in any of the editor builds. To enable it, you need to load the LinkImage plugin. Read more in the installation guide.

The LinkImage plugin is available in the @ckeditor/ckeditor5-link package.

# Common API

The LinkImage plugin registers:

We recommend using the official CKEditor 5 inspector for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.

# Contribute

The source code of the feature is available on GitHub at https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-link.