Lightbox Gallery

(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

albumLabel

Type: String Default Value: "image %1 of %2"


buttonStyleClass

Type: Styleclass


buttonText

Type: String


enabled

Type: Boolean Default Value: "false"


fadeDuration

Type: Number Default Value: 600


fitImagesInViewport

Type: Boolean Default Value: true


galleryVisible

Type: Boolean Default Value: true


hoverButtonIcon

Type: String Default Value: "fa fa-trash fa-lg"


imageBatchSize

The default / minimum value is 5 (the component will not render less than 5 images); it will load more when scrolling or using next in gallery mode.

Type: Number Default Value: 5


imageFadeDuration

Type: Number Default Value: 600


imagesFoundset

Component needs dataproviders from the foundset for the following: imageId, image, caption and thumbnail.

Type: JSFoundset


maxImageHeight

Type: Number


maxImageWidth

Type: Number


positionFromTop

Type: Number Default Value: 50


resizeDuration

Type: Number Default Value: 700


responsiveHeight

This will be the height of the component when used inside a responsive form; it will affect only responsive form usage.

Type: Number Default Value: 300


showCaptionInGallery

Type: Boolean Default Value: false


showImageNumberLabel

Type: Boolean Default Value: true


wrapAround

Type: Boolean Default Value: false


Events

onHoverButtonClicked(event,imageId)

Parameters:


API

refresh()

Refreshes the component by reinitializing its configuration and loading data. This can be used to apply updates or reset the gallery state.


showLightbox(index)

Opens the lightbox gallery at the specified index, defaulting to the first image if the index is invalid.

Parameters:

  • {Number} [index] The index of the image to display in the lightbox. If negative, the gallery will open at the first image.



Last updated

Was this helpful?