About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » architecture » lightbox
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:architecture:lightbox

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
development:architecture:lightbox [2023/06/07 11:59] – Add script controls and 204 message. emaijaladevelopment:architecture:lightbox [2023/06/07 12:19] (current) – demiankatz
Line 1: Line 1:
 ====== Lightbox ====== ====== 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 ====== ====== Controlling the Lightbox ======
Line 27: Line 27:
 **data-lightbox-onclose** - Specify a callback to be evaluated and run when the lightbox closes next. **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 ===== ===== Script Controls =====
Line 33: Line 33:
 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). 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:+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** - Run the script when the lightbox displays normal content.
Line 44: Line 44:
  
 ===== Non-forced login ===== ===== 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 request came from a form
   * the form's action matches login/create account   * the form's action matches login/create account
development/architecture/lightbox.1686139157.txt.gz · Last modified: 2023/06/07 11:59 by emaijala