Jump to content
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/FieldtypeRockGrid

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

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

Further instructionshttps://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions

German Translation Filesite--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

 

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 (excl vat).

 

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 22
  • 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
Spoiler

 

I am creating an updated web interface for an international proverb database (without pay). RockGrid should go a long way in providing a navigation system for it, so thank you very much for it! However, I can only make it work in the backend.

For the frontend, is it really enough to have $page->rockgrid; in the home.php (using blank profile)? No markup is needed in templates? I mean, it does load all the RockGrid assets in the frontend, but the grid element does not manifest. I did try a variation, where I had a div with id RockGridItem_rockgrid or the wrapper, but it did not help.

Here is my setup:

Field name is rockgrid.

home.php:


include("./basic-page.php");
$page->rockgrid;

basic-page.php loads jquery-3.3.1.min.js

rockgrid.php:


<?php namespace ProcessWire;

// set data for this grid via rockfinder
$this->setData(new RockFinder('template=A-T', ['code', 'variation']));

rockgrid.js:


document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);

  var col = grid.getColDef('code');
  col.headerName = grid.js.code;

  var col = grid.getColDef('variation');
  col.headerName = grid.js.variation;

});

document.addEventListener('RockGridItemAfterInit', function(e) {
  if(e.target.id != 'RockGridItem_transactions') return;
  var col;
  var colDef;
  var grid = RockGrid.getGrid(e.target.id);  
});

The only JS warning is Loading failed for the <script> with source “http://localhost:2015/site/modules/RockGrid/lib/currency.min.js”, which is irrelevant.

Edit: I also tried putting it in the basic-page template. I installed Tracy Debugger, but I don't know what I should be looking for.

 

 

Share this post


Link to post
Share on other sites

Edit: silly stuff here, nothing to see.

Spoiler

 

I started fiddling with the InputfieldRockGrid.module.php file. There is something wrong with output buffering. After ob_start(); I put $status = ob_get_status(); var_dump($status); and I get nothing.

PHP setting output_buffering is 4096 in my dev env. What can I do?

Edit: in the same dev env, if I do a simple test file with only ob_start and dump, it works. So what gives in RockGrid's case? I mean, I can get the value of $data just before ob_start.

ob_start works fine in a PW template as well. The problem is only manifesting in the input field PHP.

Edit2: if I comment out ob_start(); and return ob_get_clean();, the page gets rendered twice, but at least in the second rendering the grid is included.

 

 

Share this post


Link to post
Share on other sites

Hi @Beluga please can you provide detailed step-by-step instructions so that I can try to reproduce your issue. I don't really get what is wrong. Is it not working as expected?

Edit: Sorry, I missed your first post.

Please follow the quickstart tutorial here: https://gitlab.com/baumrock/FieldtypeRockGrid/wikis/quickstart

From there you can continue adding features and always check wether it is working on the frontend or not. Some plugins do not have front-end-support yet. Most of the times it should not be hard to make them work on the frontend too.

Please report back if the quickstart tutorial is working for you.

Share this post


Link to post
Share on other sites
Spoiler

 

On 8/25/2018 at 12:26 PM, bernhard said:

Hi @Beluga please can you provide detailed step-by-step instructions so that I can try to reproduce your issue. I don't really get what is wrong. Is it not working as expected?

Edit: Sorry, I missed your first post.

Please follow the quickstart tutorial here: https://gitlab.com/baumrock/FieldtypeRockGrid/wikis/quickstart

From there you can continue adding features and always check wether it is working on the frontend or not. Some plugins do not have front-end-support yet. Most of the times it should not be hard to make them work on the frontend too.

Please report back if the quickstart tutorial is working for you.

The qs tuto is what I used. Can you shed light on the ob_start() problem? Why is it not working in the context of RockGrid?

 

 

Share this post


Link to post
Share on other sites

If you give me clear step by step instructions I can have a look. I don't understand your explanations in the previous posting

Share this post


Link to post
Share on other sites
Spoiler

 

Ok, second try, minimal example with enumerated steps.

1. Create PW install with blank profile

2. Install RockFinder & RockGrid

3. Create rockgrid field named "rockgrid"

4. Add the rockgrid field to home template

5. Edit basic-page.php and add


<script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>

inside the head and


<div><?php $page->rockgrid; ?></div>

inside the body

6. Create the rockgrid.php:


<?php namespace ProcessWire;

// set data for this grid via rockfinder
$this->setData(new RockFinder('template=home', ['title']));

7. Create the rockgrid.js:


document.addEventListener('RockGridItemBeforeInit', function(e) {
  if(e.target.id != 'RockGridItem_rockgrid') return;
  var grid = RockGrid.getGrid(e.target.id);

  var col = grid.getColDef('title');
  col.headerName = grid.js.title;

});

document.addEventListener('RockGridItemAfterInit', function(e) {
  if(e.target.id != 'RockGridItem_transactions') return;
  var col;
  var colDef;
  var grid = RockGrid.getGrid(e.target.id);  
});

8. Navigate to the home page and see that the grid is not rendered. Viewing the source, see that the RockGrid assets are in place. This means the execution of getData function in InputfieldRockGrid has been successful and it trips up at line 110 with ob_start(); for some reason.

 

 

 

Share this post


Link to post
Share on other sites

hey @Beluga

I tried your steps and cannot reproduce your error:

Fcpw64D.png

It works as expected. I used the default profile and the latest versions of rockgrid + rockfinder (used git clone with the master branches).

Share this post


Link to post
Share on other sites
6 hours ago, Beluga said:

it trips up at line 110 with ob_start();

I tried it without output buffering and it works normally.

Where is this line 110 ob_start() exactly sitting? Do you use a prepend file? Is it in your basic_page.php template?

Is 

<div><?php $page->rockgrid; ?></div>

right after ob_start() ?

XAMPP here on Windows 8 and PHP 7.1.9, PW 3.0.106

Share this post


Link to post
Share on other sites

I tried it out now like this:

<div id="rockgriddemo">
  <?php
  $grid = $page->rockgriddemo;
  ob_start();
  echo $grid;
  ob_end_flush();
  ?>
</div>

And everything still works normally. But I haven't used output buffering in a long long time. Not even sure I am using it correctly...

  • Thanks 1

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...