You are here

README.txt in Mobile sliding menu 7.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.3 README.txt
  3. 7 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, installs the mmenu module (standard Drupal way).

2 - Adds plugin library.

  2.1.1 - Downloads Mmenu library version 4.5 or above at
          http://mmenu.frebsite.nl/download.php.
  2.1.2 - Unzips 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 - Downloads Hammer.js library version 2.0 or above at
          https://github.com/hammerjs/hammer.js.
  2.2.2 - Unzips the library files in the Drupal path
          "/sites/all/libraries/mmenu/hammer".
  2.2.3 - For example, the js file could be accessed in
          "/sites/all/libraries/mmenu/hammer/hammer.min.js".

  2.3.1 - Downloads jQuery plugin for the Hammer.js library version 2.0 or above
          at https://github.com/EightMedia/jquery.hammer.js.
  2.3.2 - Unzips the library files in the Drupal path
          "/sites/all/libraries/mmenu/jquery.hammer".
  2.3.3 - For example, the js file could be accessed in
          "/sites/all/libraries/mmenu/jquery.hammer/jquery.hammer.js".

  2.4.1 - Since mmenu v2.0, the icomoon data has been removed from the module.
          But you can generate your own icons via https://icomoon.io/app,
          or you can just download it from here
          https://www.drupal.org/files/mmenu-icomoon.tar_.gz.
  2.4.2 - Unzips the icomoon data in the Drupal path
          "/sites/all/libraries/mmenu/icomoon".
  2.4.3 - Copies the styles.css and renames to icomoon.css.
  2.4.4 - For example, the css file could be accessd in
          "/sites/all/libraries/mmenu/icomoon/icomoon.css".

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. ABOUT
  2. --------------------------------------------------------------------------------
  3. The mobile sliding menu module integrates the mmenu jQuery plugin
  4. for creating slick, app look-alike sliding menus for you mobile website.
  5. REQUIREMENTS
  6. --------------------------------------------------------------------------------
  7. - Libraries module.
  8. - jQuery 1.7.0 or later.
  9. FEATURES
  10. --------------------------------------------------------------------------------
  11. The mmenu jQuery plugin has following features:
  12. - Fully responsive CSS framework generated with SCSS.
  13. - Creates sliding panels as easy as menus.
  14. - Menu can be positioned at the top, right, bottom or left, at the back,
  15. front or next to the page.
  16. - Use sliding horizontal or expanding vertical submenus.
  17. - Optionally open the menu by dragging the page out of the viewport.
  18. - Plays nicely with jQuery Mobile.
  19. - Add headers, labels, counters and even a search field.
  20. - Completely themable by changing the background-color.
  21. - Works well on all major browsers.
  22. - Filled with options for customizing the menu.
  23. - Uses SCSS to easily create customized menus.
  24. INSTALLATION
  25. --------------------------------------------------------------------------------
  26. 1 - First, installs the mmenu module (standard Drupal way).
  27. 2 - Adds plugin library.
  28. 2.1.1 - Downloads Mmenu library version 4.5 or above at
  29. http://mmenu.frebsite.nl/download.php.
  30. 2.1.2 - Unzips the library files in the Drupal path
  31. "/sites/all/libraries/mmenu/main".
  32. 2.1.3 - For example, the css file could be accessed in
  33. "/sites/all/libraries/mmenu/main/src/css/jquery.mmenu.all.css".
  34. 2.2.1 - Downloads Hammer.js library version 2.0 or above at
  35. https://github.com/hammerjs/hammer.js.
  36. 2.2.2 - Unzips the library files in the Drupal path
  37. "/sites/all/libraries/mmenu/hammer".
  38. 2.2.3 - For example, the js file could be accessed in
  39. "/sites/all/libraries/mmenu/hammer/hammer.min.js".
  40. 2.3.1 - Downloads jQuery plugin for the Hammer.js library version 2.0 or above
  41. at https://github.com/EightMedia/jquery.hammer.js.
  42. 2.3.2 - Unzips the library files in the Drupal path
  43. "/sites/all/libraries/mmenu/jquery.hammer".
  44. 2.3.3 - For example, the js file could be accessed in
  45. "/sites/all/libraries/mmenu/jquery.hammer/jquery.hammer.js".
  46. 2.4.1 - Since mmenu v2.0, the icomoon data has been removed from the module.
  47. But you can generate your own icons via https://icomoon.io/app,
  48. or you can just download it from here
  49. https://www.drupal.org/files/mmenu-icomoon.tar_.gz.
  50. 2.4.2 - Unzips the icomoon data in the Drupal path
  51. "/sites/all/libraries/mmenu/icomoon".
  52. 2.4.3 - Copies the styles.css and renames to icomoon.css.
  53. 2.4.4 - For example, the css file could be accessd in
  54. "/sites/all/libraries/mmenu/icomoon/icomoon.css".
  55. 3 - Configurations
  56. 3.1 - Sets the version to 1.7 or above at
  57. /admin/config/development/jquery_update.
  58. 3.2 - Configs each mmenu at /admin/config/mmenu.