www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/slick/src/SlickSkinInterface.php

   1 <?php
   2
   3 namespace Drupal\slick;
   4
   5 /**
   6  * Provides an interface defining Slick skins.
   7  *
   8  * The hook_hook_info() is deprecated, and no resolution by 1/16/16:
   9  *   #2233261: Deprecate hook_hook_info()
  10  *     Postponed till D9
  11  *
  12  * @see slick.api.php for more supported methods.
  13  */
  14 interface SlickSkinInterface {
  15
  16   /**
  17    * Returns the Slick skins.
  18    *
  19    * This can be used to register skins for the Slick. Skins will be
  20    * available when configuring the Optionset, Field formatter, or Views style,
  21    * or custom coded slicks.
  22    *
  23    * Slick skins get a unique CSS class to use for styling, e.g.:
  24    * If your skin name is "my_module_slick_carousel_rounded", the CSS class is:
  25    * slick--skin--my-module-slick-carousel-rounded
  26    *
  27    * A skin can specify CSS and JS files to include when Slick is displayed,
  28    * except for a thumbnail skin which accepts CSS only.
  29    *
  30    * Each skin supports 5 keys:
  31    * - name: The human readable name of the skin.
  32    * - description: The description about the skin, for help and manage pages.
  33    * - css: An array of CSS files to attach.
  34    * - js: An array of JS files to attach, e.g.: image zoomer, reflection, etc.
  35    * - group: A string grouping the current skin: main, thumbnail.
  36    * - provider: A module name registering the skins.
  37    *
  38    * @return array
  39    *   The array of the main and thumbnail skins.
  40    */
  41   public function skins();
  42
  43 }