summaryrefslogtreecommitdiff
path: root/public/javascripts/shadowbox/players/README
diff options
context:
space:
mode:
authorerdgeist <erdgeist@erdgeist.org>2026-06-30 17:11:32 +0200
committererdgeist <erdgeist@erdgeist.org>2026-06-30 17:29:12 +0200
commit3e87925a35f73aa2261eb66df3ef4ca11b64eeea (patch)
tree8a9a6da1f99b4480e07548ffaf5d5b4945603ba9 /public/javascripts/shadowbox/players/README
parentb97466cdfbcb5b02d4eaf38661c051d1a095838e (diff)
Replace Shadowbox with GLightbox, drop jQuery from public site
Vendors GLightbox 3.3.1 (MIT, dependency-free) as static files in public/javascripts and public/stylesheets, replacing the Shadowbox 2009 vendor tree and its jQuery adapter. Public site no longer loads jQuery at all. - app/views/layouts/application.html.erb: swap Shadowbox script/style includes and the public_bundle (jQuery) include for GLightbox's CSS/JS - app/views/content/_headline_image.html.erb: headline image is now itself a GLightbox trigger; additional images are direct a.glightbox links sharing a per-page data-gallery group, replacing the hidden shadowbox_images div and its click-forwarding trigger - public/javascripts/public.js: replace Shadowbox.init/setup and the click-forwarding handler with a single GLightbox() init call; remove the unused image_handler object - Remove public/javascripts/shadowbox/ (including vendored Sizzle, swfobject, and unused video/Flash players) and public/stylesheets/shadowbox.css - Remove app/assets/javascripts/public_bundle.js (jquery require)
Diffstat (limited to 'public/javascripts/shadowbox/players/README')
-rw-r--r--public/javascripts/shadowbox/players/README35
1 files changed, 0 insertions, 35 deletions
diff --git a/public/javascripts/shadowbox/players/README b/public/javascripts/shadowbox/players/README
deleted file mode 100644
index 7f32991..0000000
--- a/public/javascripts/shadowbox/players/README
+++ /dev/null
@@ -1,35 +0,0 @@
1A Shadowbox "player" is a class that is used specifically for displaying a
2particular medium. For example, an image player is included for displaying
3images, a QuickTime player is included for playing QuickTime movies, etc.
4
5All players should implement the same interface. This makes it possible for the
6Shadowbox class to know what methods to call and properties to check on player
7objects.
8
9The interface is described here, with some simple explanations of how each
10method and/or property is to be used.
11
12METHOD/PROPERTY DESCRIPTION
13
14height (Number) The height of the object (in pixels)
15width (Number) The width of the object (in pixels)
16ready (optional, Boolean) True if the content is ready to be
17 loaded, false otherwise. Useful when the script should wait
18 until the content loads before proceeding (see below)
19resizable (optional, Boolean) True if the content can be dynamically
20 resized by the script (e.g. images, but not most movie
21 formats)
22append() Appends this object to the DOM
23remove() Removes this object from the DOM
24onLoad() (optional) Called after the content is loaded and the
25 loading layer is hidden
26onWindowResize() (optional) Called when the window is resized
27
28If the ready property is set to false, the script will wait until it is set true
29before proceeding to call the onReady callback. This property should be changed
30in some callback function within the player class itself.
31
32In this case, the object's height and width do not need to be made available
33immediately (because they may not initially be known). However, in the same
34callback, the height and width should be set. See the Shadowbox.img class (in
35shadowbox-img.js) for an example of this behavior.