diff options
Diffstat (limited to '')
-rw-r--r-- | docs/hacking.rst | 20 |
1 files changed, 20 insertions, 0 deletions
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'); + } + + } |