yaffs.net Git - yaffs-website/blob - web/modules/contrib/superfish/README.txt

   1 Superfish module
   2
   3 About
   4 -----
   5 This module allows for integration of jQuery Superfish plug-in with Drupal CMS.
   6
   7
   8 Requirement
   9 -----------
  10 - Superfish library.
  11   Link: https://github.com/mehrpadin/Superfish-for-Drupal/
  12
  13
  14 Installation instructions (composer)
  15 ------------------------------------
  16 1. Add the proper repository to your composer.json file
  17     {
  18       "type": "package",
  19       "package": {
  20         "name": "drupal-superfish/superfish",
  21         "version": "2.0",
  22         "type": "drupal-library",
  23         "dist": {
  24           "url": "https://github.com/mehrpadin/Superfish-for-Drupal/archive/2.x.zip",
  25           "type": "zip"
  26         }
  27       }
  28     }
  29
  30 2. Require the library
  31    $ composer require drupal-superfish/superfish:2.0
  32
  33 3. Go to "Administer" -> "Modules" and enable the module.
  34
  35 4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
  36
  37
  38 Installation instructions (manual)
  39 ----------------------------------
  40 1. Download and extract the Superfish library into the libraries directory (usually "sites/all/libraries").
  41    Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/2.x
  42
  43 2. Download and extract the Superfish module into the modules directory (usually "/modules").
  44    Link: http://drupal.org/project/superfish
  45
  46 3. Go to "Administer" -> "Modules" and enable the module.
  47
  48 4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
  49
  50
  51 How to style
  52 ------------
  53
  54 Here are some tips and tricks:
  55
  56 A) Utilise the "Default" style as reference.
  57
  58 B) Always use a DOM inspector utility (such as Firebug).
  59
  60 C) Set the "Menu delay" option in the block configuration to a very high number
  61    such as 99999999 while creating your own CSS. This will give you enough time to work with sub-menus.
  62
  63 C) If your theme supports the Superfish module, set the "Style" option in the block configuration to "None".
  64
  65
  66 Support requests
  67 ----------------
  68 You can request support here: http://drupal.org/project/issues/superfish