root / drupal7 / sites / all / modules / flexslider / flexslider.api.php @ 87dbc3bf
| 1 |
<?php
|
|---|---|
| 2 |
|
| 3 |
/**
|
| 4 |
* @file
|
| 5 |
* API documentation for FlexSlider
|
| 6 |
*/
|
| 7 |
|
| 8 |
/**
|
| 9 |
* By design, FlexSlider should be entirely configurable from the web interface.
|
| 10 |
* However some implementations may require to access the FlexSlider library
|
| 11 |
* directly by using flexslider_add().
|
| 12 |
*
|
| 13 |
* Here are some sample uses of flexslider_add().
|
| 14 |
*/
|
| 15 |
|
| 16 |
/**
|
| 17 |
* This call will look for an HTML element with and id attribute of "my_image_list"
|
| 18 |
* and initialize FlexSlider on it using the option set named "default".
|
| 19 |
*/
|
| 20 |
flexslider_add('my_image_list', 'default'); |
| 21 |
|
| 22 |
/**
|
| 23 |
* You also have the option of skipping the option set parameter if you want
|
| 24 |
* to run with the library defaults or plan on adding the settings array
|
| 25 |
* into the page manually using drupal_add_js().
|
| 26 |
*/
|
| 27 |
flexslider_add('my_image_list');
|
| 28 |
|
| 29 |
/**
|
| 30 |
* Finally, you can simply have Drupal include the library in the list of
|
| 31 |
* javascript libraries. This method would assume you would take care of
|
| 32 |
* initializing a FlexSlider instance in your theme or custom javascript
|
| 33 |
* file.
|
| 34 |
*
|
| 35 |
* Ex: $('#slider').flexslider();
|
| 36 |
*/
|
| 37 |
flexslider_add(); |