You are here

Home » API reference » Field Slideshow 8.3

README.txt in Field Slideshow 8.3

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
--- README  -------------------------------------------------------------

Field Slideshow

Provides a Slideshow format for displaying Image fields,
using the JQuery Cycle 2 plugin.

Compared to Views slideshows, building the slideshow from multiple nodes,
this module builds it from a single node, if you're using a multi-valued
Image field.

--- INSTALLATION --------------------------------------------------------

1 - use composer require 'drupal/field_slideshow:^3.x'
2 - Download the JQuery Cycle 2 plugin here :
    https://github.com/zakgreene/cycle2/
    (It is fork from original Cycle2 repo
    which support the latest jQuery version)
    (don't choose the Lite version), and move the downloaded
    jquery.cycle2.min.js file into /libraries/jquery.cycle2/
3 - Optionally download swipe plugin from
    http://malsup.github.io/min/jquery.cycle2.swipe.min.js
4 - Install Drupal Colorbox module if you want to use colorbox modal.

--- USAGE ---------------------------------------------------------------

1 - Enable Field Slideshow at /admin/modules.
2 - Create or edit a content type at /admin/structure/types and
    include an Image field.
3 - Edit this image field, so that multiple image files may be added
    ("Number of values" setting at admin/structure/types/manage/
    {content type}/fields/{field_image}).
4 - Go to "Manage display" for your content type
    (/admin/structure/types/manage/{content type}/display) and
    switch the format of your multiple image field from Image to Slideshow.
5 - Click the settings wheel in the slideshow-formatted multiple
    image field to edit advanced settings.
6 - Save! and here you go.

File

README.txt
View source 
  1. --- README  -------------------------------------------------------------

  2. 

  3. Field Slideshow

  4. 

  5. Provides a Slideshow format for displaying Image fields,

  6. using the JQuery Cycle 2 plugin.

  7. 

  8. Compared to Views slideshows, building the slideshow from multiple nodes,

  9. this module builds it from a single node, if you're using a multi-valued

  10. Image field.

  11. 

  12. --- INSTALLATION --------------------------------------------------------

  13. 

  14. 1 - use composer require 'drupal/field_slideshow:^3.x'

  15. 2 - Download the JQuery Cycle 2 plugin here :

  16.     https://github.com/zakgreene/cycle2/

  17.     (It is fork from original Cycle2 repo

  18.     which support the latest jQuery version)

  19.     (don't choose the Lite version), and move the downloaded

  20.     jquery.cycle2.min.js file into /libraries/jquery.cycle2/

  21. 3 - Optionally download swipe plugin from

  22.     http://malsup.github.io/min/jquery.cycle2.swipe.min.js

  23. 4 - Install Drupal Colorbox module if you want to use colorbox modal.

  24. 

  25. --- USAGE ---------------------------------------------------------------

  26. 

  27. 1 - Enable Field Slideshow at /admin/modules.

  28. 2 - Create or edit a content type at /admin/structure/types and

  29.     include an Image field.

  30. 3 - Edit this image field, so that multiple image files may be added

  31.     ("Number of values" setting at admin/structure/types/manage/

  32.     {content type}/fields/{field_image}).

  33. 4 - Go to "Manage display" for your content type

  34.     (/admin/structure/types/manage/{content type}/display) and

  35.     switch the format of your multiple image field from Image to Slideshow.

  36. 5 - Click the settings wheel in the slideshow-formatted multiple

  37.     image field to edit advanced settings.

  38. 6 - Save! and here you go.