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

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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.56
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By BitPoet
      As threatened in Ryan's announcement for 3.0.139, I built a little module for sliding toggles as a replacement for checkboxes. Styling of the input is CSS3 only (with all the usual caveats about older browsers), no JS necessary, and may still be a bit "rough around the edges", so to speak, since I didn't have much time for testing on different devices or brushing things up enough so I'd feel comfortable pushing it to the module directory. But here's the link to the GitHub repo for now:
      InputfieldSlideToggle
      Fieldtype and Inputfield that implements smartphone-style toggles as replacement for checkbox inputs. The visualization is CSS-only, no additional JS necessary.
      Status
      Still very alpha, use with caution!
      Features / Field Settings
      Size
      You can render the toggles in four different sizes: small, medium, large and extra large.
      Off Color
      Currently, "unchecked" toggles can be displayed either in grey (default) or red.
      On Color
      "Checked" toggles can be rendered in one of these colors: blue (default), black, green, grey, orange or red.
      Screenshots

      Some examples with checkbox label


      View all Size and Color Combinations
      Small toggles Medium toggles Big toggles Extra big toggles  









    • By Orkun
      Hi Guys
      I needed to add extended functionalities for the InputfieldDatetime Module (module is from processwire version 2.7.3) because of a Request of Customer.
      So I duplicated the module and placed it under /site/modules/.
      I have added 3 new Settings to the InputfieldDatetime Module.
      1. Day Restriction - Restrict different days based on weekdays selection (e.g. saturday, sunday) - WORKING

       
      2. Time Slots - Define Time slots based on custom Integer Value (max is 60 for 1 hour) - WORKING

       
      3. Time Range Rules per Weekday - Define a minTime and MaxTime per Weekday (e.g. Opening Hours of a Restaurant) - NOT WORKING PROPERLY

       
      The Problem
      Time Slots and Day Restriction working fine so far. But the Time Range Rules per Weekday doesn't work right.
      What should happen is, that when you click on a date, it should update the minTime and maxTime of the Time Select.
      But the change on the select only happens if you select a date 2 times or when you select a date 1 time and then close the datepicker and reopen it again.
      The time select doesn't get change when you select a date 1 time and don't close the picker.
      Here is the whole extended InputfieldDatetime Module.
      The Files that I have changed:
      InputfieldDatetime.module InputfieldDatetime.js jquery-ui-timepicker-addon.js (https://trentrichardson.com/examples/timepicker/) - updated it to the newest version, because minTime and maxTime Option was only available in the new version  
      Thats the Part of the JS that is not working correctly:
      if(datetimerules && datetimerules.length){ options.onSelect = function(date, inst) { var day = $(this).datetimepicker("getDate").getDay(); day = day.toString(); var mintime = $(this).attr('data-weekday'+day+'-mintime'); var maxtime = $(this).attr('data-weekday'+day+'-maxtime'); console.log("weekday: "+day); console.log("minTime: "+mintime); console.log("maxTime: "+maxtime); var optionsAll = $(this).datetimepicker( "option", "all" ); optionsAll.minTime = mintime; optionsAll.maxTime = maxtime; $(this).datetimepicker('destroy'); $(this).datetimepicker(optionsAll); $(this).datetimepicker('refresh'); //$.datepicker._selectDate($(this).attr("id"),date); //$.datepicker._base_getDateDatepicker(); // var inst = $.datepicker._getInst($(this)); // $.datepicker._updateDatepicker(inst); /*$(this).datetimepicker('destroy'); InputfieldDatetimeDatepicker($(this), mintime, maxtime); $(this).datetimepicker('refresh'); */ // $(this).datetimepicker('option', {minTime: mintime, maxTime: maxtime}); } } Can you have a look and find out what the Problem is?
      InputfieldDatetime.zip
       
      Kind Regards
      Orkun
    • By teppo
      This module tracks changes, additions, removals etc. of public (as in "not under admin") pages of your site. Like it's name says, it doesn't attempt to be a version control system or anything like that - just a log of what's happened.
      At the moment it's still a work in progress and will most likely be a victim of many ruthless this-won't-work-let's-try-that-instead cycles, but I believe I've nailed basic functionality well enough to post it here.. so, once again, I'll be happy to hear any comments you folks can provide
      https://modules.processwire.com/modules/process-changelog/
      https://github.com/teppokoivula/ProcessChangelog
      How does it work?
      Exactly like it's (sort of) predecessor, Process Changelog actually consists of two modules: Process Changelog and Process Changelog Hooks. Hooks module exists only to serve main module by hooking into various functions within Pages class, collecting data of performed operations, refining it and keeping up a log of events in it's own custom database table (process_changelog.) Visible part is managed by Process Changelog, which provides users a (relatively) pretty view of the contents of said log table.
      How do you use it?
      When installed this module adds new page called Changelog under Admin > Setup which provides you with a table view of collected data and basic filtering tools See attached screenshots to get a general idea about what that page should look like after a while.
      For detailed installation instructions etc. see README.md.
       


    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




×
×
  • Create New...