kongondo

Menu Builder

Recommended Posts

Update: Menu Builder 0.2.2

As of today and this version onward, ONLY ProcessWire 3.x is supported.

Changelog

  1. Support for namespaced ProcessWire only (ProcessWire 3.x).
  2. Various bug fixes to getMenuItems(), breadcrumbs and saving menus in multi lingual environments (thanks for all reports in GitHub and the forums).

Available now in the modules directory.

Please note that this version does not address any PHP 7.x issues.

Screen: Menu Builder in UiKit

mb-version-22-pw3-only-uikit-screen.thumb.png.b4e96d1003b0e4a0a7ccfe1d41073c8a.png

  • Like 1

Share this post


Link to post
Share on other sites
On 06/10/2017 at 10:16 AM, Zeka said:

Hi @kongondo

I have this setup: 

  • MenuItem1
    • Submenuitem_01( allowed children)
    • SubmenuItem_02 ( allowed children)
  • MenuItem2
    • Submenuitem_03 ( allowed children)
    • SubmenuItem_02 ( allowed children)

I'm using getMenuItems for building my menu, but the issue is that I get children of Submenuitem_02 as children only of the last Submenuitem_02 ( parent_id  =  id of the last Submenuitem_02 ), but I expected that I will get duplications of children pages with right parent_id for every Submenuitem_02

Of course, I can get children in my custom function but I think that in this case, getMenuItems doesn't work as expected and could be improved.

What do you think about it? 

Thanks, Eugene. 

Hi Eugene,

This is now sorted in version 022. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Hi @kongondo

my client (using a multi-language site) just created a page, that is not relevant to anyone outside of Germany and therefore deactivated the english Version with ProcessWires default settings ("Active?"-checkbox behind the page url in settings) and it seems like inactive pages do not disappear in navigations built with MenuBuilder.

Is there a way to solve this, that I just didn't see or do I have to work around this?

Kind regards,
Thomas

Share this post


Link to post
Share on other sites

@thmsnhl,

Just to clarify, are you saying you want the German version of the page to appear in the menu but not the English one? Meaning, if viewing the site in German, we see the page in the menu, if we view it in English, we don't. No, I've never considered such a scenario but now I see I should. If we are to skip that item from the menu, if it is a parent item, obviously, its children will also be skipped. 

Share this post


Link to post
Share on other sites

@kongondo,

this is exactly what I would like to do.
And yes, if it is a parent page, the whole branch would be invisible but I guess this is self-explanatory and maybe even a wanted behaviour in most cases. If you don't want English users to see the parent, most likely you don't want them to see the children too.

Share this post


Link to post
Share on other sites

@thmsnhl,

Could you please test the following for me before I commit? I have tested using both the normal way of generating menus (render()) and using the method getMenuItems(). I have also tested with include children and it works fine. As for include children, ProcessWire internally takes care of the inactive pages (I guess because it uses a find()), so I didn't have to touch that. 

In MarkupMenuBuilder.module, please add the following code after line # 216:

if(!$p->viewable($language)) continue;

Any issues?

Thanks.

Share this post


Link to post
Share on other sites

Update: Menu Builder 0.2.3

Changelog

  1. Fixed a bug where inactive pages in multi-language sites would still be displayed in menus. Thanks @thmsnhl

Available in modules directory.

Thanks.

  • Like 4

Share this post


Link to post
Share on other sites

There is another Problem with multi language, but I think this is more a general PW issue.

Steps to reproduce:

- Configure at least a second language in PW.

- As admin, work with the "other" language, not the default (Set in Admin->Profile).

- Create menus

- Switch back to default language (Set in Admin->Profile)

The titles are not set for the default language. (See screenshot).

It is the same problem when you create a field etc. in PW as a non standard language user.  The value for the default language is not being set.

mbbug.png.09f615b7f6d1affb9e1f993ac0a6b616.png

 

Share this post


Link to post
Share on other sites

@theo,

I'll have a look. I'm not sure about the ProcessWire side of things but MB itself does check for languages when installed in a multi-language site. It doesn't activate other languages when creating a menu (which are hidden pages in admin). Hence, when saving the menu it only saves the menu title as $page->title = 'My Menu'. Since no language is specified nor is there input for other languages, the title is saved to the current language's title field. When you switch to another language, there is no menu title to display since none was saved in the first place.

By the way, this is the reason why in multi-language sites, menus cannot be rendered using their titles or names. You need to pass render() the menu ID or page.

Back to the missing titles issue, it's an issue I have previously considered. Back then, I came to the conclusion that it was not worth having menu items with multi-lingual titles since I couldn't think of a scenario to justify it. Your use case demonstrates  that I need to revisit the issue. 

I'll work on this for the next version. When creating and editing menus, there will be inputs for the different languages that are available (creating) and for enabled languages (when editing) [difference here being no need to edit the title of a menu title if that language is not enabled for that menu]. 

Above means I'll have to change the way menus are created. It has been suggested before that MB should lose the textarea for input of menu titles (one-per-line). I think I'll go with a simple table (like the one used when adding custom menu items) with columns for each available language or a ul list or div with tabs for each available language (i.e., mimic ProcessWire's language title field). To create additional menus simultaneously, one would only have to click on an 'add another menu link/icon'.

This will also resolve the issue of rendering menu items using their titles in multi-language sites. If a menu title or name is passed to render(), we will look for a menu by that title in the user's language.

Sorry for the long post! Some of these are notes-to-self to be honest :P

Edited by kongondo
typos
  • Like 1

Share this post


Link to post
Share on other sites

dear kongondo, help the beginner:

two languages on the site
connected module 0.2.3

                    $menu = $modules->get('MarkupMenuBuilder');
                    $options = array(
                        'has_children_class' => 'has_children',
                        'current_class' => 'current',
                        'menu_css_id' => 'nav_home',
                        'menu_css_class' => 'slimmenu',
                    );
                    echo $menu->render('menu', $options);


1 language - everything is fine, 2 language:

Error: Exception: No menu items found! Confirm that such a menu exists and that it has menu items. (in /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module line 1415)

<code>#0 /var/www/***/site/modules/ProcessMenuBuilder/MarkupMenuBuilder.module(105): ProcessWire\MarkupMenuBuilder-&gt;throwError()</code><br />
<code>#1 /var/www/***/site/templates/home.php(24): ProcessWire\MarkupMenuBuilder-&gt;render(&#039;menu&#039;, Array)</code><br />
<code>#2 /var/www/***/wire/core/TemplateFile.php(287): require(&#039;/var/www/...&#039;)</code><br />
<code>#3 /var/www/***/wire/core/Wire.php(380): ProcessWire\TemplateFile-&gt;___render()</code><br />
<code>#4 /var/www/***/wire/core/WireHooks.php(714): ProcessWire\Wire-&gt;_callMethod(&#039;___render&#039;, Array)</code><br />
<code>#5 /var/www/***/wire/core/Wire.php(442): ProcessWire\WireHooks-&gt;runHooks(Object(ProcessWire\TemplateFile), &#039;render&#039;, Ar</code></b><br /><br /><small>This error message was shown because: you are logged in as a Superuser. Error has been logged. </small></p>


What did I want to do?

Share this post


Link to post
Share on other sites
23 minutes ago, duncan said:

What did I want to do?

It's all in the documentation here :). Please also read the last couple of post above yours.

Quote

Similar to render(), 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. This means that you only have to retrieve a menu once and pass that to both render() and renderBreadcrumbs()Note that for multilingual environments, you cannot pass the method a title or a name; only the other three choices will work

Since your site uses various languages, you need to pass render() either the ID of your menu, its Page object or an array of menu items. As per the post above yours, this limitation will be resolved in an upcoming update.

  • Like 2

Share this post


Link to post
Share on other sites

Hello all. It is my first time playing with MB and I am thrilled how simple it was to attache two menus (header and footer) to my current project. Now my goal is to have the menus in multilanguage and that is where something is still missing on my end. Reading carefully the manuals, I switched the rendering to menu IDs (getting them from the URL of the menu edit link) and both menus work fine. Presently I switched the default language to be Bulgarian and second - English. The issue I am having is that if I browse the default website: domain.com it shows everything in Bulgarian (which is fine). However if I point to domain.com/en/ it still shows the menu in Bulgarian instead of switching the page titles to the english version.

My menu structure is quite simple and I only added the MB to have a better understanding of its functionality so here is the structure:

-- Home
-- About
-- Services
---- Service 1
---- Service 2
---- Service 3
-- Portfolio
-- News
-- Contact us

To call the menu I am using the following rendering code:

//Building the array of options
$options = array(

'wrapper_list_type' => 'ul',// ul, ol, nav, div, etc.
'list_type' => 'li',// li, a, span, etc.
'menu_css_id' => 'menu-top-menu',// a CSS ID for the menu
'menu_css_class' => 'menu-item',// a CSS Class for the menu
'submenu_css_class' => 'sub-menu',// CSS Class for sub-menus
'has_children_class' => 'menu-item-has-children',// CSS Class for any menu item that has children
'current_class' => 'current-menu-item',
);

// load the module
$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
// Render the menu by title
echo $menu->render(1029, $options); // calling menu by ID to allow it on multilanguage site

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...

 

MenuBuilder-MultiLanguage.png

Share this post


Link to post
Share on other sites

@MilenKo

There are two routes how you can achieve ML menus with MB.

1. Create separate menu for every language and depending on user language pass different pages for menu render method.

2. Enable additional language for the menu ( Settings tab -> Other active languages for this menu) I think that it is what you are looking for.

  • Like 1

Share this post


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

Is there anything I am missing here? In the MB admin if I switch the language I see the links properly changing (for english it changes the path to /en/... but the titles are kept the same...

Alternatively, just use the 'default_title' option.

Quote

default_title: Controls whether to display Menu Builder saved menu item titles/labels versus displaying pages' actual/current titles. This is useful in scenarios where, for example, you need dynamic titles such as in a multilingual environment where you would want navigation labels to change depending on the current language. The default option is to display saved titles. To instead display actual titles, set option to 'default_title' => 1 in your options array.

Switch it to 1 and you are good to go (0 means show what has been saved in MB; 1 means show the actual ProcessWire page's title for that menu item).

Share this post


Link to post
Share on other sites

Thank you @Zeka and @kongondo

It seems as it was my mistake of having enabled Other active languages of the menu after I have added the pages and for some reason the language got the same in both. After disabling the option and reenabling it, I got the tabs for Default and English language texts so it is all good now and switching properly.

So to say, it is all working fine for multilanguage site out of the box as far as the person has taken the following steps:

1. Figure out the options array and apply the proper styling to the menu.

2. While rendering the menu, do not call the menu by name but use ID as the simplest thing to do (grab the URL from the menu edit link - id=XXXX where xxxx is the ID. In the instructions it was saying to call the menu using: 

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render('XXXX', $options);

However thanks to the community and the knowledge sharing here, I figured out how to fix it using the following:

$menu = $modules->get('MarkupMenuBuilder');// $menu is an example
echo $menu->render(XXXX, $options);

4. In order to enable multilanguage options, just go to Setup>Menu Builder. From there while creating or selecting an already created menu, click on the Settings tab and enable the languages you would like the menu to be translated to from the: Other languages for this menu option. Once this step is completted, every menu option would have separate tabs for every language selected.

5. Test the menu pointing to the website url in different languages, ex. /en/ , /ru/ , /de/ etc.

  • Like 2

Share this post


Link to post
Share on other sites

Hello,

does anybody know, if there is a possibility to only output a certain menu level or certain siblings in the menu?
Like the begin of a start-level?

 

F.e. start the output at level "sub":

- parent item 1

- parent item 2 (don't output this)

- - sub item 2.1 (only show / output this)

- parent item 3

 

Currently used version is V 0.1.3 with ProcessWire 2.7.2

Regards
Bacelo

Share this post


Link to post
Share on other sites

Hi @Bacelo,

Achievable from version 0.1.5 using the getMenuItems() method  (see examples here) or from version 0.1.8 using the 'disable menu items' feature. Please note that support for ProcessWire 2.x ceased with version 0.2.2. In your case, you can upgrade Menu Builder up to version 0.2.1. and you'll be fine. If you can though, I'd advise to upgrade to ProcessWire 3.x.

  • Thanks 1

Share this post


Link to post
Share on other sites

 

Hi @kongondo,

thanks a lot for you answer ^-^

PW upgrade to V 3.X is not an option currently, so how / where can I download Menu Builder V 0.2.1 ?

Regards
Bacelo

Share this post


Link to post
Share on other sites
Posted (edited)
1 hour ago, Bacelo said:

where can I download Menu Builder V 0.2.1 ?

From the repo. Browse the repository commits and click on the commit shown in the screenshot below:

mb-github-021-version.thumb.png.f04aa8e2a88584b4435d6dc10657114a.png

That will take you to the page where you can clone/download that version.

Edited by kongondo
added link to repo
  • Thanks 1

Share this post


Link to post
Share on other sites

Aaaah, didn't know that - thank you for your help!
^-^^-^^-^

Share this post


Link to post
Share on other sites

Hello, could someone may help me?

1. The menu builder just works fine but I am wondering if there is a way to have options for autocollapsing parts of the menu pathes as you can do with the module markup simple navigation? It would help me because my navigation is pretty large and I should not view the whole navigation tree after a fresh installation of the module.

2. The menu option "custom" works great for custom links but I have found no way to "import" a whole path of the processwire tree into the menu builder as you can do with the option "page". What could I do instead of getting all the menu items in just one by one?

3. I also tried first to use the "custom" option of the module for importing a whole items path and then switch over to the "custom" options but it seems not to be possible. 

May someone could help?

 

Share this post


Link to post
Share on other sites
On 6/4/2018 at 9:55 PM, bud said:

Hello, could someone may help me?

1. The menu builder just works fine but I am wondering if there is a way to have options for autocollapsing parts of the menu pathes as you can do with the module markup simple navigation? It would help me because my navigation is pretty large and I should not view the whole navigation tree after a fresh installation of the module.

2. The menu option "custom" works great for custom links but I have found no way to "import" a whole path of the processwire tree into the menu builder as you can do with the option "page". What could I do instead of getting all the menu items in just one by one?

3. I also tried first to use the "custom" option of the module for importing a whole items path and then switch over to the "custom" options but it seems not to be possible. 

May someone could help?

 

Hi @bud,


Welcome to the forums

  1. There is no auto-collapse option. You would have to code that yourself, e.g. using JavaScript. Maybe using the getMenuItems() method is best in this case.
  2. I don't understand this question. Please elaborate and/or illustrate
  3. I don't understand this question either.

 

 

 

Share this post


Link to post
Share on other sites

2.) and 3.) In the settings of menu builder there is an options where you can select more than one item getting added to the menu. Also there is an option you can select if you wanna have your menu tree go along with the normal processwire menu tree but that just seems to work with "page" and does not work with "custom".

Or in other words: I found no way to add a whole path( for example the items 1(parent), 1.1 (a child), 1.1.1 (a child of 1.1) ) to the menu builder when I use the custom option.

I could add every item I want but only one by one.

1.) do you have some code to share related to your default menu tree (which uses just your css) where the menu tree just opens the part of the tree which is active (for example: one parent and their children should be open and everything else closed 

At last: If you have the right you could delete the post above because it is a duplicate of my original post and was not intended.

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 bernhard
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      180817, v1.0.6, support for joining multiple finders 180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By OLSA
      Hello for all,
      ConfigurationForm fieldtype module is one my experiment from 2016.
      Main target to build this module was to store multiple setup and configuration values in just 1 field and avoid to use 1 db table to store just single "number of items on page", or another db table to store "layout type" etc. Thanks to JSON formatted storage this module can help you to reduce number of PW native fields in project, save DB space, and reduce number of queries at front-end.
      Install and setup:
      Download (at the bottom ), unzip and install like any other PW module (site/modules/...). Create some filed using this type of field (ConfigurationForm Fieldtype) Go to field setup Input tab and drag some subfields to container area (demo). Set "Name" and other params for subfields Save and place field to templates ("Action tab") How to use it:
      In my case, I use it to store setup and configurations values, but also for contact details, small content blocks... (eg. "widgets").
      Basic usage example:
      ConfigForm fieldtype "setup" has subfields:
      "limit", type select, option values: 5, 10, 15, 20
      "sort", type select, option values: "-date", "date",  "-sort", "sort"
      // get page children (items) $limit = isset($page->setup->limit) ? $page->setup->limit : 10; $sort = isset($page->setup->sort) ? $page->setup->sort : '-sort'; $items = $page->children("limit=$limit, sort=$sort");  
      Screenshots:


       
      Notes:
      Provide option to search inside subfields Provide multilanguage inputs for text and textarea field types Provide option for different field layout per-template basis Do not place/use field type "Button" or "File input" because it won't works. Please read README file for more details and examples Module use JSON format to store values. Text and textarea field types are multilanguage compatible, but please note that main target for this module was to store setup values and small content blocks and save DB space. Search part inside JSON is still a relatively new in MySQL (>=5.77) and that's on you how and for what to use this module.
      Thanks:
      Initial point for this fieldtype was jQuery plugin FormBuiled and thanks to Kevin Chappel for this plugin.
      In field type "link" I use javascript part from @marcostoll module and thanks to him for that part.
      Download:
      FieldtypeConfigForm.zip
      Edit: 14. August 2018. please delete/uninstall previously downloaded zip
      Regards.
         
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By Thomas Diroll
      Hi guys I'm relatively new to PW and just finished developing a page for a client. I was able to include all necessary functionality using the core fieldtypes but now I it seems that I need to extend them with a custom one. What I need is a simple button, that copies the absolute url (frontend not PW-backend) of the page which is currently edited to the clipboard. As this feature is only needed inside a specific template, I tend to use a custom fieldtype which provides this feature. I've been looking inside the core modules code (eg. FieldtypeCheckbox.module) but I don't really get the structure of it and how its rendered to the admin page. I also didn't find a lot of tutorials covering custom fieldtypes.
      Maybe some of you could give me some tips on how to write a basic custom fieldtype that renders a button which copies the value of
      page->httpUrl() to the clipboard using JS. Thanks!
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/RockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour.
       
      Changelog
      180730 support subdir installations 180711 bugfix (naming issue) 180630 alpha realease  
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module: