Jump to content
kongondo

Menu Builder

Recommended Posts

Hey @kongondo I just recently came across this module in a existing PW project I had to take over. I knew about it's existence but never tried it myself. Great and useful features, thanks!

 

  • Like 1

Share this post


Link to post
Share on other sites

Update: Menu Builder Version 0.1.6.

Changelog

  1. Fixed a JS issue that stopped 'select all' checkbox from working in Menu Builder dashboard
  2. Fixed InputfieldMarkup issue that prevented HTML in description not to be properly rendered. Thanks @Jonathan Lahijani and @Michael van Laar
Menu Builder is now PW2.8 + PW3.x compatible! (first one of mine off the blocks!)
  • Like 4

Share this post


Link to post
Share on other sites

Hi,

Great module - it's just what I needed!

However, I'm encountering a weird issue with some menu item titles.

If a menu item title contains an apostrophe/single-quote, the characters following (and including) the apostrophe are removed after saving the menu.

For example, the title "What's On" becomes "What".

It's ok if it is the initial save after adding that menu item, the apostrophed title is saved to the db, but it is subsequent saves that remove it.

It appears the characters are stripped when the title is displayed in Menu Builder's menu item editor widget.

Currently, the work around is to just retype each menu item that gets stripped before saving each time.

Using:
Menu Builder:  ver. 0.1.6
Processwire:     ver. 3.0.47

  • Like 2

Share this post


Link to post
Share on other sites

Update: Menu Builder Version 0.1.7.

Changelog

  1. Fixed a bug that caused titles of menu items with apostrophes not to display properly in menu settings. Thanks @LMD
  2. Code cleanup and refactoring.
  • Like 2

Share this post


Link to post
Share on other sites
13 minutes ago, kongondo said:

Update: Menu Builder Version 0.1.7.

Changelog

  1. Fixed a bug that caused titles of menu items with apostrophes not to display properly in menu settings. Thanks @LMD
  2. Code cleanup and refactoring.

Gosh that was quick. Works a charm. Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Hello,

I recently installed MB on my multi-language's website in progress. I'm quite sure it was working in both languages. But since couple of days, I noticed this error

 

Exception: No menu items found! Confirm that such a menu exists and that it has menu items. (in /multimedia/sites/dev-wire/site/assets/cache/FileCompiler/site/modules/MarkupMenuBuilder/MarkupMenuBuilder.module line 961)

#0 /multimedia/sites/dev-wire/site/assets/cache/FileCompiler/site/modules/MarkupMenuBuilder/MarkupMenuBuilder.module(88): MarkupMenuBuilder->throwError()
#1 /multimedia/sites/dev-wire/site/templates/_main.php(194): MarkupMenuBuilder->render('main', Array)
#2 /multimedia/sites/dev-wire/wire/core/TemplateFile.php(276): require('/multimedia/sit...')
#3 /multimedia/sites/dev-wire/wire/core/Wire.php(374): ProcessWire\TemplateFile->___render()
#4 /multimedia/sites/dev-wire/wire/core/WireHooks.php(698): ProcessWire\Wire->_callMethod('___render', Array)
#5 /multimedia/sites/dev-wire/wire/core/Wire.php(402): ProcessWire\WireHooks->runHooks(Object(ProcessWire\TemplateFile), 'render', Array)
#6 /multimedia/sites/dev-wire/wire/modules/PageRender.module(514): ProcessWire\Wire->__call('render', Array)
#7 /multimedia/sites/dev-wire/wire/modules/PageRender.module(514): ProcessWire\TemplateFile->render()
#8 [internal function]: ProcessWire\PageRender->___renderPage(Object(ProcessWire\HookEvent))
#9 /multimedia/sites/dev-wire/wire/core/Wire.php(376): call_user_func_array(Array, Array)
#10 /multimedia/sites/dev-wire/wire/core/WireHooks.php(698): ProcessWire\Wire->_callMethod('___renderPage', Array)
#11 /multimedia/sites/dev-wire/wire/core/Wire.php(402): ProcessWire\WireHooks->runHooks(Object(ProcessWire\PageRender), 'renderPage', Array)
#12 /multimedia/sites/dev-wire/wire/core/WireHooks.php(782): ProcessWire\Wire->__call('renderPage', Array)
#13 /multimedia/sites/dev-wire/wire/core/WireHooks.php(782): ProcessWire\PageRender->renderPage(Object(ProcessWire\HookEvent))
#14 /multimedia/sites/dev-wire/wire/core/Wire.php(402): ProcessWire\WireHooks->runHooks(Object(ProcessWire\Page), 'render', Array)
#15 /multimedia/sites/dev-wire/wire/modules/Process/ProcessPageView.module(205): ProcessWire\Wire->__call('render', Array)
#16 /multimedia/sites/dev-wire/wire/modules/Process/ProcessPageView.module(205): ProcessWire\Page->render()
#17 [internal function]: ProcessWire\ProcessPageView->___execute(true)
#18 /multimedia/sites/dev-wire/wire/core/Wire.php(376): call_user_func_array(Array, Array)
#19 /multimedia/sites/dev-wire/wire/core/WireHooks.php(698): ProcessWire\Wire->_callMethod('___execute', Array)
#20 /multimedia/sites/dev-wire/wire/core/Wire.php(402): ProcessWire\WireHooks->runHooks(Object(ProcessWire\ProcessPageView), 'execute', Array)
#21 /multimedia/sites/dev-wire/index.php(55): ProcessWire\Wire->__call('execute', Array)
#22 /multimedia/sites/dev-wire/index.php(55): ProcessWire\ProcessPageView->execute(true)
#23 {main}

I'm currently running PW 3.0.50, but I'm unable to say what version it was when I previously installed.

I have 2 menus, but removing one or the other give the same error.

I call my menu by

    $options = array(
                        'wrapper_list_type' => 'ul',//ul, ol, nav, div, etc.
                        'menu_css_class' => 'topnav',//a CSS Class for the menu
                        'current_class' => 'active',
                            );
                            
                            
                            $menu = $modules->get('MarkupMenuBuilder');//Load the module. $menu is an example
                            echo $menu->render('main', $options);
                            

Do I doing something wrong?

Share this post


Link to post
Share on other sites

@mel47,

Please see this note on how to call a menu in a multi-lingual environment:

Quote

....The first argument is not optional and can be a Page object, a title, name or id of a menu or an array of menu items returned from a menu's menu_items field. Note that for multilingual environments, you cannot pass the method a title or a name; only the other three choices will work

If that doesn't resolve your issue, try refreshing your file compiler cache.

  • Like 2

Share this post


Link to post
Share on other sites
1 hour ago, kongondo said:

@mel47,

Please see this note on how to call a menu in a multi-lingual environment:

If that doesn't resolve your issue, try refreshing your file compiler cache.

Oh, my, my... I read it but it appears I didn't completely understood...

So solve my problem by replace with

$menu = $modules->get('MarkupMenuBuilder');//Load the module. $menu is an example
$m = $pages->get(2359);
echo $menu->render($m, $options);

 

Share this post


Link to post
Share on other sites

Hello, me again.

I've encountered another issue with Menu Builder.

This time it's related to HTML in the titles. I wanted to add FontAwesome icons to a menu, so enabled "Allow HTML in menu items title" in the settings for the menu.

I then added the FontAwesome code to the title field, like this:

pw-menubuilder-htmlprob01.jpg

When I saved the menu, it went weird and broke the editor widget (n.b. it's the same outcome using either single or double-quoted attributes):
pw-menubuilder-htmlprob02.jpg

Like the previous issue, the title does save to the DB (and when I looked at a frontend page, it showed the icon as it should), but when I tried to save the page again, the broken menu item completely disappeared (is not saved to the DB at all) and I had to add it again.

I think the menu editor widget doesn't like the HTML attributes, because it works fine with plain HTML elements without attributes.

Current Workaround:

Add a CSS class to the list item wrapper and manually add the FontAwesome icon in the site stylesheet.

Using:

Processwire:   ver 3.0.50
MenuBuilder: ver 0.1.7
 

 

Share this post


Link to post
Share on other sites

@LMD. Thanks for reporting. I haven't been able to find a suitable solution for this. The issue is the quotes are tripping up the input value. Have a look at the markup in page source; you will see class="" is output but the HTML breaks since we have something like value="<i class="fa fa-home">". For now (and for any complex menus), I suggest you use the approach posted here, whereby you will have total control over your menu items' structure and styling. 

Edited by kongondo

Share this post


Link to post
Share on other sites

@kongondo Thanks, I  got the menu working with a custom menu builder functions.

I couldn't help myself from digging around the in the the module code, though :).  I think I've found what seems to be a fairly simple solution to the quoted attributes breaking the form output.

In ProcessMenuBuilder.module, on line num. 1111:

https://github.com/kongondo/MenuBuilder/blob/bfc032cb3a07b65e732469b16b5286563bd709e9/ProcessMenuBuilder.module#L1111

Change:

<input type="text" value="' . $title . '" name="item_title[' . $id . ']" class="menu_settings" id="item_title' . $id . '">

To:

<input type="text" value="' . htmlentities($title) . '" name="item_title[' . $id . ']" class="menu_settings" id="item_title' . $id . '">

The htmlentities() function deals with the issue of quotes breaking the form input.

I've tested it on my site and it seems to be working just fine. The icons display in the front-end and the admin widget item label, and the code displays in the item's title edit field after being saved.

I don't know if I've missed anything though?

 

  • Like 2

Share this post


Link to post
Share on other sites

hello friends,

I have few children pages under a parent page.  i want to show that children page under two parents page in Main menu as well as in breadcrumbs.

With the help of menu builder main menu show same childern page under both the parents, but Breadcrumbs follow the page tree structure.

how can i get the expected result?

thank you.

Share this post


Link to post
Share on other sites

Welcome to the forums @Sahil. I have moved your topic to 'General Support'. If however, you are referring to the module Menu Builder, I will move your topic to its support forum and answer you question there. Please confirm.

Share this post


Link to post
Share on other sites
20 minutes ago, Sahil said:

I have few children pages under a parent page.  i want to show that children page under two parents page in Main menu as well as in breadcrumbs.

With the help of menu builder main menu show same childern page under both the parents, but Breadcrumbs follow the page tree structure.

how can i get the expected result?

I'll have to study this first. It's been a while since I developed the Breadcrumb component of Menu Builder :).

  • Like 1

Share this post


Link to post
Share on other sites

Love the module! I was wondering if there was a way to add Schema.org markup support for the menus? If you look at "Site Navigation Schema Markup" on this site, you'll see that there is markup that should be added to get menu pages to show up with Google results. I would like to take advantage of this. Given the simplicity of the markup, I feel if it were to be put into this module, that it would make sense to enable with a checkbox on each separate menu created. (So I would enable on the "main" menu, but not the menu on the footer, if that makes sense.) Thanks!

EDIT:
I ended up hand-coding it into MarkupMenuBuilder.module at lines 367 and 368, which is good and achieves the proper result (and validation) but unfortunately creates 2 schema menus...there is a menu on top and one at the footer. I only want one schema menu, which is the longer one in the footer. I knew going in that it would likely do that, but it's certainly preferable that it doesn't. Also, when the module gets updated, it will wipe that out and it'd have to be done again. If this could be built in that would be great. BTW, I'll attach my code below (and my neurosis prefers double quotes in rendered HTML rather than single ;))...
 

if(!$iTag) $out .= "\n\t<a{$itemCSSID}{$class}{$newtab} href=\"{$m->url}\" itemprop=\"url\">{$m->title}</a>";
else $out .= "\n\t<{$iTag}{$itemCSSID}{$class} itemprop=\"name\">\n\t\t<a{$newtab} href=\"{$m->url}\" itemprop=\"url\">{$m->title}</a>";

 

Edited by Standard Forge
Hand coded part of my request

Share this post


Link to post
Share on other sites

@Standard Forge, Glad you find the module useful :).

On 17/02/2017 at 11:24 PM, Standard Forge said:

I ended up hand-coding it into MarkupMenuBuilder.module at lines 367 and 368, which is good and achieves the proper result (and validation) but

 As you point out, that's a bad idea :P. For complex or custom menus, there's a better way to achieve the result you want. I decided not to add any more features such as these to MenuBuilder (including "Bootstrap does this or that"...sort of requests). Instead, since a while back, Menu Builder now provides an API that will return your menu items allowing you greater control over their output. This is done via the method getMenuItems(). Please find detailed examples in this post. Grab one and edit it to suit your needs. Let us know how you get along.

Share this post


Link to post
Share on other sites


@Standard Forge, if you just want to make one or two minor changes to a rendered menu without having to build all the markup yourself (using getMenuItems()), you can do a quick str_replace.

Example:

$menu = $modules->get('MarkupMenuBuilder');

// cache the rendered menu
$schema_menu = $menu->render('my-menu-name');

// alter the rendered menu to your desire
$schema_menu = str_replace('<li ', '<li itemprop="name" ', $schema_menu);
$schema_menu = str_replace('<a ', '<a itemprop="url" ', $schema_menu);

// output the altered menu
echo $schema_menu;

Quick and dirty, I know. But if you are using delayed output anyway, it’s just one or two lines of code.

  • Like 1

Share this post


Link to post
Share on other sites

Hi, 

I don't want to list pages that aren't listable by the current user in the menu. I fixt it by adding an if statement on line 192 of MarkupMenuBuilder.module:

if($this->wire('pages')->get($m->pagesID)->listable()){
	$menu->add($m);
}

Is there a better way to do this? In a hook or a setting that I have missed? :)

Share this post


Link to post
Share on other sites
2 hours ago, Peejay said:

I don't want to list pages that aren't listable by the current user in the menu

Cool idea :).

2 hours ago, Peejay said:

Is there a better way to do this?

Yes; please file a feature request, thanks.

2 hours ago, Peejay said:

In a hook or a setting that I have missed?

No need for a hook. We can simply pass an option [which I'll create] to render(). However, this will not be as straightforward as it looks. What if that unlistable menu item has children, especially ones that are custom menus? We can't leave them parentless. They will have to be removed. Such a potential situation won't always be apparent at the editing stage; editors could unknowingly create a hierarchy that will break if the option to not list menu items is applied. Please file a request and I'll have a think.

  • Like 2

Share this post


Link to post
Share on other sites

Great module.

Any plans for an enable/disable option on a menu item? Maybe a way to change a menu from one type to another? I feel like this would make it more useable by an end-user.

Share this post


Link to post
Share on other sites

Glad you like the module @cjx2240

16 minutes ago, cjx2240 said:

Any plans for an enable/disable option on a menu item?

Do you mean if disabled menu item does not show in the frontend? What's the use case? Why not just not add that menu item? 

 

16 minutes ago, cjx2240 said:

Maybe a way to change a menu from one type to another?

I don't follow. Please explain.

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful, developer-first 3rd party 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! 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-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 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      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 (open spoiler):
      (Please note: these screenshots are from an early development state of SnipWire. To see actual screens please have a look at later posts below!)
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      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 Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...