You are here

Home » API reference » Simple Mega Menu 2.0.x

README.txt in Simple Mega Menu 2.0.x

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

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Troubleshooting
 * FAQ
 * Maintainers

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

Simple MegaMenu module provide a easy way to build mega menu.

This module provides a new content entity type, Simple MegaMenu. These entities
can be managed as the node entity type : Create bundle, add view mode, add
fields, customize display, etc. For each bundle created, you have to specify
on which menu this bundle will be available.

You can then reference, from each Menu link content item, any entities
available for this bundle.

The simple MegaMenu entity attached to an item is then rendered from the Twig
template provided by the module. To achieve this, two new Twig functions are
available :

* view_megamenu(Url $url, 'view_mode') : this function allows to render the
  simple MegaMenu entity attached to an item url, in any view mode needed.
* has_megamenu(Url $url) : this function allows you to check if an item has a
  Simple MegaMenu entity attached to it.

You can then easily customize how your megamenu looks like by overriding the
Twig template in your theme.

By default, the module provide two view modes for the simple mega menu
entity type : Before and After.

The default template use theses two view modes.

You can then easily update your custom template and use any custom view mode
you want, to feet your needs. And you can too render entities attached where
you want.

Simple MegaMenu entities are translatable and revisionable and play nice with
a mutlilingual site.

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

None

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


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

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.

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

* Create a simple mega menu type, as any Content type
* For each simple mega menu type; you have to set on which menu it will be used.
* Configure the simple mega menu type as for a content type :
  - add fields
  - configure form mode
  - configure view mode
* Create som simple mega menu entities
* Edit any Menu link content item form the menu set on the simple mega menu type
  created above. Select the simple mega menu entity you want attach to the menu
* Override and customize the menu--simple-megamenu.html.twig template belong
  your needs


TROUBLESHOOTING
---------------


FAQ
---


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

Current maintainers:
 * flocondetoile - https://drupal.org/u/flocondetoile

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Troubleshooting

  10.  * FAQ

  11.  * Maintainers

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. Simple MegaMenu module provide a easy way to build mega menu.

  17. 

  18. This module provides a new content entity type, Simple MegaMenu. These entities

  19. can be managed as the node entity type : Create bundle, add view mode, add

  20. fields, customize display, etc. For each bundle created, you have to specify

  21. on which menu this bundle will be available.

  22. 

  23. You can then reference, from each Menu link content item, any entities

  24. available for this bundle.

  25. 

  26. The simple MegaMenu entity attached to an item is then rendered from the Twig

  27. template provided by the module. To achieve this, two new Twig functions are

  28. available :

  29. 

  30. * view_megamenu(Url $url, 'view_mode') : this function allows to render the

  31.   simple MegaMenu entity attached to an item url, in any view mode needed.

  32. * has_megamenu(Url $url) : this function allows you to check if an item has a

  33.   Simple MegaMenu entity attached to it.

  34. 

  35. You can then easily customize how your megamenu looks like by overriding the

  36. Twig template in your theme.

  37. 

  38. By default, the module provide two view modes for the simple mega menu

  39. entity type : Before and After.

  40. 

  41. The default template use theses two view modes.

  42. 

  43. You can then easily update your custom template and use any custom view mode

  44. you want, to feet your needs. And you can too render entities attached where

  45. you want.

  46. 

  47. Simple MegaMenu entities are translatable and revisionable and play nice with

  48. a mutlilingual site.

  49. 

  50. REQUIREMENTS

  51. ------------

  52. 

  53. None

  54. 

  55. RECOMMENDED MODULES

  56. -------------------

  57. 

  58. 

  59. INSTALLATION

  60. ------------

  61. 

  62.  * Install as you would normally install a contributed Drupal module. See:

  63.    https://drupal.org/documentation/install/modules-themes/modules-7

  64.    for further information.

  65. 

  66. CONFIGURATION

  67. -------------

  68. 

  69. * Create a simple mega menu type, as any Content type

  70. * For each simple mega menu type; you have to set on which menu it will be used.

  71. * Configure the simple mega menu type as for a content type :

  72.   - add fields

  73.   - configure form mode

  74.   - configure view mode

  75. * Create som simple mega menu entities

  76. * Edit any Menu link content item form the menu set on the simple mega menu type

  77.   created above. Select the simple mega menu entity you want attach to the menu

  78. * Override and customize the menu--simple-megamenu.html.twig template belong

  79.   your needs

  80. 

  81. 

  82. TROUBLESHOOTING

  83. ---------------

  84. 

  85. 

  86. FAQ

  87. ---

  88. 

  89. 

  90. MAINTAINERS

  91. -----------

  92. 

  93. Current maintainers:

  94.  * flocondetoile - https://drupal.org/u/flocondetoile