Jump to content
justb3a

Module: Image Extra

Recommended Posts

Sorry @justb3a - another small but critical bug for you. Everything was working fine on my PHP 7.1 local dev, but when I updated a live server running 5.4, the Image Extra fields weren't being inserted.

I have to replace this line: https://github.com/justb3a/processwire-imageextra/blob/master/ImageExtra.module#L1092

    $out = preg_replace('/(<input\sclass=\'InputfieldFileSort\')/', $this->escape_backreference($outAdditional) . '$1', $out);

with:

    $out = preg_replace('/(<input\sclass="InputfieldFileSort")/', $this->escape_backreference($outAdditional) . '$1', $out);

Notice the change: \' to "

Not sure if there have been some updates to PHP's regex engine between 5.4 and 7.1 that are causing this, but that is my guess.

Anyway, that change seems to fix things, but I didn't test the Description field because I have that disabled, so it might be worth checking all regexes. 

You can see here: https://regex101.com/r/0kTOmt/1 how that initial version fails, but this one: https://regex101.com/r/0kTOmt/2 works.

Hope that helps.

Share this post


Link to post
Share on other sites
7 hours ago, adrian said:

Notice the change: \' to "

I don't think that this has something to do with the change of the regex engine. The source code contains in one case single quotes in the other one double quotes. While writing the regex I thought about adding a check for double or single quotes - either way, the code now checks both occurrences, so it doesn't matter if the html contains single or double quotes. You can see it here: https://regex101.com/r/emj9Ie/1

  • Like 1

Share this post


Link to post
Share on other sites
15 minutes ago, justb3a said:

I don't think that this has something to do with the change of the regex engine. The source code contains in one case single quotes in the other one double quotes. While writing the regex I thought about adding a check for double or single quotes - either way, the code now checks both occurrences, so it doesn't matter if the html contains single or double quotes. You can see it here: https://regex101.com/r/emj9Ie/1

Yes, of course :) I was thrown off by it working on dev server but not live even though both had identical codebase and db content.

Thanks for the fix!

Share this post


Link to post
Share on other sites

@justb3a Thanks for the great modules. Just what I needed for my last project.

One thing I stumbled upon: I cannot delete text that has been inserted before. Since the existence of the input is a condition for outputting a caption or not it is necessary to have an empty field again.

Doesn't matter if placed inside a repeater or not.

Can you repoduce that, or do I miss something.

Thanks in advance!

  • Like 1

Share this post


Link to post
Share on other sites

You're right, somehow there was a missing equal sign :lol: Thanks for the feedback, please pull the latest version from Github!

  • Like 2

Share this post


Link to post
Share on other sites

Hello there! And thanks for a perfect module.

I have an interesting question. How can i programmatically set the values for multilanguage custom image fields? Tried several approaches, everything fails. Will appreciate any help. Thanks in advance!

Approach 1. Trying to switch current lang:

//...somethere inside a module...
$this->page->of(false);
$languageCurr = $this->user->language; //russian
$this->user->language = $this->languages->get("en");
//image retrievinig skipped
$image->title = 'an english title';
$image->save();
$this->user->language = $languageCurr;
$this->page->of(true);

Approach 2. Trying to use setLanguageValue():

$en = $this->languages->get("en");
$image->title->setLanguageValue($en,''an english title'') ; //gives error

Approach 3. Trying to use special names for needed field:

$this->page->of(false);
$image->title_en = 'an english title'; //not stored at fact
$this->page->of(true);

Thanks in advance!

Share this post


Link to post
Share on other sites

hi

from the API side you can set the values like this:

$page->setOutputFormatting(false);
$page->images->trackChange('title');
$img = $page->images->first(); // or whatever image you want
$img->title = 'Title in default language';
$img->title($languages->get('fi'), 'Title in Finish');
$img->title($languages->get('de'), 'Title in German');
$page->save();
$page->setOutputFormatting(true);

 

  • Like 4

Share this post


Link to post
Share on other sites

Thanks justb3a! Works like a charm.

Another tricky question. Let's suppose that i decided to fetch some images with language fields via Ajax request. The endpoint which receives that request is a Processwire page so all Processwire API functions are available. The data structure for each image is like this:

{"name":"dscXXXX.jpg","title":"A multi-language title","uid":"2aa1"}

The endpoint call may include something like ?uid=XXXX&lang=en , so the endpoint is language-aware and should return the title in the desired language.

Fetching image by uid is not a problem, but how to force our endpoint to fetch the multi-lang title for the desired language?

At the moment i found the only solution which is quite hacky. Let's suppose we have the "english" lang page id = 1000. So the data structure for the $image object will be like this:

...
title->'The title in default language',
title1000->'The title in english'
...

So i can get English title like this:

$title_en = $image->title1000;

Could You give me any advice how to fetch the multi-lang image field value for desired language in a less hacky way? Thanks in advance!

 

Share this post


Link to post
Share on other sites

This works pretty straight forward :)

echo $image->title($languages->get('en'));
// $image->title($languages->get($input->get('lang'));

 

  • Like 3

Share this post


Link to post
Share on other sites

Hi @Zeka, what do you exactly want to do?  A "Page reference" field references to another page, I'm not quite sure how this is related to image extra fields. 

Share this post


Link to post
Share on other sites
4 hours ago, justb3a said:

Hi @Zeka, what do you exactly want to do?  A "Page reference" field references to another page, I'm not quite sure how this is related to image extra fields. 

Hi @justb3a Sorry for being not clear enough. I want to extend image field by page reference field. But if I do so, I get just regular text field instead of page field. So it makes me thinking that your module works only with text-based fields and not with some more complicated.

 

Share this post


Link to post
Share on other sites

Ok, that is not possible. If you want to reference to another page, why not using the internal page link field (enable checkbox in field settings in Image Extra Tab)? This saves also a reference to a page, what do you do with that reference is up to you :) The only drawback: you can use it only once and it's not possible to define an entry point / parent page, so all pages will be listet. 

Share this post


Link to post
Share on other sites

Hello,

Thanks for your module; I read all the thread. Last year, it seems impossible to have some html in extra fields, does it works now? Anyway, if so, I'm unable, it always strip out my <a href[...]

Furthermore, I'm seems unable to add more than 1 textformatter, I can just choose one (and I'm not really sure it was applied).

Thanks

Mel

PW 3.0.51

Sélection_149.png

Share this post


Link to post
Share on other sites

@mel47 You can only apply one textformatter for a field.

Quote

.. it always strip out my <a href[...]

You're right, I'm using sanitizer textarea to sanitize the input values. And the default option – which will be provided to the textarea() sanitizer – is: 

// strip markup tags
'stripTags' => true,

Therefore all tags are gone. I updated the sanitizer usage and set this option to `false`.

Please update the module and try again! :)

  • Like 1

Share this post


Link to post
Share on other sites

@justb3a - what about using the "purify" sanitizer instead of "textarea". Not sure if it suits your needs, but thought I should mention it.

Share this post


Link to post
Share on other sites
19 hours ago, adrian said:

@justb3a - what about using the "purify" sanitizer instead of "textarea". Not sure if it suits your needs, but thought I should mention it.

You're completely right. Thanks for the hint, I'll change it. ^_^

`core/Sanitizer.php` function textarea:

/**
 * Sanitize input string as multi-line text without no HTML tags
 *
 * - This sanitizer is useful for user-submitted text from a plain-text `<textarea>` field, 
 *   or any other kind of string value that might have multiple-lines.
 * 
 * - Don't use this sanitizer for values where you want to allow HTML (like rich text fields). 
 *   For those values you should instead use the `$sanitizer->purify()` method. 
 [...]
 */

 

  • Like 1

Share this post


Link to post
Share on other sites

Hi @justb3a,

Do you think the extra field headings could be styled more like the Description label? This might be easier to do if it were a <label> element rather than <strong>. The difference between them looks a bit odd to me:

2017-02-20_143813.png.c5f07fd895566bb2a39bfbc7b74d06e2.png

Also, I'm not sure about this but it looks like the additional fields markup is not placed inside the "InputfieldImageEdit__additional" wrapper div. Is it meant to be?

2017-02-20_143858.png.5041cf6212c38bf8d9d9b230ccdda54d.png

 

Edit: one more thing...:)

What is the intention behind this part where the inputfield type is set based on whether or not a textformatter is applied? Is that meant to be a way to choose the type of inputfield you want? What if you would like a Text input but still want a textformatter applied? Maybe the choice between Text and Textarea could be a separate setting alongside the Textformatter dropdown in the table?

Share this post


Link to post
Share on other sites

Hi there,

Little stuck on something and have looked around.

I have used the image field extender module but when I'm outputting images in my gallery I want to check if there is a caption before I output the markup.

How would I go about this?

Thanks

 


echo "<li><img src='{$thumbnail1->url}' alt='{$image1->description}' /><p class='caption'><strong>{$image1->imagetitle}</strong> <em>{$image1->imagetext}</em> <span><br>{$image1->role}</span></p></li> ";

 

Share this post


Link to post
Share on other sites
15 hours ago, Jon E said:

I want to check if there is a caption before I output the markup

I think this can be done with a simple if statement.... Don't have the time to provide a snippet for you at the moment, I'm sorry.

Something like this:

if ($image->caption){
	//Output markup 1
}
else {
	//Output markup 2
}

 

Share this post


Link to post
Share on other sites

@Robin S Thanks for your feedback!

1. Label vs. Strong

I'm totally with you, semantically it should be a label but I had a reason why I wrapped it inside a strong tag:
If you have a multilingual installation, the label of the extra field is no longer the title of the field, it'll look something like this (core behaviour, I tried to stand as close as possible):

<div class="InputfieldImageEdit__core">
  <div class="hasLangTabs langTabsContainer">
    <div class="langTabs ui-tabs ui-widget ui-widget-content ui-corner-all">
      <ul class="ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" role="tablist">
        ... <li>...</li> ... 
      </ul>
      <div class="InputfieldFileDescription LanguageSupport ui-tabs-panel ui-widget-content ui-corner-bottom" data-language="1010" id="langTab_images_34c8cc73419393a219a5cb218ebcc4b2__1010" aria-labelledby="ui-id-13" role="tabpanel" aria-expanded="true" aria-hidden="false">
        <label for="description_images_34c8cc73419393a219a5cb218ebcc4b2" class="detail LanguageSupportLabel">English</label>
        <input type="text" name="description_images_34c8cc73419393a219a5cb218ebcc4b2" id="description_images_34c8cc73419393a219a5cb218ebcc4b2" value="">
      </div>
      <div class="InputfieldFileDescription LanguageSupport ui-tabs-panel ui-widget-content ui-corner-bottom" data-language="1012" id="langTab_images_34c8cc73419393a219a5cb218ebcc4b2__1012" aria-labelledby="ui-id-14" role="tabpanel" aria-expanded="false" aria-hidden="true" style="display: none;">
        <label for="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" class="detail LanguageSupportLabel">German</label>
        <input type="text" name="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" id="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" value="">
      </div>
    </div>
  </div>
</div>

For each language you'll have a label and input field wrapped inside a div tag. The label is the currently selected language.
If you haven't only the description field, it's important to mark the field with a title. I chose the `<strong>` tag because it looked the best comparing with headlines. I didn't want to add additional css or inline styles. 

labels.png.5c7a8252bbc150caa21595cfea168bfc.png

This is how it would look using h1-h4. The `h1` looks most similar to the label, but I don't want to use `h1`'s because semantically it doesn't make any sense at all.
One opportunity would be to use a `label` element if it isn't a multilingual site and a `strong` tag if it is one.  What do you think?

2. Wrapping

On 20/02/2017 at 2:42 AM, Robin S said:

Also, I'm not sure about this but it looks like the additional fields markup is not placed inside the "InputfieldImageEdit__additional" wrapper div. Is it meant to be?

You're right, I'll fix it.

3. type="text" vs textarea

At the moment as soon as a textformatter is applied, `type="text"` will be changed to `textarea`. The idea behind this was that some textformatter like "NewLineToBreak" or "NewLineToListItem" doesn't make that much sense applied to an one liner input element. This could be an additional setting, but I'm not quite sure if it's necessary. I tried to keep it as simple as possible ^_^

  • Like 2

Share this post


Link to post
Share on other sites

Update 2. Wrapping

Thanks! Having a look where this wrapper comes from, I found another hook which fits the module needs much better.

`<div class="InputfieldImageEdit__additional"></div>` is part of the core (wire/modules/Inputfield/InputfieldImage/InputfieldImage.module).

~/Projects/pw/wire
❯ ag __additional
modules/Inputfield/InputfieldImage/InputfieldImage.module
600: <div class='InputfieldImageEdit__additional'>$additional</div>
634: <div class='InputfieldImageEdit__additional'>$additional</div>

Having a further look, `$additional` comes from a hookable method which is just perfect for this module :) :)

$additional = $this->renderAdditionalFields($pagefile, $id, $n);

/**
 * Render any additional fields (for hooks)
 */
protected function ___renderAdditionalFields($pagefile, $id, $n) { }

Using this hook and rewriting a bit, the HTML looks now this way:

<div class="ImageData" style="width: 77%;">
  <h2 class="InputfieldImageEdit__name"><span contenteditable="true">align-left-2x</span>.png</h2>
  <span class="InputfieldImageEdit__info">143 bytes, 44×30 </span>
  <div class="InputfieldImageEdit__errors">..</div>
  <div class="InputfieldImageEdit__buttons">..</div>
  <div class="InputfieldImageEdit__core">..</div>
  <div class="InputfieldImageEdit__additional">
    <div class="InputfieldImageEdit__additional--custom">..</div>
    <div class="InputfieldImageEdit__additional--title">..</div>
    <div class="InputfieldImageEdit__additional--foo">..</div>
    <div class="InputfieldImageEdit__additional--orientation">..</div>
    <div class="InputfieldImageEdit__additional--link">..</div>
  </div>
  <input class="InputfieldFileSort" type="text" name="sort_images_34c8cc73419393a219a5cb218ebcc4b2" value="0">
  <input class="InputfieldFileReplace" type="hidden" name="replace_images_34c8cc73419393a219a5cb218ebcc4b2">
  <input class="InputfieldFileRename" type="hidden" name="rename_images_34c8cc73419393a219a5cb218ebcc4b2">
</div>

 

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