Jump to content
horst

Page Image Manipulator 1

Recommended Posts

The next version of PiM will be able to enhance the Thumbnails module

(after I have successful send a pull request to apeisa and he have had time to check and implement the code, - hopefully)
 
 
While writing on the (optional) support for PiM with Thumbnails, owzim has written the js-code that rebuilds the crop rectangle, - and also he has tested and forthrightly commented my various tests with that. ^-^
 
Thumbnails will recognize if PiM is installed and use a different routine then. And without PiM the Thumbnails Module will use the PW core ImageSizer. Since dev-version 2.3.3 the ImageSizer uses automatic sharpening after resize. So - once after updating to the new module and a newer PW version (dev 2.3.3 or stable 2.4) everyone has sharpening support. :)

We both (owzim & me) want to have the coords & data stored and pre-selected when coming back to a previous created thumbnail. We use a wrapper class with a read and a write method on a session basis to achieve that. (After closing the browser or otherwise destroy the session, all data is lost)
 
But together with PiM the coords and options can be stored permanent! It can be stored as metadata in a IPTC custom field (2#215) with the original imagefile. :)

If you want enable permanent storage you have to create a config array named imageManipulatorOptions in your site/config.php and create the key thumbnailCoordsPermanent and set it to true:

$config->imageManipulatorOptions = array(
   // ...
	'thumbnailCoordsPermanent' => true
);

So, - if you don't want permanent storage, you are still able to use Thumbnails Module and PiM together, but without permanent storage.


 
https://youtu.be/IHwjL7YSfRo
 

EDIT: PullRequest is send https://github.com/apeisa/Thumbnails/pull/13 (the unorthodox way) :P

Edited by horst
  • Like 6

Share this post


Link to post
Share on other sites

No way thats not possible !!!

Very impressive !!!

Big tnx @Horst

oh, it's possible because of the help from owzim!

so it should be: "Big tnx @owzim, too" :)

  • Like 2

Share this post


Link to post
Share on other sites

@horst Thanks for the explanation. Maybe it's also ok if you mention the transparency range in your documentation so it's not necessary to change the code ;-)

Share this post


Link to post
Share on other sites

@horst Thanks for the explanation. Maybe it's also ok if you mention the transparency range in your documentation so it's not necessary to change the code ;-)

I have had to rewrite it because the alpha transparency wasn't supported at all.

I just have pushed the version 0.0.8 to GitHub. :)

post-1041-0-15209900-1378060978_thumb.jp

There are some other fixes and changes with the version 0.0.8:

  • added enhanced support for Thumbnails module, including permanent storage for CropRectangleCoords and params
  • fixed / rewritten all bg-color stuff to support rgba alpha channel
  • fixed a E-Notice with IPTC prepare
  • changed the params of method resize, width, height to be the same like in new ImageSizer, ($sharpen can have value 'none')

I will also update the first post of this thread.

  • Like 4

Share this post


Link to post
Share on other sites

@Marty: thanks! Have you seen the post about PiM working together with Thumbnails too? I think you will like it! At least you are responsible for the existence of the Thumbnails Module. ^-^  ( and yes, - Antti  ^-^  is responsible too)

I'm very new and inexpertly with GitHub, because of that I have asked owzim if he can help me to send a pull request to Thumbnails repo with only code for sharpening support. While talking/writing about that GitHub stuff - we also come to conclusion that Thumbnails needs recreation of previously used thumbs. And as I don't know the JS stuff, owzim seems to know it very well and he wrote it! ^-^

I really like that community here and also how good people work together to make things good and better. ^-^

Thank you!

  • Like 4

Share this post


Link to post
Share on other sites

Hi Horst,

Trying to create a gif from a PNG 24. 

echo $img->name; // image.png

$info = $img->pimLoad("test", true)->getImageInfo();
var_dump($info);

// array(11) {
//   ["type"]=> string(3) "png"
//   ["imageType"]=> int(3)
//   ["mimetype"]=> string(9) "image/png"
//   ["width"]=> int(114)
//   ["height"]=> int(48)
//   ["landscape"]=> bool(true)
//   ["ratio"]=> float(2,375)
//   ["bits"]=> int(8)
//   ["channels"]=> int(6)
//   ["colspace"]=> string(9) "DeviceRGB"
//   ["alpha"]=> bool(true)
// }

$pim = $img->pimLoad("test", true)->pimSave();
Warning:  imagealphablending() expects parameter 1 to be resource, null given in /path/to/htdocs/site/modules/PageImageManipulator/ImageManipulator.class.php on line 684

$pim = $img->pimLoad("test", true)->setOutputFormat("gif")->pimSave();
Warning:  imagegif() expects parameter 1 to be resource, null given in /path/to/htdocs/site/modules/PageImageManipulator/ImageManipulator.class.php on line 681

$pim = $img->pimLoad("test")->setOptions(array("outputFormat" => "gif"))->pimSave();
Warning:  imagegif() expects parameter 1 to be resource, null given in /path/to/site/modules/PageImageManipulator/ImageManipulator.class.php on line 681

Share this post


Link to post
Share on other sites

Hi Martijn,

sorry, in a previous version this has worked, but by rewriting for rgba support I must have broken it. I have pushed an update to github that solved the issue.

But I think the result from converting transparent png to gif isn't what you expect :( 

Because transparency get not transformed into GIF-Palette-Color. It seems this isn't possible, - at least not that simple. ??

But bug is fixed now, thanks for your help!

Share this post


Link to post
Share on other sites

Hi Horst, 

TNX for your followup & bug fix.

<horst>But I think the result from converting transparent png to gif isn't what you expect :(</horst>

Is it possible to create a jpeg from the PNG 24 attach a background form a variable value [ rgb(100,100,100) ] then scale it and save it to gif ?

( want to use it in for newsletters )

Share this post


Link to post
Share on other sites

Hi Martijn,

can you only use gif? (Newsletter with embedded cid: ?)

You may try:

function pimPng2Gif($im1, $rgb) {
	imagealphablending($im1, true);
	imagesavealpha($im1, false);
	$w = imagesx($im1);
	$h = imagesy($im1);
	$im2 = imagecreatetruecolor($w, $h);
	imagealphablending($im2, true);
	imagesavealpha($im2, false);
	$bg = imagecolorallocate($im2, $rgb[0], $rgb[1], $rgb[2]);
	imagefilledrectangle($im2,0,0,$w-1,$h-1,$bg);
	imagecopy($im2,$im1,0,0,0,0,$w,$h);
	imagedestroy($im1);
	return $im2;
}

$rgb = array(219,17,116);

$png = $page->images->first()->pimLoad('png2gif',true);
$gif = $png->setMemoryImage( pimPng2Gif($png->getMemoryImage(), $rgb) )->setOutputformat('gif')->save();

echo "<img src='{$gif->url}' /> {$gif->name}";

Edited by horst
  • Like 1

Share this post


Link to post
Share on other sites

Tnx Horst, great !

Yep can only use gif. ( newsletter build system :))

Left the office earlier today, was to tired to think. Gonna try it tomorrow !

Share this post


Link to post
Share on other sites

Hi guys, im totaly new to PHP and i cant figure out what im doing wrong here :

<ul>
	<?php
		$news = $pages->find("parent=1009");
		$out =" ";
		foreach($news as $news){
			$pageimage = $news->images->first->width(313)->pimLoad('news')->pimSave()->url;
			$out .= "<li><a href='{$news->url}'>";
			$out .= "<img src='{$pageimage}' alt='' />";
			$out .= "{$news->title}";
			$out .= "{$news->body}";
			$out .= date("j.m.Y", $news->created);
			$out .= "</a></li>";
		}
	echo $out;
 ?>
</ul>

and here is my error:
 

<p class="error WireFatalError">
Error: Call to a member function width() on a non-object (line 9 of D:\xampp\htdocs\projects\chemik\site\templates\home\news.html)
<br>
<br>
<em>This error message was shown because you are logged in as a Superuser. Error has been logged. </em>

Ty.
 

Share this post


Link to post
Share on other sites
foreach($news as $news){

On this line you are overriding the array news, by assigning the individual item to it. Change one of those variables to something different. Don't forget to change all occurrences of it.

  • Like 1

Share this post


Link to post
Share on other sites

@vxda:  and of course, for resizing you don't need the Pageimage Manipulator. It is enough to call ->width() on a pageimage:

// example
$pageimage = $myNewsItem->images->first->width(313)->url;

But also your variable names are a bit confusing: your variable $pageimage contains only the URL. I would change this to avoid confusion:

// example
$pageimage = $myNewsItem->images->first->width(313);

// and then
$out .= "<img src='{$pageimage->url}' alt='' />";

References on how to work with images:

Edited by horst
  • Like 1

Share this post


Link to post
Share on other sites

@horst:
Ty for a quick reply.

i changed my code to this

<?php
	$news = $pages->find("parent=1009");
	$out ="";
	foreach($news as $newsitem){
		$newsimg = $newsitem->images->first->width(313);
		$out .= "<li><a href='{$newsitem->url}'>";
		$out .= "<img src='{$newsimg->url}' alt='' />";
		$out .= "{$newsitem->title}";
		$out .= "{$newsitem->body}";
		$out .= date("j.m.Y", $newsitem->created);
		$out .= "</a></li>";
	}
	echo $out;
 ?>

and i still have this error.

when i remove

->width(313)

it picks the right picture and it all works, but without resizing img.

what am i missing ?

Thank you

Share this post


Link to post
Share on other sites

Ok i got it ;) problem solved

adding:

if ($newsimg) {
	$newsimg = $newsimg->size(313,177)->url;
}

solved the problem so my code looks like this now :

<?php
				$news = $pages->find("parent=1009");
				$out ="";
					foreach($news as $newsitem){
						$newsimg = $newsitem->images->first;
						if ($newsimg) {
							$newsimg = $newsimg->size(313,177)->url;
						}
						$out .= "<li><div><a href='{$newsitem->url}'>";
						$out .= "<img src='{$newsimg}' alt='' />";

						$out .= "{$newsitem->title}";
						$out .= "{$newsitem->body}";
						$out .= date("j.m.Y", $newsitem->created);
						$out .= "</a></div></li>";
					}
					echo $out;
				 ?>

Thank you for help.

  • Like 1

Share this post


Link to post
Share on other sites

vxda glad you figured it out.

It's always good to check if there's images, you could also use count(), and maybe also not output the image if there's no image.

So you could also do

...
$out .= "<li><div><a href='{$newsitem->url}'>";
if ($newsitem->images->count()) {
   $out .= "<img src='{$newsitem->images->first->size(313,177)->url}'/>";
}
$out .= "{$newsitem->title}";
...
  • Like 1

Share this post


Link to post
Share on other sites

First one is nicer to look at (in my opinion). I don't believe there is real difference.

Share this post


Link to post
Share on other sites

Hi Horst,

thanks for this really impressive module. It's a dream (even the watermarking is important for me).

I have one problem.

I often have to delete images and replace with newer ones.

But then i get a large amount of orphaned pim-image-files in my page assets folders.

A solution was mentioned here:

http://processwire.com/talk/topic/4437-delete-orphaned-filesimages-from-siteassetsfiles/

But isn't there a way to delete the appropriate pim-image-file(s) automatically when deleting the original pw-image-file ?

Greetings,

Wolf

Share this post


Link to post
Share on other sites

... But isn't there a way to delete the appropriate pim-image-file(s) automatically when deleting the original pw-image-file ?

Actually you only can use the method removePimVariations() on a per image base to delete all your testfiles!

$img = $page->images->first();

$img->pimLoad('prefix')->removePimVariations();

and they all are gone.

But automaticly delete them when deleting a original image isn't supported yet. At least if you delete them manually in the backend. If you delete them via the API, there should be a simple way / workaround to get it solved. How do you delete them?

When deleteing images manually in the backend:

If you really have much changes and therefor a lot of orphaned files, you may use the lazycron module (core, but you have to install it first) together with the delete-orphaned-files script.

It would be much better to get rid of that automaticly as you said, but I need to find the way how to do it. And within next weeks there are no time available for extending PiM. :(

Edited by horst

Share this post


Link to post
Share on other sites

Today I have added a hook to the module that add pim_* variations to pageimage-variation-collection.

This is usefull to not have mass orphaned (pim_)images on the disk when original images got deleted.

I have had this code ready for many weeks and would have done some more (workaround for GDlibs buggy sharpening on pngs with alpha-transparency) before update the module. But I haven't had time for this.

So, there are no other changes in module version 0.1.1 what is available now at github and in the modules section.

Cheers!

  • Like 3

Share this post


Link to post
Share on other sites

Thank you, Horst, for this great module.

Bug report: the ratio isn't calculated correctly.

Two lines containing:

'ratio'	   => floatval(($info[0]>=$info[1] ? $info[0]/$info[1] : $info[1]/$info[2]))

have to be:

'ratio'	   => floatval(($info[0]>=$info[1] ? $info[0]/$info[1] : $info[1]/$info[0]))
  • Like 2

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