diff options
author | Victor Häggqvist <[email protected]> | 2016-01-16 22:00:36 +0100 |
---|---|---|
committer | Victor Häggqvist <[email protected]> | 2016-01-16 22:00:36 +0100 |
commit | 60d6c5f3e46b887806e252d5dea1f04715a81e0d (patch) | |
tree | ec87e4bd38fd6e59a26e24bfd57145a4f77e5147 /docs/api.rst | |
parent | 47b575b89249f34a364b516161cbe1e33df0f3a4 (diff) |
write some docs and fixup demo
Diffstat (limited to '')
-rw-r--r-- | docs/api.rst | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..a57f144 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,50 @@ +Core API +======== + +A `LightBox.Core` object have the following public API that can be considered stable. I you are creating a plugin you might want to check :doc:`hacking`. + + +**quitLightbox()** +Exit and remove the lightbox + + +**switchToIndex(** index **)** +Switch to image *index* in targets array + +index + **int** + + +**addOnStartListener(** listener **)** +Add a OnStartListener + +listener + **function** + + +**addOnEndListener(** listener **)** +Add a OnEndListener + +listener + **function** + + +**addOnLoadStartListener(** listener **)** +Add a OnLoadStartListener + +listener + **function** + + +**addOnLoadEndListener(** listener **)** +Add a OnLoadEndListener + +listener + **function** + + +**registerPlugin(** plugin **)** +Register a plugin + +plugin + **Object** |