Jump to content
kongondo

Menu Builder

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 36

Share this post


Link to post
Share on other sites

I love it.

I said before: "I like it that way, PLEASE stay talkin' on the forums"

Now I think, stay away from the forums and go code for us :)

  • Like 2

Share this post


Link to post
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

Share this post


Link to post
Share on other sites

Thanks all!

@onjegolders,

Good ideas, thanks for the suggestions, I'll look into them. 

music = Fourplay  - "Pineapple Getaway"

  • Like 1

Share this post


Link to post
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

Share this post


Link to post
Share on other sites

@kongondo - do you think it would be ok to use this on a production site? I have to make a custom menu for a new site, and before i go and do it with pages, i wanted to maybe consider using this..

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
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

Share this post


Link to post
Share on other sites

@kongondo thank you - i did just go ahead and use my normal way of managing menus which is by setting up a menu page tree and then coding the output manually;

Welcome Back!

  • Like 1

Share this post


Link to post
Share on other sites

Yeah, incidentally I mentioned this elsewhere today. I got stuck on some recursive function :-). It's not high on my priority list atm but will have a rethink at some point...

  • Like 1

Share this post


Link to post
Share on other sites

No, sorry...I haven't. I didn't really think there would be interest....Hmm...I'll make a decision this week. If I take it up again I would have to change a few things now that I am a little bit wiser...We'll see.

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

I, for one, would love a solid module that handles menu management.

Me too.

Share this post


Link to post
Share on other sites

OK, we are on. I have resumed work on this and taken a newish approach. Hope to post something by end of play tomorrow...

  • Like 5

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

I haven't tested yet, but it looks very impressive - awesome job!

  • Like 1

Share this post


Link to post
Share on other sites

I just tested it and it's very nice.

I want to put a class on the menu submenu so on nested unordered list. Is there an option for this?

For example <ul class="submenu">

  • Like 2

Share this post


Link to post
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! 

Share this post


Link to post
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.

Share this post


Link to post
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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...