The image widget is a simple method of adding an image to a page with optional title and description. Images that are added within the content widget, or any widget with an enabled text editor, will not follow the same image widget structure or have the same options.
By default, the image widget must have a
src option that is an image from the template. All other options are not essential.
In this example the image widget is being used to place a logo into the header area:
The image widget has a range of options, both for the content restraints but also for user information:
src: The path of the image, this is relative to the template. This means that you will need to include the image in your images or assets directory of your template.
title: The title of the image, this will be applied to the
titleattribute of the
imgand the title shown in the caption details below the image.
description: The description shown below the image in the caption details.
alt: The alternate text for when images fail to load in the browser, placed in the
fileName: The name shown in the Editor UI.
fileSize: The file size shown in KB in the Editor UI.
imageWidth: The width of the image, set into the
widthattribute of the
imageWidth can all be changed be the user within the Editor. The other options will be relative to the image and will be replaced if the image is changed.