Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This macro is deprecated and replaced by the new Image Slider Macro

Use the Gallery Slider macro to display an image gallery with thumbnail navigation.

Parameters

Parameter

Default

Description

Width
width

600

Width of the slider in pixels.

Responsive Width
responsiveWidth

false

Enable to let the slider adapt to the available space. This will override any custom width.

Height
height

400

Height of the slider in pixels.

Attachment Labels
label

None - images of current page will be displayed

Filter images by one or more attachment labels. Leave blank to use images attached to current page. Example: blue,green,-redwill display all images with labels blue or green, excluding those labeled red.

Spaces
spaces

None - if any label is specified, images from all spaces will be displayed

Comma separated list of space keys to restrict searching of images, if any label is specified. Use @self for current space. Leave blank for all spaces.

Pages
pages

None - if any label is specified, images from all pages will be displayed, otherwise images of current page will be displayed

Comma separated list of pages to restrict searching of images. Use @self for current page. To specify a page in a different space, use the following syntax: SPACEKEY:Page Title

Sort Order
sort

creationDate

The order the images should be sorted by. Valid values are:

  • creationDate - Sort by creation date of attachment.

  • fileName - Sort by file name of attachment.

  • comment - Sort by attachment comment.

  • pageTitle - Sort by title of page, where the attachment is attached to.

  • pageCreationDate - Sort by creation date of page, where the attachment is attached to.

  • pageModificationDate - Sort by last modification date of page, where the attachment is attached to.

Reverse Order
reverseSort

false

Enable for reverse ordering.

Max Images
maxResults

None - no limit

Maximum number of images to be displayed. Leave blank for no limit.

Comment Usage
commentUsage

caption

Choose whether attachment comments should be used as image captions or external links. Valid values are:

  • caption - Comments are displayed as captions, if captions are enabled.

  • link - Comments are used as external links, if links are enabled.

  • captionAndLink - Comments are used as captions and external links. Use a vertical bar "|" in the comment to separate the caption from the link.
    Example: Caption|http://xyz.com

Show Captions
showCaptions

true

Enable to display attachment comments as image captions in slider. Comment usage has to be set to "caption".

Toggle Captions
toggleCaptions

true

Choose whether you want to display image captions permanently or allow users to toggle them.

Enable Links
enableLinks

false

Enable to link the images to the pages or blogposts where they are attached to. To link to external urls set comment usage to "link" and specify the url in the attachment comment field.

Open Links in new Window
openLinksInNewWindow

true

Choose whether to open links in the same or in a new window, if image links are enabled.

Effect
effect

fade

Choose between multiple transition effects. Valid values are:

  • fade

  • flash

  • pulse

  • slide

  • fadeslide

Auto Slide
autoSlide

true

Enable to automatically slide through images.

Display Time
delay

5000

Time (ms) how long each image will be shown.

Stop on Interaction
stopOnInteraction

true

Stop playback when user has clicked on thumbnail or navigation, if auto slide is enabled.

Background Color
backgroundColor

black

Background color of the gallery slider. Use hexadecimal notation or HTML color name.

Show Navigation
showNavigation

true

Choose to show prev/next navigation.

Show Slide Numbers
showSlideNumbers

true

Enable to show slide numbers.