You are here

Home » API reference » Flex Slider 7

README.txt in Flex Slider 7

Same filename in this branch
  1. 7 README.txt
  2. 7 flexslider_views_slideshow/README.txt
  3. 7 flexslider_fields/README.txt
  4. 7 flexslider_views/README.txt
About
=====
Integrates the FlexSlider library into Drupal.

Current Options
---------------
Allows you to use FlexSlider in a few different ways


- As a library to be used with any other theme or module by calling flexslider_add() (N.B. You may also use drupal_add_library('flexslider', 'flexslider') however this is not recommended)
- Integrates with Views Slideshow with FlexSlider Views submodule (80% feature complete) (flexslider_views_slideshow)
- Integrates with Fields (flexslider_fields)
- Adds a Views display mode (flexslider_views)

Future Plans
------------

- Add support for Views jQFX

About FlexSlider
----------------

Library available at https://github.com/woothemes/FlexSlider

- Simple, semantic markup
- Supported in all major browsers
- Horizontal/vertical slide and fade animations
- Multiple slider support, Callback API, and more
- Hardware accelerated touch swipe support
- Custom navigation options
- Use any html elements in the slides
- Built for beginners and pros, alike
- Free to use under the MIT license


Installation
============

1. Download the FlexSlider library from https://github.com/woothemes/FlexSlider/zipball/flexslider1 (This is the 1.x version of FlexSlider)
**N.B. Ensure you're using the 1.x version of FlexSlider. At the time of writing, the latest 1.x version is 1.8**
2. Unzip the file and rename the folder to "flexslider" (pay attention to the case of the letters)
3. Put the folder in a libraries directory
    - Ex: sites/all/libraries
4. The first two files are required and the last is optional (required for javascript debugging)
    - jquery.flexslider-min.js
    - flexslider.css
    - jquery.flexslider.js
4. Ensure you have a valid path similar to this one for all files
    - Ex: sites/all/libraries/flexslider/jquery.flexslider-min.js

That's it!

Usage
======

No matter how you want to use Flex Slider (with fields, views or views slideshow) you need to define "option sets" to tell Flex Slider how you want it to display. 

Go to admin/config/media/flexslider

From there you can edit the default option set and define new ones. These will be listed as options in the various forms where you setup Flex Slider to display.

Debugging
---------

You can toggle the development version of the library in the administrative settings page. This will load the unminified version of the library.

Export API
==========

You can export your Flex Slider option presets using CTools exportables. So either using the Bulk Export module or Features.

File

README.txt
View source 
  1. About

  2. =====

  3. Integrates the FlexSlider library into Drupal.

  4. 

  5. Current Options

  6. ---------------

  7. Allows you to use FlexSlider in a few different ways

  8. 

  9. 

  10. - As a library to be used with any other theme or module by calling flexslider_add() (N.B. You may also use drupal_add_library('flexslider', 'flexslider') however this is not recommended)

  11. - Integrates with Views Slideshow with FlexSlider Views submodule (80% feature complete) (flexslider_views_slideshow)

  12. - Integrates with Fields (flexslider_fields)

  13. - Adds a Views display mode (flexslider_views)

  14. 

  15. Future Plans

  16. ------------

  17. 

  18. - Add support for Views jQFX

  19. 

  20. About FlexSlider

  21. ----------------

  22. 

  23. Library available at https://github.com/woothemes/FlexSlider

  24. 

  25. - Simple, semantic markup

  26. - Supported in all major browsers

  27. - Horizontal/vertical slide and fade animations

  28. - Multiple slider support, Callback API, and more

  29. - Hardware accelerated touch swipe support

  30. - Custom navigation options

  31. - Use any html elements in the slides

  32. - Built for beginners and pros, alike

  33. - Free to use under the MIT license

  34. 

  35. 

  36. Installation

  37. ============

  38. 

  39. 1. Download the FlexSlider library from https://github.com/woothemes/FlexSlider/zipball/flexslider1 (This is the 1.x version of FlexSlider)

  40. **N.B. Ensure you're using the 1.x version of FlexSlider. At the time of writing, the latest 1.x version is 1.8**

  41. 2. Unzip the file and rename the folder to "flexslider" (pay attention to the case of the letters)

  42. 3. Put the folder in a libraries directory

  43.     - Ex: sites/all/libraries

  44. 4. The first two files are required and the last is optional (required for javascript debugging)

  45.     - jquery.flexslider-min.js

  46.     - flexslider.css

  47.     - jquery.flexslider.js

  48. 4. Ensure you have a valid path similar to this one for all files

  49.     - Ex: sites/all/libraries/flexslider/jquery.flexslider-min.js

  50. 

  51. That's it!

  52. 

  53. Usage

  54. ======

  55. 

  56. No matter how you want to use Flex Slider (with fields, views or views slideshow) you need to define "option sets" to tell Flex Slider how you want it to display. 

  57. 

  58. Go to admin/config/media/flexslider

  59. 

  60. From there you can edit the default option set and define new ones. These will be listed as options in the various forms where you setup Flex Slider to display.

  61. 

  62. Debugging

  63. ---------

  64. 

  65. You can toggle the development version of the library in the administrative settings page. This will load the unminified version of the library.

  66. 

  67. Export API

  68. ==========

  69. 

  70. You can export your Flex Slider option presets using CTools exportables. So either using the Bulk Export module or Features.