Skip to main content

Image Preview

buildfire.imagePreviewer#

The fullscreen image preview allows a developer to instantiate a fullscreen image carousel in app. This is to give a better viewing experience to the end user.

Methods#

show()
#

buildfire.imagePreviewer.show(options, callback)

Displayes a full screen image previewer

buildfire.imagePreviewer.show(
{
images: ["https://placekitten.com/"],
},
() => {
console.log("Image previewer closed");
}
);

options#

NameTypeRequiredDescriptionDefault
images[string]tesArray of image urls to display in full screen image carousel
indexnumbernoIndex of image to start carousel from0

callback()#

Callback function that gets called when carousel is closed