You are here

Home » API reference » Menu Block 8

README.txt in Menu Block 8

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 7.3 README.txt
  3. 7.2 README.txt
ABOUT MENU BLOCK
----------------

Like Drupal core, the Menu Block module allows you to create blocks of menu
items. However, Menu Block's blocks are much more configurable than Drupal
core's.

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

You must remove and re-add any existing menu blocks after installing this module.

Currently the module has no effect on existing menu blocks,
see issue: #2787677: Reconfigure core menu blocks to be menu_block blocks
https://www.drupal.org/project/menu_block/issues/2787677


ADDING MENU BLOCKS
------------------

To add new menu blocks:
 1. Install module.
 2. Go to /admin/structure/block.
 3. Click the "Place block" button in the desired region.
 4. Choose a block from the "Menus" category.
 5. In the form that appears, configure the options desired and then click the
    "Save block" button.


CONFIGURING MENU BLOCKS
-----------------------

When adding or configuring a menu block, several configuration options are
available:

Basic Options:

  Title
    The default block title will be the menu name.

  Display title
    Checkbox to have the block title visible or not. If unchecked, the block
    title will remain accessible, but hidden visually.

Menu levels:

  Initial menu level
    The menu will only be visible if the menu item for the current page is at or
    below the selected starting level. Select level 1 to always keep this menu
    visible.

  Maximum number of menu levels to display
    The maximum number of menu levels to show, starting from the initial menu
    level. For example: with an initial level 2 and a maximum number of 3, menu
    levels 2, 3 and 4 can be displayed.

Advanced options:

  Expand all menu links
    All menu links that have children will "Show as expanded".

  Fixed parent item
    Alter the options in “Menu levels” to be relative to the fixed parent item.
    The block will only contain children of the selected menu link.

  Use as title
    Replace the block title with an item from the menu.

HTML and style options:

  Theme hook suggestion
    A theme hook suggestion can be used to override the default HTML and CSS
    classes for menus found in menu.html.twig.

File

README.txt
View source 
  1. ABOUT MENU BLOCK

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

  3. 

  4. Like Drupal core, the Menu Block module allows you to create blocks of menu

  5. items. However, Menu Block's blocks are much more configurable than Drupal

  6. core's.

  7. 

  8. INSTALLATION

  9. ------------

  10. 

  11. You must remove and re-add any existing menu blocks after installing this module.

  12. 

  13. Currently the module has no effect on existing menu blocks,

  14. see issue: #2787677: Reconfigure core menu blocks to be menu_block blocks

  15. https://www.drupal.org/project/menu_block/issues/2787677

  16. 

  17. 

  18. ADDING MENU BLOCKS

  19. ------------------

  20. 

  21. To add new menu blocks:

  22.  1. Install module.

  23.  2. Go to /admin/structure/block.

  24.  3. Click the "Place block" button in the desired region.

  25.  4. Choose a block from the "Menus" category.

  26.  5. In the form that appears, configure the options desired and then click the

  27.     "Save block" button.

  28. 

  29. 

  30. CONFIGURING MENU BLOCKS

  31. -----------------------

  32. 

  33. When adding or configuring a menu block, several configuration options are

  34. available:

  35. 

  36. Basic Options:

  37. 

  38.   Title

  39.     The default block title will be the menu name.

  40. 

  41.   Display title

  42.     Checkbox to have the block title visible or not. If unchecked, the block

  43.     title will remain accessible, but hidden visually.

  44. 

  45. Menu levels:

  46. 

  47.   Initial menu level

  48.     The menu will only be visible if the menu item for the current page is at or

  49.     below the selected starting level. Select level 1 to always keep this menu

  50.     visible.

  51. 

  52.   Maximum number of menu levels to display

  53.     The maximum number of menu levels to show, starting from the initial menu

  54.     level. For example: with an initial level 2 and a maximum number of 3, menu

  55.     levels 2, 3 and 4 can be displayed.

  56. 

  57. Advanced options:

  58. 

  59.   Expand all menu links

  60.     All menu links that have children will "Show as expanded".

  61. 

  62.   Fixed parent item

  63.     Alter the options in “Menu levels” to be relative to the fixed parent item.

  64.     The block will only contain children of the selected menu link.

  65. 

  66.   Use as title

  67.     Replace the block title with an item from the menu.

  68. 

  69. HTML and style options:

  70. 

  71.   Theme hook suggestion

  72.     A theme hook suggestion can be used to override the default HTML and CSS

  73.     classes for menus found in menu.html.twig.