Differences

This shows you the differences between two versions of the page.

--- development:architecture:lightbox [2017/01/04 18:44] – [Form Controls] demiankatz
+++ development:architecture:lightbox [2023/06/07 12:19] (current) – demiankatz
@@ Line 1: / Line 1: @@
 ====== Lightbox ======
-The new Lightbox (version 3.0, aka the Delightbox) focuses on using the same paths as VuFind would without Javascript. The general idea is that it emulates a seamless iframe with hooks and methods that allow more control. It uses ''data-'' attributes in the HTML for control.
+The new Lightbox (version 3.0, aka the Delightbox) focuses on using the same paths as VuFind® would without Javascript. The general idea is that it emulates a seamless iframe with hooks and methods that allow more control. It uses ''data-'' attributes in the HTML for control.
 ====== Controlling the Lightbox ======
@@ Line 27: / Line 27: @@
 **data-lightbox-onclose** - Specify a callback to be evaluated and run when the lightbox closes next.
-:!: Prior to VuFind 4.0, a callback could be either a function name in the global scope, or a block of Javascript code. VuFind 4.0 and later, the callback MUST be either a function name in the global scope (e.g. myFunction) or a function name within the global VuFind object (e.g. VuFind.myFunction).
+:!: Prior to VuFind® 4.0, a callback could be either a function name in the global scope, or a block of Javascript code. VuFind® 4.0 and later, the callback MUST be either a function name in the global scope (e.g. myFunction) or a function name within the global VuFind® object (e.g. VuFind®.myFunction).
+===== Script Controls =====
+By default lightbox only runs inline scripts, or no scripts at all when it finds a success message and displays only the message (see below for more information).
+Starting with VuFind® 9.1 it's possible to use the following attributes with script tags to indicate that they should be run in lightbox:
+**data-lightbox-run** - Run the script when the lightbox displays normal content.
+**data-lightbox-run="always"** - Run the script when the lightbox displays normal content or a success message.
 ====== Built-in Stops ======
@@ Line 33: / Line 44: @@
 ===== Non-forced login =====
-VuFind refreshes the page after a login to update information and present new fields. The lightbox determines if a login has occureed using the following criteria:
+VuFind® refreshes the page after a login to update information and present new fields. The lightbox determines if a login has occureed using the following criteria:
   * the request came from a form
   * the form's action matches login/create account
@@ Line 42: / Line 53: @@
 ===== A success message is reached =====
 When an .alert-success message is found, it is isolated in the lightbox, representing the end of a path. The lightbox can only be closed or escaped after this (by default).
+===== 204 Status Code =====
+If a form results in a 204 status code (No Content), it will immediately close the lightbox.
 ===== 205 Status Code =====
@@ Line 54: / Line 68: @@
 | Lightbox.addOpenAction   | $('#modal').on('shown.bs.modal', function() {}); |
 ---- struct data ----
+properties.Page Owner :
 ----