annotate sites/all/modules/flexslider/flexslider.api.php @ 2:b74b41bb73f0

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