Skip to content

meltingmedia/Vertical-Navigation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vertical Navigation

Transforms MODX Revolution west region (left navigation) into an accessible vertical navigation. Works well with "Tree Menu" component (to add extra menu records, to be released).

Thanks to MODX LLC for the funding.

Requirements

  • PHP 5.3+
  • MODX Revolution 2.3+

Note : the component might not work with custom manager themes overriding MODx.Layout#getWest, MODx.Layout#getLeftBar or MODx.Layout#addToLeftBar, since those methods are overridden to handle vertical menu entries.

Installation

  1. Download and install the transport package
  2. Head over system settings (or user settings if you want this only for your user) and set vnav.use_vnav value to 1

You should be ready to go once you reload the manager

DOM structure & technical details

By using Vertical Navigation, the west region is transformed and no more makes use of tabs. The main container become an ul, with nested "menu entries" as li.x-panel.menu-section

Each "menu entry" (previously tab) is an MODx.menuEntry instance (Ext.Panel derivative). The panel title is used to display the container label (ie. Resources, Elements, Files...).

The DOM structure is :

  • div#modx-leftbar (whole west region)
    • div.x-plain-bwrap (west region wrapper)
      • ul (all menu entries container)
        • li.x-panel.menu-section (menu entry container)
          • a.x-panel-header (title container)
            • span.x-panel-header-text (title text wrapper)
              • i.icon (title icon)
              • span.title (title label)
          • div.x-panel-bwrap (content wrapper)
            • div.x-panel-body (content container)

Bug reports

Head over https://github.com/meltingmedia/Vertical-Navigation/issues

License

CmpStarter is licensed under the MIT license. Copyright 2014 Melting Media https://github.com/meltingmedia