You are here

Home » API reference » Superfish 8

README.txt in Superfish 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

This module allows for integration of jQuery Superfish plug-in with Drupal CMS.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/superfish

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/superfish


REQUIREMENTS
------------

This module requires the following outside of Drupal core:

 * Superfish library - https://github.com/mehrpadin/Superfish-for-Drupal/


RECOMMENDED MODULES
-------------------

 * Libraries API - https://www.drupal.org/project/libraries
 * jQuery Easing plugin - https://www.drupal.org/project/jqeasing


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

 * Install the Superfish module as you would normally install a contributed
   Drupal module. Visit
   https://www.drupal.org/node/1897420 for further information.


CONFIGURATION
-------------

    1. Navigate to Administration > Extend and enable the module.
    2. Go to Administation > Structure > Block layout > select a Place block
       button to add a Superfish block to a region.
    3. Use the "Configure" link of the block to configure it accordingly to your
       needs.

How to style:
    1. In the block configuration page, set the Style to None
    2. Copy one of the Superfish sample styles, for example default.css from
       sites/all/libraries/superfish/style to your theme; either as a separate
       CSS file or part of the main CSS file of your theme.
    3. Rename the selectors .sf-style-default to .sf-style-none or remove
       them altogether.
    4. You are now ready to unleash your CSS artistry :)

Some design tips:
 * Utilize a DOM inspector (such as Firefox Developer Tools) for temporarily
   modifying live code in real time.
 * Set the Mouse delay of the block settings to 99999999 so the sub-menus will
   stay open for a longer time giving you more time to work with them in the
   DOM inspector etc.
   Useful links:
	 https://docs.acquia.com/resource/browser-tool/
	 https://www.drupal.org/node/147789#web-browser-tools


MAINTAINERS
-----------

 * mehrpadin - https://www.drupal.org/u/mehrpadin

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended Modules

  7.  * Installation

  8.  * Configuration

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

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

  14. 

  15. This module allows for integration of jQuery Superfish plug-in with Drupal CMS.

  16. 

  17.  * For a full description of the module, visit the project page:

  18.    https://www.drupal.org/project/superfish

  19. 

  20.  * To submit bug reports and feature suggestions, or to track changes:

  21.    https://www.drupal.org/project/issues/superfish

  22. 

  23. 

  24. REQUIREMENTS

  25. ------------

  26. 

  27. This module requires the following outside of Drupal core:

  28. 

  29.  * Superfish library - https://github.com/mehrpadin/Superfish-for-Drupal/

  30. 

  31. 

  32. RECOMMENDED MODULES

  33. -------------------

  34. 

  35.  * Libraries API - https://www.drupal.org/project/libraries

  36.  * jQuery Easing plugin - https://www.drupal.org/project/jqeasing

  37. 

  38. 

  39. INSTALLATION

  40. ------------

  41. 

  42.  * Install the Superfish module as you would normally install a contributed

  43.    Drupal module. Visit

  44.    https://www.drupal.org/node/1897420 for further information.

  45. 

  46. 

  47. CONFIGURATION

  48. -------------

  49. 

  50.     1. Navigate to Administration > Extend and enable the module.

  51.     2. Go to Administation > Structure > Block layout > select a Place block

  52.        button to add a Superfish block to a region.

  53.     3. Use the "Configure" link of the block to configure it accordingly to your

  54.        needs.

  55. 

  56. How to style:

  57.     1. In the block configuration page, set the Style to None

  58.     2. Copy one of the Superfish sample styles, for example default.css from

  59.        sites/all/libraries/superfish/style to your theme; either as a separate

  60.        CSS file or part of the main CSS file of your theme.

  61.     3. Rename the selectors .sf-style-default to .sf-style-none or remove

  62.        them altogether.

  63.     4. You are now ready to unleash your CSS artistry :)

  64. 

  65. Some design tips:

  66.  * Utilize a DOM inspector (such as Firefox Developer Tools) for temporarily

  67.    modifying live code in real time.

  68.  * Set the Mouse delay of the block settings to 99999999 so the sub-menus will

  69.    stay open for a longer time giving you more time to work with them in the

  70.    DOM inspector etc.

  71.    Useful links:

  72. 	 https://docs.acquia.com/resource/browser-tool/

  73. 	 https://www.drupal.org/node/147789#web-browser-tools

  74. 

  75. 

  76. MAINTAINERS

  77. -----------

  78. 

  79.  * mehrpadin - https://www.drupal.org/u/mehrpadin