You are here

Home » API reference » Slick Views 7.2

README.txt in Slick Views 7.2

Same filename and directory in other branches
  1. 8 README.txt
Slick Views Module
================================================================================

This adds a new display style to views called "Slick carousel". Similar to how
you select "HTML List" or "Unformatted List" as display styles.

This module doesn't require Views UI to be enabled but it is required if you
want to configure your Views display using Slick carousel through the web
interface. This ensures you can leave Views UI off once everything is setup.


DEPENDENCIES:
--------------------------------------------------------------------------------
o Views [1]
o Slick 2.x above. [2]

Be sure to install the Slick example[3] to avoid adventures in the first place.

[1] http://dgo.to/views
[2] http://dgo.to/slick
[3] http://dgo.to/slick_extras

OPTIONSETS:
--------------------------------------------------------------------------------

Arm yourself with proper optionsets. To create one, go to:

"admin/config/media/slick"

Be sure to install the Slick UI module first, included in the main Slick module,
otherwise no such URL, and regular access denied error.


USAGE:
--------------------------------------------------------------------------------
Go to Views UI "admin/structure/views", add a new view, and a block.

Usage #1
--------
Displaying multiple (rendered) entities for the slides.
- Choose "Slick carousel" under the Format.
- Choose available optionsets you have created at "admin/config/media/slick"
- Choose "Rendered entity" or "Content" under "Show" under "Format", and its
  View mode.

Themeing is related to their own entity display outside the Views UI.

Example use case:
- Blogs, teams, testimonials, case studies sliders, etc.

Usage #2
--------
Displaying multiple entities using selective fields for the slides.
- Choose "Slick carousel" under the Format.
- Choose available optionsets you have created at "admin/config/media/slick"
- Choose "Fields" under "Show" under "Format".
- Add fields, and do custom works or markups. If having a multi-value Image
  field, recommended to only display 1.

Themeing is all yours inside the Views UI.

Example use case:
- similar as above.

Usage #3
--------
Displaying a single multiple-value field in a single entity display for the
slides. Use it either with contextual filter by NID, or filter criteria by NID.
- Under Pager", choose "Display a specified number of items" with "1 item".
- Choose "Unformatted list" under the Format, not "Slick carousel".
- Add a multi-value Image, Media or Field collection field.
- Click the field under the Fields, choose "Slick carousel" under Formatter.
- Adjust the settings.
- Be sure to Display "all" or any number > 1 under "Multiple Field settings".
- Check "Use field template" under "Style settings", otherwise no field visible.

Themeing is mostly taken care of by slick_fields.module in terms of layout, with
the goodness of Views to provide better markups manually.

Example use case:
- front or inner individual slideshow based on the entity ID, or individual user
  slideshow.


Usage #4
--------
A combination of (#1 or #2) and #3 to build nested slicks.

Example use case:
- A home slideshow containing multiple videos per slide for quick overview.
- A large product/ portfolio slideshow containing a grid of slides.
- A news slideshow containing latest related news items per slide.


GOTCHAS:
--------------------------------------------------------------------------------
If you are choosing a single multi-value field (such as images, Media files, or
Field collection fields) rather displaying various fields from multiple nodes,
make sure to:
- Choose an "Unformatted list" Format, not "Slick carousel".
- Choose "Slick carousel" for the actual field when configuring the field.
- Check "Use field template" under "Style Settings"so that the Slick field
  themeing is picked-up.

More info relevant to each option is available at their form display by hovering
over them, and click a dark question mark.


AUTHOR/MAINTAINER/CREDITS
--------------------------------------------------------------------------------
Gaus Surahman
https://drupal.org/user/159062

With the help from the community:
- https://www.drupal.org/node/2232779/committers
- https://www.drupal.org/node/2497045/committers
- CHANGELOG.txt for helpful souls with their patches, suggestions and reports.

READ MORE
--------------------------------------------------------------------------------
See the project page on drupal.org: http://drupal.org/project/slick.

More info relevant to each option is available at their form display by hovering
over them, and click a dark question mark.

See the Slick docs at:
- http://kenwheeler.github.io/slick/
- https://github.com/kenwheeler/slick/

File

README.txt
View source 
  1. Slick Views Module

  2. ================================================================================

  3. 

  4. This adds a new display style to views called "Slick carousel". Similar to how

  5. you select "HTML List" or "Unformatted List" as display styles.

  6. 

  7. This module doesn't require Views UI to be enabled but it is required if you

  8. want to configure your Views display using Slick carousel through the web

  9. interface. This ensures you can leave Views UI off once everything is setup.

  10. 

  11. 

  12. DEPENDENCIES:

  13. --------------------------------------------------------------------------------

  14. o Views [1]

  15. o Slick 2.x above. [2]

  16. 

  17. Be sure to install the Slick example[3] to avoid adventures in the first place.

  18. 

  19. [1] http://dgo.to/views

  20. [2] http://dgo.to/slick

  21. [3] http://dgo.to/slick_extras

  22. 

  23. OPTIONSETS:

  24. --------------------------------------------------------------------------------

  25. 

  26. Arm yourself with proper optionsets. To create one, go to:

  27. 

  28. "admin/config/media/slick"

  29. 

  30. Be sure to install the Slick UI module first, included in the main Slick module,

  31. otherwise no such URL, and regular access denied error.

  32. 

  33. 

  34. USAGE:

  35. --------------------------------------------------------------------------------

  36. Go to Views UI "admin/structure/views", add a new view, and a block.

  37. 

  38. Usage #1

  39. --------

  40. Displaying multiple (rendered) entities for the slides.

  41. - Choose "Slick carousel" under the Format.

  42. - Choose available optionsets you have created at "admin/config/media/slick"

  43. - Choose "Rendered entity" or "Content" under "Show" under "Format", and its

  44.   View mode.

  45. 

  46. Themeing is related to their own entity display outside the Views UI.

  47. 

  48. Example use case:

  49. - Blogs, teams, testimonials, case studies sliders, etc.

  50. 

  51. Usage #2

  52. --------

  53. Displaying multiple entities using selective fields for the slides.

  54. - Choose "Slick carousel" under the Format.

  55. - Choose available optionsets you have created at "admin/config/media/slick"

  56. - Choose "Fields" under "Show" under "Format".

  57. - Add fields, and do custom works or markups. If having a multi-value Image

  58.   field, recommended to only display 1.

  59. 

  60. Themeing is all yours inside the Views UI.

  61. 

  62. Example use case:

  63. - similar as above.

  64. 

  65. Usage #3

  66. --------

  67. Displaying a single multiple-value field in a single entity display for the

  68. slides. Use it either with contextual filter by NID, or filter criteria by NID.

  69. - Under Pager", choose "Display a specified number of items" with "1 item".

  70. - Choose "Unformatted list" under the Format, not "Slick carousel".

  71. - Add a multi-value Image, Media or Field collection field.

  72. - Click the field under the Fields, choose "Slick carousel" under Formatter.

  73. - Adjust the settings.

  74. - Be sure to Display "all" or any number > 1 under "Multiple Field settings".

  75. - Check "Use field template" under "Style settings", otherwise no field visible.

  76. 

  77. Themeing is mostly taken care of by slick_fields.module in terms of layout, with

  78. the goodness of Views to provide better markups manually.

  79. 

  80. Example use case:

  81. - front or inner individual slideshow based on the entity ID, or individual user

  82.   slideshow.

  83. 

  84. 

  85. Usage #4

  86. --------

  87. A combination of (#1 or #2) and #3 to build nested slicks.

  88. 

  89. Example use case:

  90. - A home slideshow containing multiple videos per slide for quick overview.

  91. - A large product/ portfolio slideshow containing a grid of slides.

  92. - A news slideshow containing latest related news items per slide.

  93. 

  94. 

  95. GOTCHAS:

  96. --------------------------------------------------------------------------------

  97. If you are choosing a single multi-value field (such as images, Media files, or

  98. Field collection fields) rather displaying various fields from multiple nodes,

  99. make sure to:

  100. - Choose an "Unformatted list" Format, not "Slick carousel".

  101. - Choose "Slick carousel" for the actual field when configuring the field.

  102. - Check "Use field template" under "Style Settings"so that the Slick field

  103.   themeing is picked-up.

  104. 

  105. More info relevant to each option is available at their form display by hovering

  106. over them, and click a dark question mark.

  107. 

  108. 

  109. AUTHOR/MAINTAINER/CREDITS

  110. --------------------------------------------------------------------------------

  111. Gaus Surahman

  112. https://drupal.org/user/159062

  113. 

  114. With the help from the community:

  115. - https://www.drupal.org/node/2232779/committers

  116. - https://www.drupal.org/node/2497045/committers

  117. - CHANGELOG.txt for helpful souls with their patches, suggestions and reports.

  118. 

  119. READ MORE

  120. --------------------------------------------------------------------------------

  121. See the project page on drupal.org: http://drupal.org/project/slick.

  122. 

  123. More info relevant to each option is available at their form display by hovering

  124. over them, and click a dark question mark.

  125. 

  126. See the Slick docs at:

  127. - http://kenwheeler.github.io/slick/

  128. - https://github.com/kenwheeler/slick/