MenuBuilder

An easy way to build HTML navigation menus. MenuBuilder is an alternative/replacement for the Wayfinder extra.

Features

• Use different Chunks for every level of your menu if you choose
• Performance, loads all menu items from a single SQL query
• Simpler design and usage, faster to get up and going and more flexible.

Install

Requires an installation of MODX

• Install Orchestrator
• Add to the composer.json file as below
• Add to your .env file parameters in the sample.env file and customize.
• Run composer update
• If you did not set up Orchestrator as the LocalOrchestrator example or you want to manually call the install script.
  Run $ php vendor/bin/orchestrator orchestrator:package lci/modx-menubuilder from where you have composer.json.

Composer.json

Add the following to your composer.json file

{
  "require": {
    "lci/modx-menubuilder": "dev-master"
  },
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/LippertComponents/MenuBuilder"
    }
  ],
  "extra": {
    "auto-install": [
      "lci/modx-menubuilder"
    ]
  },
  "minimum-stability": "dev"
}

What is installed in MODX

• Custom database table: modx_mb_sequence
• Snippets menuBuilder
• A Plugin: buildMenuSequence and attach System Events:
  • OnDocFormSave
  • OnResourceSort
  • OnCacheUpdate
• Save or sort a Resource in the MODX Tree and it will populate the database and will for every on change.
• MODX namespace: menubuilder
• System settings will allow you to turn off when the menu sequence rebuilds happen:
  • menubuilder.rebuildOnCacheUpdate
  • menubuilder.rebuildOnDocFormSave
  • menubuilder.rebuildOnResourceSort
  • menubuilder.logDebug

Build a navigation menu

Place a Snippet call into your appropriate Template/Chunk/Resource. Like:

[[menuBuilder?
    &startId=`1`
]]

Chunks used

By default will generate an unordered list.

Note (bool) stands for boolean which is true/false or 1/0.

General options