Jump to content
kongondo

Menu Builder

Recommended Posts

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.

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

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

I guess I'm just a sucker for clean code.  ;)

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.?

Hmm, interesting thought. Technically, it is not impossible - just a recursive function that only grabs one branch...I'll have think...

Share this post


Link to post
Share on other sites

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

I guess I'm just a sucker for clean code.  ;)

I'm all for clean and valid HTML too...What I meant is that I forgot to put back a space when I went from this <ul to this <$wTag.....bundling a third-party PHP class just to deal with that seems like an overkill :-)

Share this post


Link to post
Share on other sites

I'm all for clean and valid HTML too...What I meant is that I forgot to put back a space when I went from this <ul to this <$wTag.....bundling a third-party PHP class just to deal with that seems like an overkill :-)

Yeah, I figured that. Just mentioned it because of the general output. To me, it isn't overkill if it's to be used to enhance everything the module outputs. Much the same way I used ParseCSV in Jumplinks - I wanted the flexibility it provides, which enhances the experience.

:-)

Share this post


Link to post
Share on other sites

Wait, I'm not using the dev branch. Whoops... (unless it was patched in the one you get from the directory?)

Aaah, ye that's it. It works fine in dev branch. Please test and let me know? Thanks. I tested thoroughly with different combinations of multiple classes. I want to merge to master later today.

Share this post


Link to post
Share on other sites

I downloaded this archive, and it's still sticking ul and class together, unless I use an id.

Using 

<?= $modules->MarkupMenuBuilder->render('main', array('menu_css_class' => 'navigation')); ?>

Result:

<ulclass ="navigation">
<li  ><a  href='/'>Home</a></li>
...
</ul>

Edit: Culprit seems to be line 185 of MarkupMenuBuilder on in the archive I grabbed.

$cssMenuClass = $options['menu_css_class'] ? 'class ="' . $options['menu_css_class'] . '"' : '';

Share this post


Link to post
Share on other sites

Thanks, will fix soon. As for the <li>, it works fine for me...are you seeing that extra space (as in your code above...)?

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, will fix soon. As for the <li>, it works fine for me...are you seeing that extra space (as in your code above...)?

The code is as I pasted it.

post-2289-0-60312500-1426615972_thumb.pn

(Except the ul thing, which I changed.)

Share this post


Link to post
Share on other sites

Update: version 0.0.5

  • Fixed markup errors reported above in MarkupMenuBuilder
  • Merged version to master (updated in modules directory as well)
Edited by kongondo
  • Like 3

Share this post


Link to post
Share on other sites

Hmm, interesting thought. Technically, it is not impossible - just a recursive function that only grabs one branch...I'll have think...

Great. Would be cool to have this feature.

Share this post


Link to post
Share on other sites

Very nice, a must-have. Thanks!

May I ask what admin theme was used on the screenshots? Looks pretty sharp but cannot find anywhere.

  • Like 1

Share this post


Link to post
Share on other sites

@tpr,

Thanks.

They are all part of the admin themes that natively ship with PW. In the first couple of screenshots, that's AdminThemeReno, followed by AdminThemeDefault using the color set 'Futura' and last screen the color set 'Warm'.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, I got it now. It was the Reno theme, it has to be installed first to use. Have to do some PW development soon to get back to PW basics :)

Share this post


Link to post
Share on other sites

Update: version 0.0.6

In dev branch for now

  1. As per this idea, thanks @dazzyweb, added a renderBreadcrumbs() method to render, uh..., breadcrumbs. See documentation in Read Me for how to use
  2. For both render() and renderBreadcrumbs(), you can also pass a Page object as the first parameter. This is in addition to the already available ways, i.e. you can also pass a menu page's title, name or id or an array of menu items built from a menu page's menu_items field.

Please test and let me know, especially playing around with the options you can pass renderBreadcrumbs(). See Read Me, including comments in the code. These options can be shared between the above two methods. Same goes for the first parameters - e.g. get a menu page and pass that once to both render() and renderBreadcrumbs(). Also added the option to prepend 'Homepage' as topmost breadcrumb item even when it is not ancestrally part of the breadcrumb.

Note

If you call renderBreadcrumbs() in a page that is not part of the menu items you will get an error if logged in as superadmin but nothing returned for all other users. E.g., say you have the following menu items:

Home
About Us
Products
Services
Contact Us

renderBreadcrumbs() would only work (duh!) if called from the template file of AND viewing one of those pages. This is because the method works by first matching the 'pages_id' of a menu item with the $page->id (current page) and builds the breadcrumb from that.

External menu items can be part of the breadcrumb as long as they are not the current item (of course) - which they can never be anyway since clicking on them will load external URLs

  • Like 3

Share this post


Link to post
Share on other sites

Thanks kongondo, seems to work fine but I have one or 2 queries or suggestions for a couple of issues I have.

There are times when it would be useful to display breadcrumbs for pages that are not in the main header menu created. Do you think there is a way around this with some kind of option?

So as a simple example if we have the following menu created with Menu builder:

HOME

ABOUT

-who are we?

-Our history

FAQ

CARS

CONTACT

ABOUT page would have children in the menu created and work fine with the renderBreadcrumbs method.

'CARS' would have 50 children in the page tree but I might not want to show these children as a sub menu so they would not be included in the menu created but I might still want to show breadcrumbs if going to the page 'Audi' or 'Jaguar' such as Home / Cars / Jaguar which could have been accessed from some different link or list.

Do you think it is possible to have some kind of option whereby the breadcrumbs or normal render method  recognises the children of the 'CARS' page in the normal pages tree without actually having them in the menu created by menu builder?

Another point connected with this is if I am at the page Jaguar (Home / cars / Jaguar) it would be useful with the normal menu render method to be able to still add a 'current' class to 'CARS' in the menu so it could still be highlighted as the parent page even though the page Jaguar is not in the menu created with menu builder. It would also be useful to be able to add a 'current' class to ABOUT page when viewing sub pages of the ABOUT page which are in the menu created by Menu builder.

Share this post


Link to post
Share on other sites

@dazzyweb,
 
OK, I might have found a way to achieve both of these. Although I think it is possible to include intermediate natural parents (i.e. PW parentage) that are also not in the breadcrumbs, I think I will stick to immediate parent only. Same goes for the 'current' class. What I mean is this....let's say your 'jaguar's had child pages as well, maybe 'model A', 'model B', etc., that are also NOT part of the MB menu, following your request, you would something like this: Home / cars / Jaguar / Model A. The problem I foresee is what if an intermediate parent was part of the MB menu but not in a 'natural' position? I we were to include it in the breadcrumbs, it could end up in the wrong position (from the breadcrumbs point of view). I hope this makes sense and maybe this is an edge case. Anyway, unless convinced otherwise, I am limiting this to the immediate parent, e.g. Home / cars / Jaguar /. Thoughts?
 
Edit:
 
No, scratch that. I'll make the depth to which one wants to display non MB items that are natural children of the current MB item configurable, e.g. 

append_child => 0//default - no child appended = Home / Cars
append_child => 1// append the immediate child = Home / Cars / Jaguar
append_child => 2// append immediate child and grandchild
etc...

Beyond that...how you structure your menus is up to you :-)

Edited by kongondo
Changed mind...
  • Like 1

Share this post


Link to post
Share on other sites

Another thought I have of doing this is the following though I am not sure if there are any complications making this.

What if each separate page added to the menu had an option added to it in the menu builder(where title, url, css options are etc..) such as 'include this pages natural children from page tree' with a second option with it with a yes/no to display children in normal render method? The breadcrumbs could then normally display all levels as the pages would be included in the built menu with the option of not displaying with the normal render method if not wanted there.

This could actually be useful in other ways as well if normally wanting to include natural children under a page without actually having to manually put them all there especially if there are many.

If this is set up in such a way whereby all natural children are included such as the way a selector works then I assume when adding another page as a child in the normal page tree that it would then be included as well automatically in the menu builder if set up such a way. This could be quite useful making the menu builder much more flexible.

  • Like 1

Share this post


Link to post
Share on other sites

I think your 'another thought'  is a better approach since it allows for more granularity, i.e. it targets individual menu items rather than the first approach which targets the whole menu in terms of including natural child pages. I don't think there is a need for the second option 'yes/no' though unless am not getting it? By using the 'include natural children' option, you imply that you want them to be displayed. 

The way I think I'll do it:

'include_children' => 0//default = no
'include_children' => 1//yes, but only in menu, i.e. render()
'include_children' => 2//yes, but only in breadcrumbs, i.e. renderBreadcrumbs()
'include_children' => 3//yes, in both

//number of child nesting levels to show IF include_children > 0
//include_children_levels => 1//default, i.e. show only immediate children [or child in case of breadcrumbs]
//include_children_levels => 2//etc....show up to grandchildren/grandchild, etc..

The include_children can be tricky though....One might end-up with lots of sub-menus! But this is is optional, so up to the developer really.

Apart from some coding issues I may not have thought of yet, the visual MB aspect has to be considered. Those natural child pages will not be included in the saved menu items, hence will not be displayed in the menu tree in the back-end (ProcessMenuBuilder). They will only be included in the front-end output during runtime. That may confuse your editors, but nothing you can't educate them about, and this is optional anyway.

Edit:

Or...in the spirit of flexibility and granularity....in MB admin, also add an include_children_levels text (int) box next to an include_children checkbox. Then in the front-end, render() and renderBreadcrumbs() will be guided by:

if the setting include_children_levels is empty AND you have an $options = array ('include_children' => xx,  'include_children_levels' => zz), the level set in $options takes precedence and is applied overall except for menu items where the setting include_children_levels is NOT empty; an explicit level set at menu item level will override any $options setting. Would such a workflow work for you?

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

I don't think there is a need for the second option 'yes/no' though unless am not getting it? By using the 'include natural children' option, you imply that you want them to be displayed. 

Yes but sometimes not displayed in the main menu but only breadcrumbs.

The yes/no option was to give flexibility for the editors so that a choice could be made on whether to have the children displayed with the 'normal render method'(in main menu for example) or not for each page that has children. Since there can be times when I don't want them displayed on the main menu(only in breadcrumbs) and this option can be different for each page added in the menu builder. In the example I made before the car brands would not be shown in the main header menu but would be shown in breadcrumbs so option chosen would be set to 'NO'. The about page would have option set to 'YES'(which would be default) so the children of about page would be displayed in the main menu and breadcrumbs.

Choosing to 'include natural children' and 'YES' would include the children in both normal menu and breadcrumbs, choosing 'NO' would only include in breadcrumbs. Having this option with each page(menu item) enables each page added to the menu to have different options if they are displayed in main menu or not.

Maybe I am not understanding the 'include_children' option fully but wouldn't this then end up overriding all the options chosen for each individual page(menu item) by the admin for the normal render method(main menu)? This would then disable the ability to have one page on main menu displaying it's children and one page in the menu not displaying it's children.

Apart from some coding issues I may not have thought of yet, the visual MB aspect has to be considered. Those natural child pages will not be included in the saved menu items, hence will not be displayed in the menu tree in the back-end (ProcessMenuBuilder). They will only be included in the front-end output during runtime. That may confuse your editors, but nothing you can't educate them about, and this is optional anyway.

That's fine, I think that is the best way anyway since if there were many children it could make the menu builder quite crowded & unworkable. This way would actually make it much cleaner to use.

Share this post


Link to post
Share on other sites

Ah, I see (see also my edited posts above). Your yes/no is targeted at editors whereas my include_children with its options is targeted at developers. Giving editors the choice makes more sense and I'll adapt that instead. So, just to make sure we are on the same page:

  1. Editors control inclusion of natural children (default is exclude - this setting is not saved)
  2. Editors control whether natural children are shown in menu or breadcrumbs or both (This can a set of 3 radio buttons - any selection also implies include children; no selection implies don't include - or I could add a fourth button but it's already crowded in that menu setting as it is!! if one wants to edit the setting. No, better yet, I'll use a drop-down with 3 options - 'menu', 'breadcrumbs', 'both'. No selection = default and means 'don't include natural children')
  3. Editors control this per menu item (i.e. per PW page)

What do you think about my levels question though? Sticking to immediate children is pretty straightforward. Do you see a need for grand-children? This is more relevant for breadcrumbs, e.g. if you wanted Home / Cars / Jaguar / Model X where both 'Jaguar' and 'Model X' were not part of a MB menu...

Share this post


Link to post
Share on other sites

Ah, I see (see also my edited posts above). Your yes/no is targeted at editors whereas my include_children with its options is targeted at developers. Giving editors the choice makes more sense and I'll adapt that instead. So, just to make sure we are on the same page:

  1. Editors control inclusion of natural children (default is exclude - this setting is not saved)
  2. Editors control whether natural children are shown in menu or breadcrumbs or both (This can a set of 3 radio buttons - any selection also implies include children; no selection implies don't include - or I could add a fourth button but it's already crowded in that menu setting as it is!! if one wants to edit the setting. No, better yet, I'll use a drop-down with 3 options - 'menu', 'breadcrumbs', 'both'. No selection = default and means 'don't include natural children')
  3. Editors control this per menu item (i.e. per PW page)

Looks good

What do you think about my levels question though? Sticking to immediate children is pretty straightforward. Do you see a need for grand-children? This is more relevant for breadcrumbs, e.g. if you wanted Home / Cars / Jaguar / Model X where both 'Jaguar' and 'Model X' were not part of a MB menu...

Would be good to have levels and I can see a need for grand-children sometimes.

I think that levels could be useful as well for the main menu at certain times when using include_children so as to limit the amount of levels shown for example in a drop down menu. But then the levels needed to be shown in main menu could then differ to the amount needed for breadcrumbs so would maybe need different include_children_levels for main menu and breadcrumbs.

Or...in the spirit of flexibility and granularity....in MB admin, also add an include_children_levels text (int) box next to an include_children checkbox. Then in the front-end, render() and renderBreadcrumbs() will be guided by:

if the setting include_children_levels is empty AND you have an $options = array ('include_children' => xx,  'include_children_levels' => zz), the level set in $options takes precedence and is applied overall except for menu items where the setting include_children_levels is NOT empty; an explicit level set at menu item level will override any $options setting. Would such a workflow work for you?

So an options default would be set to all menu items in one swoop and then can be tweaked at admin level? It is an interesting thought. The more I think about it the more I see it could come in handy.

Share this post


Link to post
Share on other sites

Would be good to have levels and I can see a need for grand-children sometimes.

I think that levels could be useful as well for the main menu at certain times when using include_children so as to limit the amount of levels shown for example in a drop down menu. But then the levels needed to be shown in main menu could then differ to the amount needed for breadcrumbs so would maybe need different include_children_levels for main menu and breadcrumbs

OK, we should have these separate...I need to reiterate that MB will not control the number of such children to show at any level.....although I want to leave that to the developer (or editor?), I may need to limit maximum number of pages returned in that 'find'. I imagine a situation where an editor working on some other part of the site inadvertently adds tens of child pages (e.g. under CARs and under Jaguar, etc...)...Coupled with a levels of say 3, you suddenly end up with 3 x XX number of pages to find for one or more menu items! Can easily chock memory...Not sure how to implement this at the moment...maybe make it configurable at developer (template file) level...something like max_children at each level...

So an options default would be set to all menu items in one swoop and then can be tweaked at admin level? It is an interesting thought. The more I think about it the more I see it could come in handy.

Exactly...would save you a few clicks...

Edit:

Below is how I envisage the order of priority of $options (API/template file) setting vs. admin-level settings. There's 4 possible admin-level settings for each menu item in respect of whether to show its natural children. Show in: (1) Menu (2) Breadcrumbs (3) Both (4) Never. In addition there's the number of levels to show in respects of choices 1-3.

Desc order of priority for final display

  1. $options = array('include_children' => 0)//overrides everything set at admin level. No natural children displayed anywhere
  2. Any explicit admin-level setting: 1- 4//Natural children displayed/not displayed as per choices 1-4 FOR ONLY THIS menu item irrespective of what is set in $options (apart from a '0' setting as shown in point #1 above)
  3. $options = array('include_children' => 1|2|3)//overrides ONLY EMPTY admin-level settings: Show natural children of all items without an admin-level setting ONLY in menu [1] (render()) OR breadcrumb (renderBreadcrumbs()) [2] OR both [3]
  4. Empty admin-level setting: no natural children displayed anywhere
Edited by kongondo
order of priority description
  • Like 1

Share this post


Link to post
Share on other sites

Is it possible to use this in a Multi Language Site.

Tried to use it, but in the menu title I get Array and in the outputs as well, it outputs Array, instead of the menu title. When changing language it buts.

Thanks in advance.

Share this post


Link to post
Share on other sites

@bbeer,

No, it's not multi-lingual in that sense. The reason you see an array is because the various titles (in the different languages you have installed) are held in an array. When saving, since I have not implemented ML support, PW does not know what to save. That is what I am assuming. I have never worked in a ML site before so this is new to me too. I am looking into it. I'll ask in the forums (Soma probably will pick it up :-)). So far my searches have come empty, i.e. how to save a field (in this case a page title) in a ML environment. Hopefully I'll find an answer here: https://processwire.com/api/multi-language-support/multi-language-fields/

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