X-Git-Url: https://yaffs.net/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fslick%2Fslick_ui%2FREADME.html;h=9ffba101498906ec61250f661fc74a64f903449b;hb=eba34333e3c89f208d2f72fa91351ad019a71583;hp=5adfaed1a94573b66d8ab60ac96ad968b235f5ff;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website diff --git a/web/modules/contrib/slick/slick_ui/README.html b/web/modules/contrib/slick/slick_ui/README.html index 5adfaed1a..9ffba1014 100644 --- a/web/modules/contrib/slick/slick_ui/README.html +++ b/web/modules/contrib/slick/slick_ui/README.html @@ -4,64 +4,58 @@ Wheeler's Slick carousel.
See http://kenwheeler.github.io/slick

-

Powerful: Slick is one of the sliders [1], as of 9/15, the only one [2], which
-supports nested sliders and a mix of lazy-loaded image/video with
-image-to-iframe or multimedia lightbox switchers.
-See below for the supported media.

- -

Performant: Slick is stored as plain HTML the first time it is requested, and
-then reused on subsequent requests. Carousels with cacheability and lazyload
-are lighter and faster than those without.

-

Slick has gazillion options, please start with the very basic working
-samples from slick_example [3] only if trouble to build slicks. Be sure to read
+samples from slick_example only if trouble to build slicks. Be sure to read
its README.txt. Spending 5 minutes or so will save you hours in building more
complex slideshows.

The module supports Slick 1.6 above.
Slick 2.x is just out 9/21/15, and hasn't been officially supported now, 9/27.

-

[1] https://groups.drupal.org/node/20384
-[2] https://www.drupal.org/node/418616
-[3] http://dgo.to/slick_extras

-

REQUIREMENTS

-

  Important! Be sure to enable Blazy first before updating Slick Alphas,
+

  Important! Enable Blazy first before updating Slick Alphas,
  otherwise a requirement error.

FEATURES

INSTALLATION

@@ -72,12 +66,12 @@ http://drupal.org/documentation/install/modules-themes/modules-7

The Slick module has several sub-modules:

OPTIONAL INTEGRATION

@@ -85,14 +79,14 @@ http://drupal.org/documentation/install/modules-themes/modules-7

Slick supports enhancements and more complex layouts.

 

@@ -103,7 +97,7 @@ http://drupal.org/documentation/install/modules-themes/modules-7

  admin/config/media/slick

-

Be sure to enable Slick UI sub-module first, otherwise regular "Access denied".
+

Enable Slick UI sub-module first, otherwise regular "Access denied".
They will be available at field formatter "Manage display", and Views UI.

VIEWS AND FIELDS

@@ -186,7 +180,7 @@ It is not the module job to match your awesome design requirements.

If you want to attach extra 3rd libraries, e.g.: image reflection, image zoomer,
more advanced 3d carousels, etc, simply put them into js array of the target
-skin. Be sure to add proper weight, if you are acting on existing slick events,
+skin. Add proper weight, if you are acting on existing slick events,
normally < 0 (slick.load.min.js) is the one.

Use hook_slick_skins_info() and implement \Drupal\slick\SlickSkinInterface
@@ -202,20 +196,20 @@ Some extra skins are WIP which may not work as expected.

To create Slick grid or multiple rows carousel, there are 3 options:

-

1. One row grid managed by library:
-   Visit admin/config/media/slick,
-   Edit current optionset, and set
-   slidesToShow > 1, and Rows and slidesperRow = 1

- -

2. Multiple rows grid managed by library:
-   Visit admin/config/media/slick,
-   Edit current optionset, and set
-   slidesToShow = 1, Rows > 1 and slidesPerRow > 1

- -

3. Multiple rows grid managed by Module:
-   Visit admin/structure/views/view/slick_x/edit/block_grid from slick_example,
-   Be sure to install the Slick example sub-module first.
-   Requires skin "Grid", and slidesToShow, Rows and slidesPerRow = 1.

+
    +
  1. One row grid managed by library:
    + Visit admin/config/media/slick
    + Edit current optionset, and set
    + slidesToShow > 1, and Rows and slidesperRow = 1
    2. +
  2. Multiple rows grid managed by library:
    + Visit admin/config/media/slick
    + Edit current optionset, and set
    + slidesToShow = 1, Rows > 1 and slidesPerRow > 1
    3. +
  3. Multiple rows grid managed by Module:
    + Visit admin/structure/views/view/slick_x/edit/block_grid from slick_example
    + Install the Slick example sub-module first.
    + Requires skin "Grid", and slidesToShow, Rows and slidesPerRow = 1.
    4. +

The first 2 are supported by core library using pure JS approach.
The last is the Module feature using pure CSS Foundation block-grid.

@@ -228,13 +222,14 @@ broken Grid, see skin Grid above for more details.

Note, non-BEM classes are added by JS.

-

<div class="slick">
+ +<div class="slick">
  <div class="slick__slider slick-initialized slick-slider">
    <div class="slick__slide"></div>
  </div>
  <nav class="slick__arrow"></nav>
-</div>

- +</div> +

asNavFor should target slick-initialized class/ID attributes.

BUG REPORTS OR SUPPORT REQUESTS

@@ -242,25 +237,21 @@ broken Grid, see skin Grid above for more details.

A basic knowledge of Drupal site building is required. If you get stuck:

-

 

-

If you do have bug reports, we love bugs, please:

-

 

-

For the Slick library bug, please report it to the actual library:
  https://github.com/kenwheeler/slick

@@ -272,62 +263,65 @@ Shortly, you should kindly help the maintainers with detailed info to help you.< Thanks.

TROUBLESHOOTING

- -

- When upgrading from Slick v1.3.6 to later version, try to resave options at:
-  o admin/config/media/slick
-  o admin/structure/types/manage/CONTENT_TYPE/display
-  o admin/structure/views/view/VIEW_NAME
-  only if trouble to see the new options, or when options don't apply properly.
-  Most likely true when the library adds/changes options, or the module
-  does something new. This is normal for any library even commercial ones, so
-  bear with it.

- -

- Always clear the cache, and re-generate JS (if aggregation is on) when
-  updating the module to ensure things are picked up:
-  o admin/config/development/performance

- -

- If you are customizing template files, or theme functions, be sure to re-check
-  against the latest.

- -

- Be sure Slick release is similar, or later than Blazy.

+

KNOWN ISSUES

-

- Slick admin CSS may not be compatible with private or contrib admin
-  themes. Only if trouble with admin display, please disable it at:
-  admin/config/media/blazy

- -

- The Slick lazyLoad is not supported with Responsive image. Slick only
-  facilitates Responsive image to get in. The image formatting is taken over by
-  Responsive image.
-  Some other options such as Aspect ratio is currently not supported either.

- -

- Photobox is best for:
-  - infinite true + slidesToShow 1
-  - infinite false + slidesToShow N
-  If "infinite true + slidesToShow > 1" is a must, but you don't want dup
-  thumbnails, simply override the JS to disable 'thumbs' option.

- -

- The following is not module related, but worth a note:
-  o lazyLoad ondemand has issue with dummy image excessive height.
-    Added fixes to suppress it via option Aspect ratio (fluid | enforced).
-    Or use Blazy lazyload for more advanced options.
-  o Aspect ratio is not compatible with Responsive image or multi-serving
-    images.
-    However if you can stick to one Aspect ratio, choose 'enforced' instead.
-    Otherwise disable Aspect ratio for multi-serving images.
-  o If the total < slidesToShow, Slick behaves. Previously added a workaround to
-    fix this, but later dropped and handed over to the core instead.
-    Brought back the temp fix for 1.6+ as per 10/18/16:
-    See https://github.com/kenwheeler/slick/issues/262
-  o Fade option with slideToShow > 1 will screw up.
-  o variableWidth ignores slidesToShow.
-  o Too much centerPadding at small device affects slidesToShow.
-  o Infinite option will create duplicates or clone slides which look more
-    obvious if slidesToShow > 1. Simply disable it if not desired.
-  o If thumbnail display is Infinite, the main one must be infinite too, else
-    incorrect syncing.
-  o adaptiveHeight is no good for vertical.

+

CURRENT DEVELOPMENT STATUS

@@ -337,12 +331,14 @@ some code cleanup, and optimization where needed. Patches are very much welcome.

Alpha and Beta releases are for developers only. Be aware of possible breakage.

However if it is broken, unless an update is explicitly required, clearing cache
-should fix most issues during DEV phases. Prior to any update, always visit:
-/admin/config/development/performance

- -

And hit "Clear all caches" button once the new Slick is in place. Regenerate CSS
-and JS as the latest fixes may contain changes to the assets.
-Have the latest or similar release Blazy to avoid trouble in the first place.

+should fix most issues during DEV phases.

+

ROADMAP

@@ -354,6 +350,22 @@ Have the latest or similar release Blazy to avoid trouble in the first place.

If you find this module helpful, please help back spread the love. Thanks.

+

QUICK PERFORMANCE TIPS

+ +

AUTHOR/MAINTAINER/CREDITS

Slick 8.x-1.x by gausarts, and other authors below.