Jump to content

Recommended Posts

Do you mean in the Inputfield (what you see when editing a ProcessWire page with a Media Manager field) or in the Media Library itself? I ask because there are no tabs in the former. The settings for fields only affect individual fields and are not universally applied to the Media Library (the manager itself). But there was a bug in the former in the text being displayed in the Inputfield and I fixed that in MM version 002.

I grappled with this (the first part of your statement) during development and settled for highlighting the title with a view to revisiting in the future. Will have a look again. As for the Edit and Crop buttons, I don't understand what you mean. Please clarify.

Am not sure I follow. Are you talking about the Media Library or a Media Manager field - Inputfield?

Media Manager displays a notice (success or failure notices) when you select media and click on 'Insert Media'. Are you not seeing this in your tests? As for closing the modal window, the idea is that one may want to insert more media from other Media Library pages not currently in view. Closing the window would mean they have to open the modal again in order to insert the other media. I have explained this in the (upcoming) documentation so as not to confuse users.

Hi Kongondo, apologies for delayed reply...

Fore reference I have MM v0.0.2 and PW dev 3.0.12.

1. Re inputfield - yes I've created a new field and applied to page (only ticked Image when creating the field).  When I then go to edit a page with this field, it says "Allowed Media Types: Image".  If i click Add Media in that field the modal pops up and I see tabs at the top for All, Audio, Document, Image, Video, Upload.  The field type is "Media Manager" - have I used the wrong field type?

2. Yes I don't know the answer for the highlighting - it's probably just something you get used to.  Same with the Edit and Crop buttons - on a dark image you just can't see them unless you hover on the large image on the right hand side.  Again, probably just something that can be trained into users, I'm being picky :-).

3. My ideal workflow for users when editing a page is, open media library from the page field to select an image to insert.  There would be only the images displayed (no All, Audio, Document etc).  To upload a file from that window they could just drag n drop a file to that modal window and it would get added to the image list.  This might be a moot point if I've set up wrong re point 1 above.

4. Yeah I'm seeing the success notifications.  I just can't think of a time when a user would need to do more than one action in that modal window.  If they want to insert multiple images they'd just highlight them all then click Insert (which is what happens now).  If they've done that then they don't need the modal window open any more.  I admit this may not be the workflow for everyone but in the instances I can think of for my users, 95% of the time having the window close on successful insert would be preferable.  I take your point about having multiple pages to scroll through changing this.  I suppose the vast majority of my use cases are inserting only one image per field (ie it's an image field rather than a carousel).  Maybe there could be an "Insert & Close" button in addition to the "Insert Media" button?  Depends whether you think that makes it more cluttered/confusing vs benefit.

Share this post


Link to post
Share on other sites

@Loges

#1: I now get it. When you click the link 'Add Media' the modal it opens is essentially the Media Library part of Media Manager, i.e. ProcessMediaManager, but styled slightly differently from what you see when you directly access the Media Library from the ProcessWire admin menu. I am working on a way to only show navigation/tab items that are relevant to the current field you are inserting to. So, in your case, if you only had images, the only tabs you should see are 'Images' and 'Upload'. If you had allowed, say documents and video, then, you would only see 'Documents Video Upload'. You need a media tab since you would need a way to navigate back to your Media Library  if you went to 'Upload' tab.

#2. Highlighting of the active media (i.e. the media being previewed) has been sorted in MM v003. Did you get my email notification? As for highlighting the crop, edit, icons, that should be sorted with some minimal training. They will always be on the right hand side. :-)

#3 Sort of covered in #1?

#4 I'll look into insert and close

Share this post


Link to post
Share on other sites

Yes I got your email re v3, thanks for that.  Will install tomorrow and have a play around.

Sounds great and thanks for taking it all on board.

Share this post


Link to post
Share on other sites

Media Manager version 004  (released (01/08/2016))

Happy to announce the latest release of Media Manager.

Changelog

  1. FieldtypeMediaManager/InputfieldMediaManager: Configurable setting to insert media in inputfield and close modal. Set in the Details tab of your FieldtypeMediaManager field
  2. Fixed bug where non-allowed media types (for those limiting media types available to InputfieldMediaManager) would still show up in the results in the selection modal. 
  3. Fixed bug where the menu item 'All' would not appear in the InptufieldMediaManager media selection modal even if  allowed media types was limited to at least 2 types
  4. By popular demand, a CKEditor image plugin! mmimage (cloned and adapted from pwimage :) thanks @ryan) lets you insert images in your Media Manager Image Library directly into the rich text editor. See a video demo + instructions here

 

@TODO:

  • Multi-tagging of media
  • Documentation (thanks for being patient with me guys...)

 

  • Like 5

Share this post


Link to post
Share on other sites

Does MediaManager work in repeating fields and if not, is that on the roadmap?

Share this post


Link to post
Share on other sites
On 03/08/2016 at 2:59 AM, Tyssen said:

Does MediaManager work in repeating fields and if not, is that on the roadmap?

Until your question, it wasn't :)....I have made some minor changes to version 005 which now enables this. I'll try and commit this today, if not, then over the weekend. 

Thanks for your interest in Media Manager...

  • Like 3

Share this post


Link to post
Share on other sites

I haven't tried it yet, but this module looks great!

I'm guessing the Media files are stored using PW pages?  Is there any way to add more fields to those PW pages?  For example, I might want to use a text field to store where I got the image from.

I'm also curious how the File Usage works?

  1. Does it just count and list the pages where the media file is used in a media field.
  2. Does it also take into consideration files that have been inserted into text areas?
  3. Does it include pages with text areas that link to the files?

Share this post


Link to post
Share on other sites

Media Manager version 005  (released (07/08/2016))

Happy to announce the latest release of Media Manager.

Changelog

  1. Media Manager in Repeaters: Media Manager (Fieldtype- and InputfieldMediaManager) can now be used in Repeaters with full access to your Media Library.  Demo video and instructions are here.
  • Like 1

Share this post


Link to post
Share on other sites
On 05/08/2016 at 10:00 PM, gmclelland said:

I'm guessing the Media files are stored using PW pages?  Is there any way to add more fields to those PW pages?  For example, I might want to use a text field to store where I got the image from.

I'm also curious how the File Usage works?

  1. Does it just count and list the pages where the media file is used in a media field.
  2. Does it also take into consideration files that have been inserted into text areas?
  3. Does it include pages with text areas that link to the files?

 

Storage:

Stored in page: Yes. Please see the OP, about half-way down

Custom fields: Yes if you add them directly to the templates but you will not be able to edit those custom fields using the MM interface. In addition, MM pages are hidden in the admin so editing your custom fields will not be ideal (or accessible to normal users). Alternatively, you can use images/files native description and tag fields. These are currently editable directly in your Media Library.

File Usage:

  1. It counts the actual usage in FieldtyeMediaManager field in the DB
  2. No
  3. No

Share this post


Link to post
Share on other sites

Hi all,

I'm going to be away for the next couple of weeks (4-5 weeks possibly) with little if any access to the internet. I will deal with any queries on my return.

Thanks

Share this post


Link to post
Share on other sites

I'm having a big issue with the module. When I added an image to my page and I try to get the URL of it, it just returns "null". I've been searching, trying for hours now. 

Share this post


Link to post
Share on other sites
2 hours ago, Jonathan Claeys said:

I'm having a big issue with the module. When I added an image to my page and I try to get the URL of it, it just returns "null". I've been searching, trying for hours now. 

What ProcessWire version are you using with this module and it would greatly help if you would go into more detail about your problem?

Share this post


Link to post
Share on other sites
1 hour ago, cstevensjr said:

What ProcessWire version are you using with this module and it would greatly help if you would go into more detail about your problem?

I'm using version 2.8 of Processwire and I added media to my page. Wich works fine. I do a var_dump of my media and I get back an object with 1 image, wich is also correct. The problem is that the object doesn't include a url. Normally you do: $image->url or $image->size(x, y)->url but this doesn't work on the media I added by the module. And when I just look to the examples on the media manager documentation it should work like that. Or am I overlooking something?

Share this post


Link to post
Share on other sites

@Jonathan Claeys Please provide an example of the code you are using to try and get your media image URL.

I haven't used Media Manager, but looking at the documentation for outputting to the front-end there are a couple of things to be aware of:

1. A Media Manager field returns an array (specifically a 'MediaManagerArray') so you need to treat it as such in your template even if it contains only a single media item. The docs suggest looping over it, but if a MediaManagerArray is also a WireArray (the docs aren't specific about that) then you could use other API methods to get items such as first() or get($key).

2. The media itself (an image in your case) is contained in the media property of an individual MediaManager object. So you need to use methods like url or size() on the media property and not on the MediaManager object.

Assuming that a MediaManagerArray is a WireArray and that your Media Manager field is called my_media_field:

$media_manager_array = $page->my_media_field;
$media_manager_object = $media_manager_array->first();
$image_object = $media_manager_object->media;
$url = $image_object->url;
echo "<img src='$url'>";

This is just to give you the idea, and is more verbose than necessary.

  • Like 3

Share this post


Link to post
Share on other sites
8 hours ago, Robin S said:

@Jonathan Claeys Please provide an example of the code you are using to try and get your media image URL.

I haven't used Media Manager, but looking at the documentation for outputting to the front-end there are a couple of things to be aware of:

1. A Media Manager field returns an array (specifically a 'MediaManagerArray') so you need to treat it as such in your template even if it contains only a single media item. The docs suggest looping over it, but if a MediaManagerArray is also a WireArray (the docs aren't specific about that) then you could use other API methods to get items such as first() or get($key).

2. The media itself (an image in your case) is contained in the media property of an individual MediaManager object. So you need to use methods like url or size() on the media property and not on the MediaManager object.

Assuming that a MediaManagerArray is a WireArray and that your Media Manager field is called my_media_field:


$media_manager_array = $page->my_media_field;
$media_manager_object = $media_manager_array->first();
$image_object = $media_manager_object->media;
$url = $image_object->url;
echo "<img src='$url'>";

This is just to give you the idea, and is more verbose than necessary.

Thanks alot,

I just saw my problem. I didn't see you had to call the method ->media also after you got your image field already. :) That solved the problem. 

  • Like 1

Share this post


Link to post
Share on other sites

I am now back and slowly catching up with issues. Thanks for your patience.

 

Thanks @Robin S for helping out above. @Jonathan Claeys, many thanks for using Media Manager. Please let me know if you need further clarification.

I can confirm that a MediaManagerArray is a WireArray. I have updated the docs to reflect this.

Share this post


Link to post
Share on other sites

This post is in response to some queries I received about Media Manager. I will be improving the documentation in the next couple of weeks.

1. Edit media details 

media-manager-edit-media-details.gif

2. Automatically publishing media on upload

media-manager-upload-publish.png

  • Like 2

Share this post


Link to post
Share on other sites

Media Manager version 006  (released 21/09/2016)

Happy to announce the latest release of Media Manager.

Changelog

  1. mmlink: A CKEditor link plugin (cloned and adapted from pwlink :) thanks @ryan) lets you insert links to the media in your Media Manager Library directly into the Rich Text Editor (RTE). (Instructions on how to setup are similar to those of mmimage as shown in this video. Where it says MMImage/mmimage please replace with MMLink/mmlink respectively, thanks). The plugin is in the folder MediaManager/plugins/mmlink. Please note that currently it is not possible to edit a link's attributes (e.g. rel, target and title). However, a title is auto-inserted in the link (the respective media's title.

Please download latest release of the module from the link in your purchase confirmation email. Let me know if you encounter any issues, thanks.

@TODO:

  • Multi-tagging of media
  • Documentation (thanks for being patient with me guys...)
  • Like 2

Share this post


Link to post
Share on other sites

I have just purchased and installed Media Manager and I have an immediate couple of questions which will determine whether it's actually useful enough for my requirements:

What is the purpose of the image tags? Will it be (or is it already) possible to filter images by a specific tag?

 

I would like to be able to add a whole bunch of images and tag them as 'icons', so that I can filter by that specific tag to see those images only.

If this is not possible, perhaps there's a way to achieve the same result which I'm missing. Please could you help? Thanks.

Share this post


Link to post
Share on other sites

Hi @spacemonkey95. Thanks for the purchase.

Media Tags: The purpose of 'media tags'...is the same purpose as in ProcessWire (please note: all media can be tagged; not just images); namely, to group related media (images, documents, video or audio) to fulfil any number of functions - easier organisation, finding related things, etc. 

Filtering media by tags: Yes, it is already possible to filter images (or any other media) by tags both in the API and in your Media Manager Library (the Process Module). Please see the gif below.

What is pending is the ability to tag multiple media in one go. Currently, one can only tag one media at a time as shown in my post above. This can be tedious, hence the need for multi-tagging capability. I have started work on this new feature but it won't be ready this week but soon. It is also not possible, currently, to sort media by tags (i.e. the display of media in the Media Library - currently sorted by title). I am also working on implementing this.

Hope I've answered your questions.

Filtering media by tags

media-manager-media-tags-filter.gif

Edited by kongondo
clarity...
  • Like 1

Share this post


Link to post
Share on other sites

Hi @kongondo

Our Agency has purchased your Media Manager which is great Module. But I encountered a few Bugs/Problems. 

On localhost (ProDraft, Multilanguage Fields respectively the multilange installation profie of processwire):

1. Can't upload Videos

video fehler.png

2. Cant change or edit Tags field (it always stays empty no matter what i do).

3. The variations problems is also active here

General Problems on Server (Uses Different Hooks, ProDraft, Multilanguage Fields etc...):

1. Cant change or edit Description field (sometimes it works once).

2. Cant change or edit Tags field (it always stays empty no matter what i do).

3. Variations functionality(cropping, changing dimensions etc...) doesnt work (It just makes a exact copy with the same dimensions and adds it to the file/image field of the  page)

When I upload the image

variations3.png

 

When I use the variations functionality

variations2.png

variations.png

 

Don't know if this is usefull for debugging (All Hooks):

	$this->addHookBefore('ProcessHome::execute', $this, 'rootPage');
	$this->addHookAfter("Page::editable", $this, 'setEditAccess');
	$this->addHookAfter("Page::addable", $this, 'setAddAccess');
	$this->addHookAfter("ProcessPageLister::getSelector", $this, 'setListerAccess');
	$this->addHookAfter('ProcessPageList::execute', $this, 'hidePages');
	$this->addHookBefore('ProcessPageAdd::executeTemplate', $this, 'redirectParent');
	$this->addHookAfter('ProcessPageListRender::getPageLabel', $this, 'addTemplateLabel');
	$this->addHookAfter('ProcessPageAdd::buildForm', $this, 'addFields');
	$this->addHookAfter('ProcessPageAdd::buildForm', $this, 'collapseName');
	$this->addHookAfter('ProcessPageEdit::buildForm', $this, 'addLangViewTabs');
	$this->addHookAfter('ProcessPageEdit::getTabs', $this, 'removeDefaultViewTab');
	$this->addHookAfter('InputfieldForm::render', $this, 'renderForm');
	$this->addHookAfter('ProcessPageAdd::execute', $this, 'addScript');
    $this->addHookBefore('WireMail::send', $this, 'fixOutlookMail');
    $this->addHookAfter('Pages::save', $this, 'hookSave');
    $this->addHookAfter('Pages::clone', $this, 'hookClone');

When I deactivate all Hooks the Problems are still there.

 

PS: I deactivated the draft functionality for the media manager templates.

Share this post


Link to post
Share on other sites

Saving Variatons in different Dimension works... I didn't recoginzed the radios.... My bad :D But when I save a variation with the same dimensions it still looses the original.

PS: But the cropping functionaliy also doesn't work. It just copy the original one and looses the original afterwards.

Share this post


Link to post
Share on other sites

Hi @Nukro,

Thanks for the purchase. Apologies for the 'rough start' :-)

1. Uploading Videos:

  • Have you specified .mp4 as an allowed extension? If not, you need to do that under Upload, then Settings Tab, scroll down to Settings: Video > Valid video file extensions
  • What error is returned in the console (in response to the ajax request)?
  • It could be an allowed file size issue. The error returned by the server will shed light on this

2. Editing Tags:

  • Did you enable tags for the 4 media templates? Please have a look at the install instructions here, thanks. I have tried and have so far been unable to programmatically enable tags on install

3. Variations

  • Hmm, that's quite a number of issues. 
  • Cropping: are you using Save as Copy?
  • Are you developing locally or could I get some temporary access to the site to have a look around?

PW version? Currently we don't officially support version 3 until there is an official release (which is soon!)

Edit:

How are you uploading images/media? In your screenshot above I see you are directly editing an image...

 

Edited by kongondo
additional info
  • Like 1

Share this post


Link to post
Share on other sites
21 minutes ago, kongondo said:

Hi @Nukro,

Thanks for the purchase. Apologies for the 'rough start' :-)

1. Uploading Videos:

  • Have you specified .mp4 as an allowed extension? If not, you need to do that under Upload, then Settings Tab, scroll down to Settings: Video > Valid video file extensions
  • What error is returned in the console (in response to the ajax request)?
  • It could be an allowed file size issue. The error returned by the server will shed light on this

2. Editing Tags:

  • Did you enable tags for the 4 media templates? Please have a look at the install instructions here, thanks. I have tried and have so far been unable to programmatically enable tags on install

3. Variations

  • Hmm, that's quite a number of issues. 
  • Cropping: are you using Save as Copy?
  • Are you developing locally or could I get some temporary access to the site to have a look around?

PW version? Currently we don't officially support version 3 until there is an official release (which is soon!)

Edit:

How are you uploading images/media? In your screenshot above I see you are directly editing an image...

 

Thanks for you quick Answer @kongondo

I'm testing the media manager at the moment on localhost with a blank processwire install

1. Uploading Videos:

.mp4 is specified as an allowed extension. I looked into the console and I am getting this error from the ajax call:

variations.png

2. Editing Tags

Thanks. I enabled now the tags for the media manager fields. It works now.

 

3. Variations

For cropping I am using 'save as copy'. It just makes a exact copy of the origin image and afterwards it looses the original one. The same happens when I save(save as copy) the image with the original dimensions.

 

4. Uploading Images/Videos

I'am uploading all the files from the upload tab in the media manager module (jqueryfileupload).

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   1 member

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