Jump to content

Menu Builder


kongondo

Recommended Posts

Menu Builder
 

As of 29 December 2017 ProcessWire versions earlier than 3.x are not supported

Modules Directory
Project Page
Read Me (How to install, use, etc..)

For highly customisable menus, please see this post.

If you want a navigation that mirrors your ProcessWire page tree, the system allows you to easily create recursive menus using either vanilla PHP or Soma's great MarkupSimpleNavigation. In some cases, however, you may wish to create menus that:
1. Do not mirror you site's page tree (hirarchies and ancestry); and
2. You can add custom links (external to your site) to.


That is primarily where Menu Builder comes in. It is also helpful if you:
3. Prefer creating menus via drag and drop
4. Have a need for menus (or other listings) that will be changing regularly or that you want to allow your admin users to edit.


The issue of custom menus is not new here in the forums. The difference is that this module allows you to easily create such menus via drag and drop in the Admin. Actually, you can even use it to just create some list if you wanted to. In the backend, the module uses the jQueryUI plugin nestedSortable by Manuele J Sarfatti for the drag and drop and is inspired in part by the WP Custom Menu feature.
 
Please read the Read Me completely before using this module. 

For Complex or highly-customised menus, it is recommended to use the getMenuItems() method as detailed in this post.
 
Features

  • Ability to create menus that do not mirror your ProcessWire Page Tree hierarchy/structure
  • Menus can contain both ProcessWire pages and custom links
  • Create menu hierarchies and nesting via drag and drop
  • Easily add CSS IDs and Classes to each menu item on creating the menu items (both custom and from ProcessWire pages) or post creation.
  • Optionally set custom links to open in a new tab
  • Change menu item titles built from ProcessWire pages (without affecting the original page). E.g. if you have a page titled 'About Us' but you want the menu item title to be 'About'
  • Readily view the structure and settings for each menu item
  • Menus stored as pages (note: just the menu, not the items!)
  • Menu items stored as JSON in a field in the menu pages (empty values not stored)
  • Add menu items from ProcessWire pages using page fields (option to choose between PageAutocomplete and AsmSelect [default]) or a Selector (e.g. template=basic-page, limit=20, sort=title).
  • For page fields, you can specify a selector to return only those specified pages for selection in the page field (i.e. asm and autocomplete)
  • For superusers, optionally allow markup in your menu titles, e.g. <span>About</span>
  • Menu settings for nestedSortable - e.g. maxLevels (limit nesting levels)
  • Advanced features (e.g. add pages via selector, menu settings) currently permissible to superadmins only (may change to be permission-based)
  • Delete single or all menu items without deleting the menu itself
  • Lock down menus for editing
  • Highly configurable MarkupMenuBuilder - e.g. can pass menu id, title, name or array to render(); Passing an array means you can conditionally manipulate it before rendering, e.g. make certain menu branches visible only to certain users [the code is up to you!] 
  • Optionally grab menu items only (as a Menu object WireArray or a normal array) and use your own code to create custom highly complex menus to meet any need.
  • More...

In the backend, ProcessMenuBuilder does the menu creation. For the frontend, menus are displayed using MarkupMenuBuilder.

Credits

In this module's infancy (way back!), I wanted to know more about ProcessWire modules as well as improve my PHP skills. As they say, what better way to learn than to actually create something? So, I developed this module (instead of writing PW tutorials as promised, tsk, tsk, naughty, naughty!) in my own summer of code :). Props to Wanze, Soma, Pete, Antti and Ryan whose modules I studied (read copied ;)) to help in my module development and to Teppo for his wonderful write-up on the "Anatomy of fields in ProcessWire" that vastly improved my knowledge and understanding of how PW works. Diogo and marcus for idea about using pages (rather than a custom db table), onjegolders for his helpful UI comments, Martijn Geerts, OrganizedFellow, dazzyweb and Mike Anthony for 'pushing me' to complete this module and netcarver for help with the code.
 
Screens
mb-0.0.2-001.pngmb-0.0.2-002.pngmb-0.0.2-003.pngmb-0.0.2-004.pngmb-0.0.2-005.pngmb-0.0.2-006.pngmb-0.0.2-007.pngmb-0.0.2-008.pngmb-0.0.2-009.pngmb-0.0.2-010.png

Edited by kongondo
ProcessWire 3.x support only
  • Like 37
Link to comment
Share on other sites

Very impressive Kongondo, looks great.

If there were a way of combining the two steps into one (adding new items & arranging items) I think it would be a better experience for the user. 

1) Add a new item

2) Choose from a dropdown whether it's a native page or external

3) Add item and item details.

I can understand that with required fields it may be harder to achieve all of this from within the item boxes.

The other slight improvement would be if the page tree remains open when an item has been clicked?

But it already looks like a great addition to PW :)

PS Love the music!

  • Like 1
Link to comment
Share on other sites

Awesome work Kongondo! Very impressive seeing it in action from your video too. 

Regarding the help-please section and security: is the Process tool intended primarily for superuser/developer use, or something that would be available to non-superusers? If exclusive to superusers (as many admin/developer helper tools can be), security becomes a much simpler task because we already assume they have access to do whatever they want. If not exclusive to superusers, then there's more to consider. With regards to SQL queries, it looks like you are doing a good job of sanitizing everything that gets bundled into a query. But for any string values, you might also want to run them through $str=$db->escape_string($str); just to complete it with the DB driver's own sanitization method. It's probably not technically necessary in any of the instances I saw, but it's just a good practice either way. Of course, you can also use numbered parameters in mysqli to avoid that issue, but I don't care for mysqli's implementation of this and generally don't use it (on the other hand, PDO's named parameters are great). 

  • Like 1
Link to comment
Share on other sites

  • 1 month later...
  • 3 weeks later...

Hi Macrura,

Sorry not to have picked this up sooner. I wouldn't use this on a live site just yet, mainly because the user has no way (yet) to delete individual menu items via the GUI. Unfortunately, I don't see myself having time to continue working on this until the end of the year most likely. Please feel free to explore a workaround or adapt it to your needs though, if you wish. Thanks. 

Cheers,

/k

Link to comment
Share on other sites

@Ryan,

Thanks for your comments. The original plan was to let non-superusers with the right permissions also use the module. This would enable them to build their own navigation systems easily, a la WP. However, besides security, that could lead to other issues such as wanton addition of menu items! I haven't made a final decision yet. We'll see.

  • Like 1
Link to comment
Share on other sites

  • 9 months later...
  • 6 months later...

I, for one, would love a solid module that handles menu management. I have a large site coming up in a month or so that would require it. Automatic menu generation doesn't sit so well for me - so this is a must have. If you decide to not do it, then I'm sure I can make use of a page structure under admin to mimic the functionality... But, I think a dedicated module is better - especially for the client, who needs to be able to modify certain menus as and when needed.

  • Like 1
Link to comment
Share on other sites

  • 2 weeks later...

Update: Menu Builder Version 0.0.2 is now available.
 
I'll update the original post later + post a new video.
 
Main Changes:

  • Beta status
  • Menus stored as pages (note: just the menu, not the items!)
  • Menu items stored as JSON in a field in the menu pages (empty values not stored)
  • Add menu items from ProcessWire pages using page fields (option to choose between PageAutocomplete and AsmSelect [default]) or a Selector (e.g. template=basic-page, limit-20).
  • For page fields, you can specify a selector to return only those specified pages for selection in the page field (i.e. asm and autocomplete)
  • For page fields, now you can also add css classes and IDs as you add the items
  • Menu settings for nestedSortable - e.g. maxLevels (limit nesting levels)
  • Advanced features (e.g. add pages via selector, menu settings) currently permissible to superadmins only (may change to be permission-based)
  • Delete single or all menu items without deleting the menu itself
  • Lock down menus for editing
  • Highly configurable MarkupMenuBuilder - e.g. can pass menu id, title, name or array to render(); Passing an array means you can conditionally manipulate it before rendering, e.g. make certain menu branches visible only to certain users [untested and the code is up to you!] 
  • More...

Note:

  • Some nestedSortable features not yet implemented/working (some are not really necessary actually).
  • The module creates 3 fields (menu_items, menu_pages, menu_settings) and 1 template (menus). 
  • Menu pages are stored as children under the modules parent page (admin/setup/menu-builder/) - so not accessible in the frontend

Issues:
Drag and drop (ordering menu items) is some times finicky...something in the js I think or just my mouse.
 

Edited by kongondo
  • Like 12
Link to comment
Share on other sites

This is just what I needed - works brilliantly, and is easy to use. I do have a few suggestions, though:

  1. It would be nice to have compatibility for the <nav> tag - I use them in my menus instead of unordered lists.
  2. Also, I should be able to add a class and/or an ID to each menu.
  3. Lastly, it would be great if I could add a class to sub-menu <ul> as well as any menu-item <li>
Otherwise, this is fantastic - thank you :-)

Edit: Dazzyweb beat me to it! 

Link to comment
Share on other sites

@Mike Anthony Regarding suggestion 2: I think you could add a different class and/or ID to each menu by creating another differently named options array and give a different name for menu_css_id and menu_css_class then use these options in your other menu.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...