You are here

Home » API reference » Mobile sliding menu 7

README.txt in Mobile sliding menu 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.3 README.txt
  3. 7.2 README.txt
ABOUT
--------------------------------------------------------------------------------
The mobile sliding menu module integrates the mmenu jQuery plugin
for creating slick, app look-alike sliding menus for you mobile website.

REQUIREMENTS
--------------------------------------------------------------------------------
- Libraries module.
- jQuery 1.7.0 or later.

FEATURES
--------------------------------------------------------------------------------
The mmenu jQuery plugin has following features:
- Fully responsive CSS framework generated with SCSS.
- Creates sliding panels as easy as menus.
- Menu can be positioned at the top, right, bottom or left, at the back,
  front or next to the page.
- Use sliding horizontal or expanding vertical submenus.
- Optionally open the menu by dragging the page out of the viewport.
- Plays nicely with jQuery Mobile.
- Add headers, labels, counters and even a search field.
- Completely themable by changing the background-color.
- Works well on all major browsers.
- Filled with options for customizing the menu.
- Uses SCSS to easily create customized menus.

INSTALLATION
--------------------------------------------------------------------------------
1 - First, install the mmenu module (standard Drupal way).
2 - Adds plugin library.
  2.1.1 - Download Mmenu library: http://mmenu.frebsite.nl/download.php.
  2.1.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/main".
  2.1.3 - For example, the css file could be accessed in
          "/sites/all/libraries/mmenu/main/src/css/jquery.mmenu.all.css".
  2.2.1 - Download Hammer.js library: http://eightmedia.github.io/hammer.js.
  2.2.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/hammer".
  2.2.3 - For example, the css file could be accessed in
          "/sites/all/libraries/mmenu/hammer/hammer.min.js".
  2.3.1 - Download Hammer.js library: https://github.com/EightMedia/jquery.hammer.js.
  2.3.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/jquery.hammer".
  2.3.3 - For example, the css file could be accessed in
          "/sites/all/libraries/mmenu/jquery.hammer/jquery.hammer.min.js".
3 - Configurations
  3.1 - Sets the version to 1.7 or above at /admin/config/development/jquery_update.
  3.2 - Configs each mmenu at /admin/config/mmenu.

File

README.txt
View source 
  1. 

  2. ABOUT

  3. --------------------------------------------------------------------------------

  4. The mobile sliding menu module integrates the mmenu jQuery plugin

  5. for creating slick, app look-alike sliding menus for you mobile website.

  6. 

  7. REQUIREMENTS

  8. --------------------------------------------------------------------------------

  9. - Libraries module.

  10. - jQuery 1.7.0 or later.

  11. 

  12. FEATURES

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

  14. The mmenu jQuery plugin has following features:

  15. - Fully responsive CSS framework generated with SCSS.

  16. - Creates sliding panels as easy as menus.

  17. - Menu can be positioned at the top, right, bottom or left, at the back,

  18.   front or next to the page.

  19. - Use sliding horizontal or expanding vertical submenus.

  20. - Optionally open the menu by dragging the page out of the viewport.

  21. - Plays nicely with jQuery Mobile.

  22. - Add headers, labels, counters and even a search field.

  23. - Completely themable by changing the background-color.

  24. - Works well on all major browsers.

  25. - Filled with options for customizing the menu.

  26. - Uses SCSS to easily create customized menus.

  27. 

  28. INSTALLATION

  29. --------------------------------------------------------------------------------

  30. 1 - First, install the mmenu module (standard Drupal way).

  31. 2 - Adds plugin library.

  32.   2.1.1 - Download Mmenu library: http://mmenu.frebsite.nl/download.php.

  33.   2.1.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/main".

  34.   2.1.3 - For example, the css file could be accessed in

  35.           "/sites/all/libraries/mmenu/main/src/css/jquery.mmenu.all.css".

  36.   2.2.1 - Download Hammer.js library: http://eightmedia.github.io/hammer.js.

  37.   2.2.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/hammer".

  38.   2.2.3 - For example, the css file could be accessed in

  39.           "/sites/all/libraries/mmenu/hammer/hammer.min.js".

  40.   2.3.1 - Download Hammer.js library: https://github.com/EightMedia/jquery.hammer.js.

  41.   2.3.2 - Unzip the library files in the Drupal path "/sites/all/libraries/mmenu/jquery.hammer".

  42.   2.3.3 - For example, the css file could be accessed in

  43.           "/sites/all/libraries/mmenu/jquery.hammer/jquery.hammer.min.js".

  44. 3 - Configurations

  45.   3.1 - Sets the version to 1.7 or above at /admin/config/development/jquery_update.

  46.   3.2 - Configs each mmenu at /admin/config/mmenu.