bernhard

RockGrid - powerful, performant and beautiful data listing tool

Recommended Posts

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.

 

Downloadhttps://gitlab.com/baumrock/RockGrid

Installationhttps://gitlab.com/baumrock/RockGrid/wikis/Installation

Quikckstarthttps://gitlab.com/baumrock/RockGrid/wikis/quickstart

Further instructionshttps://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

 

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

  • 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:

reports.gif

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

groups.gif

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

filter.gif

  • Like 14
  • Thanks 1

Share this post


Link to post
Share on other sites

Thank you Bernhard for finally releasing this module. I can not wait to play with it and share improvements, if I have any.

I really can think of many use cases where this grid would be mandatory because it offers so much possibilities.

  • Like 1

Share this post


Link to post
Share on other sites

I installed the module and RockFinder, but when calling "Rock Finder Tester" the SQL query works, but no grid is displayed.

There is a JavaScript error in the console which looks like this:

(index):205 Uncaught ReferenceError: RockGrid is not defined
    at initGrid_ProcessRockFinderResult ((index):205)
    at (index):216

 

Share this post


Link to post
Share on other sites

The problem was, that I did not rename the downloaded folder from Gitlab from "RockGrid-master" to "RockGrid". After doing this, it works

  • Like 1

Share this post


Link to post
Share on other sites
42 minutes ago, jmartsch said:

The problem was, that I did not rename the downloaded folder from Gitlab from "RockGrid-master" to "RockGrid". After doing this, it works

Installing the zip (either from URL or Upload), rather than manually unzipping takes care of this stuff for you 🙂

  • Like 3

Share this post


Link to post
Share on other sites

Why I'm always the one who still have the error.😂 I did install via upload of zip and I have /modules/RockGrid.

However, I still have errors:

image.thumb.png.1a690cdab44cc61ff9422825ef509b5a.png

1)The path is wrong for js, it should be : localhost/24h/site/assets/RockGrid/fields/test_grid.js

2)error mentioned earlier

 

Also, not related, but playing with the Tester, I wrote some wrong code which gave me a red error page. The problem is that I didn't know how to reset. (finally I reinstalled since of error above).

Thanks!

Share this post


Link to post
Share on other sites

Hi mel,

thanks for testing and reporting those issues 🙂 

can you please provide a reproducable step-by-step guide what you did so I can look into that?

 

9 hours ago, mel47 said:

Also, not related, but playing with the Tester, I wrote some wrong code which gave me a red error page. The problem is that I didn't know how to reset. (finally I reinstalled since of error above).

Thanks, I'm aware of that and it's definitely not nice to have this. I thought I've already fixed that 🙂 If it happens again please just delete the /site/assets/RockFinder/tester.txt file than it will create a new one. Or just edit it in your IDE and fix the problem.

Hope that helps?

Share this post


Link to post
Share on other sites

Hi

Sorry for the delay, was too sunny to stay inside... 😉

So to recap. I tried on 2 installations (one with my current site and one empty, ie no module). Both are local, running php 7.0. I'm using firefox.

  1. Install rockfinder via module repository
  2. install rockgrid by url (https://gitlab.com/baumrock/RockGrid/-/archive/master/RockGrid-master.zip)
  3. create a "projects" rock-grid field and add it to home template
  4. Go to home template; see an empty white field with this error:
     ReferenceError: RockGrid is not defined[En savoir plus] edit:118:7
    initGrid_projects http://localhost/wire/processwire/page/edit/:118:7
    <anonyme> http://localhost/wire/processwire/page/edit/:129:7
     
  5. Add to /site/assets/RockGrid/fields/projects.js and project.php (copied from usage instructions. Now see this error
    Échec du chargement pour l’élément <script> dont la source est « http://localhost/site/assets/RockGrid/fields/projects.js ». edit:61 

    as mentioned earlier it's not the good address, it missing the domain, in this case : http://localhost/wire/site/assets/RockGrid/fields/projects.

Hope it helps.

Mel
PS No error during module installation. Debug info display under the field seems ok (default mysql query):

0.4ms getSQL SELECT `rockfinder`.* FROM /* original pw query */ (SELECT pages.id FROM `pages` WHERE (pages.status<1024) GROUP BY pages.id ORDER BY pages.created DESC ) as `pwfinder` LEFT JOIN ( /* rockfinder */ SELECT `pages`.`id` AS `id`, `title`.`title` AS `title`, `created`.`created` AS `created` FROM `pages` /* --- join title --- */ LEFT JOIN (SELECT `pages_id` AS `pageid`, `title`.`data` AS `title` FROM `field_title` AS `title`) AS `title` ON `title`.`pageid` = `pages`.`id` /* --- end title --- */ /* --- join created --- */ LEFT JOIN (SELECT `id` AS `pageid`, `created` FROM `pages` AS `created`) AS `created` ON `created`.`pageid` = `pages`.`id` /* --- end created --- */ /* end rockfinder */ ) AS `rockfinder` ON `pwfinder`.`id` = `rockfinder`.`id`
0ms executeClosures  
1.2ms getObjects Includes executeClosures
1.3ms Overall Inputfield Render  

 

Share this post


Link to post
Share on other sites

Can you please follow the quickstart guide and let me know if it works like described there? Does Rockfinder tester work?

Share this post


Link to post
Share on other sites

Same result, juste a name change.

ReferenceError: RockGrid is not defined edit:578:7

 <div class="RockGridWrapper backend InputfieldIgnoreChanges" id="RockGridWrapper_rockgriddemo">
      <div id="RockGridItem_rockgriddemo" class="RockGridItem ag-theme-balham" data-id="rockgriddemo" style='height: 300px'></div>
      <div class="init"></div>
    </div>
    <script>
    // translation strings for this grid
    var RockGridStr_rockgriddemo = {
          }

    // grid settings object
    var gridSettings_rockgriddemo = {
      grid: 'rockgriddemo',
      dataColumns: ["id","title","created"],
      data: "ajax",
      js: {"settings":{"initPageSize":10,"pageSizes":[10,25,50,100],"height":300}},
    };

    // function to init the grid
    var initGrid_rockgriddemo = function() {
      RockGrid.init(gridSettings_rockgriddemo);    //////ERROR IS HERE
      RockGrid.getGrid('rockgriddemo').str = RockGridStr_rockgriddemo    }

    // load the grid automatically or manually?
    if(typeof onLoad_rockgriddemo == 'function') {
      // load grid manually
      // sometimes this is needed when we have to wait for other grids to be loaded
      onLoad_rockgriddemo(gridSettings_rockgriddemo, RockGridStr_rockgriddemo);
    }
    else {
      // load this grid when dom is loaded
      initGrid_rockgriddemo();  ///////ERROR IS HERE
    }
    </script>

 

If I don't put the .js file I have no extra error. If I add it to /site/assets/Rockgrid/fields/

I get error (404) :

Quote

Échec du chargement pour l’élément <script> dont la source est « http://localhost/site/assets/RockGrid/fields/rockgriddemo.js ».

I try add to frontend, but same result, a white space, with same errors than below.

For the tester, don't exactly what means "work" since I never used. But there nothing in "result", but the "resulting sql" is updated accordingly of changes done in "code to execute". 

I certainly do something wrong or don't have something activated correctly. Will give up for now, since I have other things to do. I will continue to follow the thread in case a solution eventually come out. Thanks for you time.

Mel

Share this post


Link to post
Share on other sites

Hi @bernhard I tried to test and reproduce why this isn't working.

When you install RockGrid and RockFinder from URL from Gitlab, then the RockGrid is downloaded and installed into a folder named "FieldtypeRockGrid". But RockFinder tries to look for files in a folder named "RockGrid".

So Rockfinder tester isn't working and shows the error that I described and @mel47 also described. That's the first problem.
You can solve it, if you download the zip file from gitlab, unzip it in your site/modules folder and remove the "-master" from the folder name, so the name of the folder is "RockGrid".

The second problem is, that if your processwire installation is not in the root of the virtual host of Apache (for example in a subdirectory), then the URLs for loading RockGrid's assets isn't correct because it tries to load the files from the root and does not take the subdirectory into account.

In one example installation I have two separate PW installations under the same virtual host but in different subdirectories (mydomain.localhost/pw1, mydomain.localhost/pw2). That might be the exact same problem that @mel47 has. If you open RockTester then it is trying to load http://mydomain.localhost/site/modules/RockGrid/plugins/cellHoverInfo.css instead of http://mydomain.localhost/pw1/site/modules/RockGrid/plugins/cellHoverInfo.css

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for your help @jmartsch !

I renamed all references to FieldtypeRockGrid, so it should work now without renaming the folder. Thanks for that hint! Maybe someone wants to create a PR for the problem of installations inside a subfolder - I don't have any need for that and therefore will not implement it. At least not soon.

I created a screencast of a demo installation via PW Kickstart, the Kickstartfile is here: https://gitlab.com/snippets/1732038 ; Of course you can also install everything manually.

 

  • Like 3

Share this post


Link to post
Share on other sites

Thanks, looks pretty amazing even for my very small testing. I generally learning by reading other's code examples. Since there mostly anything, I have a quick question.

I could display really easily page and repeater independently. But is it possible to display the title of page found inside a repeater ? For now I only have id. I tried many ways, but without success, but I'm not sure if I'm trying to do something impossible or not.

Thanks!

 

Share this post


Link to post
Share on other sites

I think I found a little glitch in the module. I've installed the module within a subdir based pw instance. Then the module won't find the nessecary js and css files. The field shows on the page edit page only a blank value and not that it find's no data.

I fixed it - for me - with the following change at line 64 in file site/modules/FieldtypeRockGrid/FieldtypeRockGrid.module.php:

Quote

// make sure the path is relative to the rootfolder
//$asset = str_replace($this->config->paths->root, '/', $asset);
$asset = str_replace($this->config->paths->root,$this->config->urls->root, $asset);

After that it seems to work for me.

Many thanx for the great module!!!

  • Like 1
  • Thanks 1

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 Macrura
      Field Descriptions Extended
      This module enables you to extend field descriptions by dividing short descriptions with a longer text that is revealed in a toggle.
      Modules Directory: http://modules.processwire.com/modules/field-descriptions-extended/
      Github: https://github.com/outflux3/FieldDescriptionsExtended
      Extending your field descriptions using the standard field's description field.
      Once this module is installed, it will automatically search your description field for the presence of 5 dashes (-----).
      Any content above the 5 dashes will be visible and the content below the dashes will be hidden. A 'More...' link will appear at the end of the short description which when clicked will reveal the rest of the description.
      Using Simple Markdown Editor with the description field
      If you have Simple Markdown Editor (InputfieldSimpleMDE) installed, you can enable the field description to have that editor.
      *When using Simple MDE, you can use the button (Insert Horizontal Line) instead of typing 5 dashes. More about SimpleMDE.
      Extending your field descriptions using content from a ProcessWire Page for the field description.
      You may use the content from a ProcessWire page as a field description. This would allow you to easily insert images, links, and use hanna codes.
      To use page content for your field descriptions, please follow these instructions:
      Install Select Fields module (FieldtypeFields) http://modules.processwire.com/modules/fieldtype-fields/ Create a new field using this field type, e.g. field_select. Add the field to any template you will be using for your field descriptions. Setup your help pages (for example under a settings branch) where you will store the field description content,using the template containing the Field Select. Add content to a page and select the field where that content should show. To show a short text before the link to the longer content, separate them with 5 dashes Be sure to update your settings on this page, first enable page content descriptions,then specify the name of the Select Fields field, template to search, and content field. If you create a field description using this method, please note that the description field must be blank for contexts where you want the page content to appear.
      You can freely use template context for field descriptions, but the Page Content method is not context sensitive and will display under all contexts where the description is blank.
      ----
      original post:
      This is a new module, hope to release soon, which allows extended field descriptions, in currently 2 ways.
      The main feature of the module is that you can have a short description and then a 'more...' link which drops down a longer block of text.
      This is achieved by separating the intro/visible text and the rest with 5 dashes.

      Example setup:

      the 2nd way is if you are using AdminThemeUiKit, you can show extended field instructions in a panel. The content of the panel is edited on a regular PW page. This use case would probably not be that common, but if you had a field that required some extended instructions for how to use, this could be useful; Also, since this allows you to target information and instructions down at the field level, it could reduce the amount of documentation needed on a global level, since it is a lot more context targeted.

    • By Robin S
      Breadcrumb Dropdowns
      Adds dropdown menus of page edit links to the breadcrumbs in Page Edit.

      Installation
      Install the Breadcrumb Dropdowns module. The module requires ProcessWire >= v3.0.83 and AdminThemeUikit.
      There is a checkbox option in the module config that determines if the breadcrumb dropdowns will include pages that the user does not have permission to edit.
      Features/details
      The module adds an additional breadcrumb item at the end for the currently edited page. That's because I think it's more intuitive for the dropdown under each breadcrumb item to show the item's sibling pages rather than the item's child pages. In the dropdown menus the current page and the current page's parents are highlighted in a crimson colour to make it easier to quickly locate them in case you want to edit the next or previous sibling page. If the option to include uneditable pages is selected then those pages are indicated by a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 sibling pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. Incompatibilities
      This module replaces the AdminThemeUikit::renderBreadcrumbs method so will potentially be incompatible with other modules that hook the same method.
       
      https://modules.processwire.com/modules/breadcrumb-dropdowns/
      https://github.com/Toutouwai/BreadcrumbDropdowns
    • By joshuag
      Hey guys, 
      Thought I would share a quick preview of Designme. A module we (Eduardo @elabx and I) are building for visually laying out your templates/edit screens. 🙂
      This is a really quick, zero polish screen grab. FYI. 
      Video #2 - UPDATE
      This new video shows the following features in Designme:
      Re-arranging fields via Drag & Drop Re-sizing fields via Dragging. Adjusting field settings - with live refresh. Working on "hidden" fields while Designme is active. Creating New fields. Deleting fields. Creating/Deleting Tabs. Dragging fields between tabs. Creating fieldsets. Tagging/Un-tagging fields. Fields without headers expand when hovered (like checkboxes). Live filtering of fields in the sidebar. Ability to adjust (all) Template settings without leaving Designme. Template File Tree Editing Template files source code with ACE Editor. Editing Multiple files with ACE Editor. (New Tabs) Saving files. Techie stuff Fields load their own js/css dependancies. *ready to use on creation (*most fields)  Everything happens via Ajax to ProcessPageEdit (via module + hooks). Designme has a JS api that you can use.  All actions trigger events.  We would love any detailed feedback on what you see so far. If you are interested in testing Designme. Let me know below. 🙂
       
       
      Video #1. 
       
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By tpr
      ProcessNetteTester
      Run Nette Tester tests within ProcessWire admin.
      (continued from here)

      Features
      AJAX interface for running Nette Tester tests, in bulk or manually display counter, error message and execution time in a table run all tests at once or launch single tests show formatted test error messages and report PHP syntax errors stop on first failed test (optional) hide passed tests (optional) display failed/total instead passed/total (optional) re-run failed tests only (optional) auto scroll (optional) include or exclude tests based on query parameters start/stop all tests with the spacebar reset one test or all tests (ctrl+click) https://modules.processwire.com/modules/process-nette-tester/
      https://github.com/rolandtoth/ProcessNetteTester