Jump to content
kongondo

Menu Builder

Recommended Posts

Thanks guys,

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">

Will look into it. Should be easy enough using $options

It would be nice to have compatibility for the <nav> tag - I use them in my menus instead of unordered lists.

On my to do list: See $options.

Also, I should be able to add a class and/or an ID to each menu.

You can already do this:

$options = array('menu_css_id' => 'main', 'menu_css_class' => 'navigation');
$menu = $modules->get('MarkupMenuBuilder')->render(1234, $options);

Am I missing something?

Will update docs later...

Btw, one is not tied to using MarkupMenuBuilder -> you can easily json_decode($menuItemsJSON, true) the menu items JSON and recursively traverse the resultant array using a custom PHP function or even with javascript.

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites

Not a massive problem but I noticed that if I change the menu name that it doesn't render with the new name.

Share this post


Link to post
Share on other sites

In my testing, outputting the menu is already fast enough. However, one other thing I need to experiment with is caching the menu templates or menu_items field and see if it can be even faster...

Share this post


Link to post
Share on other sites

You're using tabs in your code, for constancy using spaces is better.

Thanks for creating this kongondo.

  • Like 1

Share this post


Link to post
Share on other sites

Not a massive problem but I noticed that if I change the menu name that it doesn't render with the new name.

That's because at the moment, when you change the menu 'Title', only the title gets changed and not the name (i.e. on the PW page). In rendering using a title or name, it looks for the name. In that case, your new title would be first converted to a name and the module would look for a menu page with that name, which would obviously not exist (since name was not changed). Rendering by ID would still work though. But, I see no reason why I should not change this behaviour. I will make it change the name to match the title as well to be foolproof. Since menu pages are not visible in the frontend and are not really for querying, there is no harm in that. Thanks for the suggestion.

ps: If possible, could you file feature requests at the project page in Github? I won't have time to work on this today and might forget some things, thanks.

  • Like 1

Share this post


Link to post
Share on other sites

You can already do this:

$options = array('menu_css_id' => 'main', 'menu_css_class' => 'navigation');
$menu = $modules->get('MarkupMenuBuilder')->render(1234, $options);

Ah, right - missed that one. Don't think anything else is missing. I can already use this for a number of sites as it is. :-)

Share this post


Link to post
Share on other sites
  1. It would be nice to have compatibility for the <nav> tag - I use them in my menus instead of unordered lists.

@Mike,

Could you clarify the sort of HTML structure you envisage? With <nav> only, how do you show sub-menus? i.e.

<nav>
   <a href="link-1">Link One</a>
   <a href="link-2">Link Two</a>
   <a href="link-3">Link Three</a>
   <a href="link-4">Link Four</a>
</nav>

Share this post


Link to post
Share on other sites

I generally follow something like this - an example from a recent site release:

<nav role="mainMenu">
	<li><a data-current href="/">Home</a></li>
	<li class="hasDrop"><a href="/who-we-are">Who We Are</a>
		<ul class="theDrop">
			<li><a href="/who-we-are">Overview & Mission</a></li>
			<li><a href="/who-we-are/certification">Our Certification</a></li>
			<li><a href="/who-we-are/management-board-staff">Management Board & Staff</a></li>
		</ul>
	</li>
	<li><a href="/what-we-do">What We Do</a></li>
	<li><a href="/connect">Connect</a></li>
	<li><a class="donate" href="/donate">Donate to our Cause</a></li>
</nav>

Essentially, I'm swapping out <ul> for <nav>.

But now that you mention it, I do see that not everyone does it that way. Some prefer to wrap their <ul> inside <nav>. Some people prefer to do it like your example. Thing with <nav> is that there is no predefined way of doing it...

Now that I'm actually looking at this, I should probably be using <ul> inside <nav>... I dunno. HTML5 went and confused things...

Share this post


Link to post
Share on other sites

Officially it isn't allowed to use <nav> as list-item container. Only <ul>, <ol> or <menu> element as parents are allowed for li elements. The last one <menu> I've never seen used in the wild before. The <nav> element I find rather confusing to. I use the nav element mainly as a wrapper element for navigation elements or leave them out if I do not need them for styling. So mainly I use it for wrapping main navigation elements and that is search form input(s) included.

Share this post


Link to post
Share on other sites

What Martijn said...

You can wrap you whole menu with <nav> like this:

$options = array('menu_css_id' => 'main', 'menu_css_class' => 'navigation');
$menu = $modules->get('MarkupMenuBuilder');

$out = '<nav>' . $menu->render(1234, $options) . '</nav>';

In that case, the menu will use the specified list type, <ul> default or <ol>

However, if in $options you specify: 'wrapper_list_type' => 'nav', then, in order to output correct markup, MB will not wrap menu items in <li> but only <a> unless you also specified in $options some other tag other than <li>, e.g.  'list_type' => 'span'

What do you guys think?

  • Like 1

Share this post


Link to post
Share on other sites

Officially it isn't allowed to use <nav> as list-item container. Only <ul>, <ol> or <menu> element as parents are allowed for li elements. The last one <menu> I've never seen used in the wild before. The <nav> element I find rather confusing to. I use the nav element mainly as a wrapper element for navigation elements or leave them out if I do not need them for styling. So mainly I use it for wrapping main navigation elements and that is search form input(s) included.

I see. I know that <menu> is really for context menus... to be filled with <menuitem>s.

I've never really been one for standards. To me, my method is easier to understand. Maybe not for everyone else. I tend to believe that if it works well, use it. One of the reasons I use <nav> instead of <ul> is that I don't need to remove the left margin. Granted, that's a small thing, but it just feels better do do it that way. Also, that example depends on what CSS framework/reset is being used.

I think that a little flexibility would be cool. Otherwise, I'll use the method suggested. (Won't hurt much at all  :P )

Share this post


Link to post
Share on other sites

I see. I know that <menu> is really for context menus... to be filled with <menuitem>s.

I've never really been one for standards. To me, my method is easier to understand. Maybe not for everyone else. I tend to believe that if it works well, use it. One of the reasons I use <nav> instead of <ul> is that I don't need to remove the left margin. Granted, that's a small thing, but it just feels better do do it that way. Also, that example depends on what CSS framework/reset is being used.

I think that a little flexibility would be cool. Otherwise, I'll use the method suggested. (Won't hurt much at all  :P )

I like it. I never used it this way but actually makes sense in one way but in another way it kind of confuses things when using nested lists with ul.

Maybe if there was something like a <subnav> element it would  make more sense.

Share this post


Link to post
Share on other sites

I like it. I never used it this way but actually makes sense in one way but in another way it kind of confuses things when using nested lists with ul.

Maybe if there was something like a <subnav> element it would  make more sense.

If I had a say in the matter, I'd probably go for <item> (for plain ol' items) and <subnav> (for sub-menus).

  • Like 1

Share this post


Link to post
Share on other sites

Update: version 0.0.3

Updated original post.

Now in modules directory:

  • Option to allow Markup in menu items as per this request (superusers only) [note: although values are sanitized via HTML Purifier, it is your responsibility to ensure correct HTML input; also, if you previously allowed HTML markup but the menu was subsequently edited by non-superusers, your HTML will be stripped off]
  • Added more options to MarkupMenuBuilder render() method - first, last classes, etc.(see Read Me) and...
  • Added/enhanced wrapper_list_type and list_type options. The former allows you to specify menu items outer wrapper tag, e.g. <ol>, <div>, <nav>, etc....The latter allows you to specify alternatives to <li>, e.g. <span>. Note, if no list_type is specified and you override the default by 'list_type' => '' in your options, then menu items css classes/IDs are applied to the <a> tag instead.
  • Updated code to ensure menu settings saved by superusers remain even for non-superusers (e.g. menu maxLevels, selectable pages, etc.)

Note: Had an extra  jquery.asmselect-mb.js in the root folder. I have deleted this in the repository.

Note, it seems PageAutocomplete will not allow non-superusers to select pages unless they have a page-edit permission as well. Could somebody confirm/clarify? Thanks.

Edited by kongondo
  • Like 8

Share this post


Link to post
Share on other sites

Note, it seems PageAutocomplete will not allow non-superusers to select pages unless they have a page-edit permission as well. Could somebody confirm/clarify? Thanks.

Yes I see that as well. Not sure if this is related to some other permission but 'selector' doesn't appear as well even with page-edit permission.

The rest works great.

Share this post


Link to post
Share on other sites

Selector not appearing is by design (seems I added that to the ReaMe only and not the OP). Currently, it is only visible to superusers although was wondering whether to make that permission-based as well...could be user created permission that would be stored together with the menu's settings...

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

Selector not appearing is by design (seems I added that to the ReaMe only and not the OP). Currently, it is only visible to superusers although was wondering whether to make that permission-based as well...could be user created permission that would be stored together with the menu's settings...

Always good to have the option.

  • Like 1

Share this post


Link to post
Share on other sites

I just have to chime in with nothing helpful other than to say how thrilled I am to see this. This is going to be such a fantastic tool for content creators. 

  • Like 4

Share this post


Link to post
Share on other sites

Always good to have the option.

OK...on my TODO. I have expanded it to other features, not just the selectors. See this also. What are your thoughts about controlling ability to delete menus too? Any other controls I am missing? Thanks.

  • Like 2

Share this post


Link to post
Share on other sites

OK...on my TODO. I have expanded it to other features, not just the selectors. See this also. What are your thoughts about controlling ability to delete menus too? Any other controls I am missing? Thanks.

That would be useful as well. I can't think of anything else at the moment.

Share this post


Link to post
Share on other sites

Update: version 0.0.4

Added 7 permissions to control visibility/access to advanced settings by non-superusers as discussed above. Currently this is only available for testing in Menu Builder dev branch.

Note that you have to create the permissions yourself and add them to a role. Please thoroughly read the updated README about how to use these permissions; depending on your situation, you may not have to create any of the permissions.

In summary, these control:

  1. Locking/unlocking menus (menu-builder-lock)
  2. Trashing and deleting menus (menu-builder-delete)
  3. Use of selectors to add pages as menu items (menu-builder-selector)
  4. Use of markup/HTML in menu item titles/labels (menu-builder-markup)
  5. Specifying of PW pages that are selectable as menu items in the page fields AsmSelect and PageAutocomplete (menu-builder-selectable)
  6. Editing of nestedSortable settings, e.g. maxLevels (menu-builder-settings)
  7. Ability to change the page field (AsmSelect vs PageAutocomplete) to be used when selecting PW pages to add as menu items (menu-builder-page-field)

Please test and let me know, thanks.

  • Like 5

Share this post


Link to post
Share on other sites

Just a thought and I am not sure how much this is needed but I am thinking about rendering breadcrumbs and wondering what would be the best way to render breadcrumbs based on the menu structure. Maybe I didn't think about it enough but there seems to be a possibility of complications rendering breadcrumbs when the menu structure is different to page structure.

Is there some way to have a feature whereby breadcrumbs could be output based on the menu structure with of course homepage being one step higher in the hierarchy of pages that are on the same level.?

  • Like 1

Share this post


Link to post
Share on other sites

I'm busy moving a site over to PW, and using MenuBuilder for the main nav. Unfortunately, I'm getting this markup:

<ulclass ="navigation">
<li  class=" current"><a  href='/'>Welcome</a></li>
...
</ul>

Which is broken... Would it not be better to use some kind of HTML builder? Perhaps something like this?

Share this post


Link to post
Share on other sites

I'm busy moving a site over to PW, and using MenuBuilder for the main nav. Unfortunately, I'm getting this markup:

<ulclass ="navigation">
<li  class=" current"><a  href='/'>Welcome</a></li>
...
</ul>

Which is broken... Would it not be better to use some kind of HTML builder? Perhaps something like this?gh

We'll that's strange...I thought I had dealt with this.....Old code must have crept in. I'll look into it, thanks for reporting. No need for the HTML builder :-)....for the <ul, it's just a missing space I forgot to put back after switching to configurable menu wrapper and for the <li> just a space to trim...I'll update tonight...

Edited by kongondo

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 jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      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/FieldtypeRockGrid
      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
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      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 (please contact me via PM).
       
      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:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...