Skip to content

Commit

Permalink
static methods docs
Browse files Browse the repository at this point in the history
  • Loading branch information
makryl committed May 16, 2014
1 parent 2a66f69 commit aa494eb
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,27 @@ If you want different link for plugin's big image and for non-javascript clients

Also, you can use `data-href` attribute on any element, not only links.

### Static methods

/* open image by URL */
$.abigimage.open('/some_image.jpg');

/* open image by index in current list */
$.abigimage.open(5);

/* open image by URL at specified position in current list */
$.abigimage.open('/some_image.jpg', 5);

/* open next image */
$.abigimage.next();

/* open previous image */
$.abigimage.prev();

/* close image */
$.abigimage.close();


## License

Copyright © 2014 Maksim Krylosov <[email protected]>
Expand Down
21 changes: 21 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,27 @@ <h3>Using data-href attribute</h3>

<p>Also, you can use <code>data-href</code> attribute on any element, not only links.</p>

<h3>Static methods</h3>

<pre><code>/* open image by URL */
$.abigimage.open('/some_image.jpg');

/* open image by index in current list */
$.abigimage.open(5);

/* open image by URL at specified position in current list */
$.abigimage.open('/some_image.jpg', 5);

/* open next image */
$.abigimage.next();

/* open previous image */
$.abigimage.prev();

/* close image */
$.abigimage.close();
</code></pre>



<h3>P. S.</h3>
Expand Down

0 comments on commit aa494eb

Please sign in to comment.