> For the complete documentation index, see [llms.txt](https://attr.sygnal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://attr.sygnal.com/sa5-elements/lightbox/slider-code-examples.md).

# Lightbox JS API

{% hint style="warning" %}
**BETA.** This API may change in future releases.
{% endhint %}

## Reset Webflow Lightboxes <a href="#wfu-lightbox-captions-attribute" id="wfu-lightbox-captions-attribute"></a>

When you dynamically create or modify Webflow's lightbox elements, you'll need to reset them.&#x20;

{% code overflow="wrap" %}

```javascript
window.sa5.Sa5Lightbox.resetLightbox(); 
```

{% endcode %}

## Create a new Lightbox

Creating a new lightbox requires;

* Containing element. In this example, `container` references a containing element such as a DIV.&#x20;
* Thumbnail image
* Group name

Provide an image URL and a group name.&#x20;

{% code overflow="wrap" %}

```javascript
window.sa5.Sa5Lightbox.createNew(
  container, 
  `https://picsum.photos/id/238/1000/1000`, 
  "group"
  ); 
```

{% endcode %}

By default, the thumbnail image is used as the lightbox media as well.

## Future

* Wrap an existing element in a lightbox
* Add multiple media
  * Video support
* Automatic lightbox resettings
* Support for CMS captions and groups&#x20;
* Events
  * Open / close / swipe


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://attr.sygnal.com/sa5-elements/lightbox/slider-code-examples.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.