Gallery options
Galleries have many options that can be enabled in order to change various Gallery functionalities.
The same set of options as for the Web Component can be used for the Embed Code.
disable-captions
optionalfalseBoolean to hide all the image captions, including the custom generated via gallery-caption
option
Option (Web Component) | Type | Default value | Description |
---|---|---|---|
image-id |
mandatory | – | List of image ids separated by comma. |
theme |
optional | – | Theme name that overrides the default theme in use. |
gallery-caption |
optional | – | Text value that overrides all the image captions with a single caption. |
gallery-captions |
optional | – | JSON string that overrides individual image captions and overrides gallery-caption (if any). If some image ids are missing or wrong in the attribute, then their default caption value is loaded instead (if any). The JSON string can carry HTML data, useful for providing custom captions.
Web Component example: |
gallery-attribution |
optional | – | Text value that overrides the theme attribution for off-site embeds with a custom attribution. |
autoplay |
optional | false | Boolean to start autoplay the Gallery slides. On mouseover or tap the autoplay feature is stopped. |
interval |
optional | – | Number value (milliseconds) that sets the delay between each image. Default value is 5000 (milliseconds). |
social-media-first-line |
optional | – | Text value that provides a custom description for the first line of the social media preview (Facebook, X, LinkedIn). If no social-media-first-line , default Control settings from the first image in the Gallery are applied. |
social-media-second-line |
optional | – | Text value that provides a custom description for the second line of the social media preview (Facebook, X, LinkedIn). If no social-media-second-line , default Control settings from the first image of the Gallery are applied. |