From 60d6c5f3e46b887806e252d5dea1f04715a81e0d Mon Sep 17 00:00:00 2001 From: Victor Häggqvist Date: Sat, 16 Jan 2016 22:00:36 +0100 Subject: write some docs and fixup demo --- docs/hacking.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/hacking.rst (limited to 'docs/hacking.rst') diff --git a/docs/hacking.rst b/docs/hacking.rst new file mode 100644 index 0000000..14d3810 --- /dev/null +++ b/docs/hacking.rst @@ -0,0 +1,20 @@ +Hacking +======= +A plugin are expected to implement a function :code:`register(lightbox)` which will be called when passed the plugin to `LightBox.Core::registerPlugin`. See the full API at :doc:`api`. + +A basic plugin could look like this. + +.. code-block:: js + :caption: LightBox.Contrib.MyExitPlugin.js + + class MyExitPlugin { + + register(lightbox) { + lightbox.addOnEndListener(this.exited.bind(this)); + } + + exited() { + console.log('lightbox exited'); + } + + } -- cgit v1.2.3