summaryrefslogtreecommitdiff
path: root/public/javascripts/shadowbox/adapters/README
diff options
context:
space:
mode:
Diffstat (limited to 'public/javascripts/shadowbox/adapters/README')
-rw-r--r--public/javascripts/shadowbox/adapters/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/public/javascripts/shadowbox/adapters/README b/public/javascripts/shadowbox/adapters/README
new file mode 100644
index 0000000..5083961
--- /dev/null
+++ b/public/javascripts/shadowbox/adapters/README
@@ -0,0 +1,11 @@
1A Shadowbox "adapter" is a small helper file that makes it easy to use
2Shadowbox with a given JavaScript framework. Since most JavaScript frameworks
3tend to contain a basic set of very similar functions (for retrieving style
4information on elements or handling events, for example) it is not necessary to
5tie Shadowbox to a particular framework. Instead, the adapter can use the
6underlying framework that is already loaded on the page to reuse some of the
7code.
8
9If you do not see an adapter for your favorite framework in this directory, feel
10free to create your own and implement the same interface as the others. It may
11then be used the same as you would use any other.