Jump to content
ryan

Map Marker Map

Recommended Posts

OK, I need some help with this. This is my setup:

Dealers

-Australia

--Dealer 1

--Dealer 2

I would like a map on the Dealers page showing a marker for each dealer. Is there a way to have the marker link go to an anchor tag I have set for the country heading on the same page?

echo "<div id='map'></div>"; //div to show in template map

$js = "<script type='text/javascript'>";
$js .= "RCDMap.options.mapTypeId = google.maps.MapTypeId.ROADMAP;";
$js .= "\nRCDMap.init('map', 0, 0);";

$dealers = $pages->get("/dealers/")->find("template=dealer");
foreach($dealers as $marker) {
$js .= "\nRCDMap.addMarker('{$marker->title}', '{$marker->url}', {$marker->map_marker->lat}, {$marker->map_marker->lng});";
}
$js .= "\nRCDMap.fitToMarkers();";
$js .= "</script>";
echo $js;

Share this post


Link to post
Share on other sites

It should be that second argument to RCDMap.addMarker, where you could specify whatever URL (or anchor) you want:

RCDMap.addMarker('some title', '/some/url/', lat, lng);

RCDMap.addMarker('some title', '#some_anchor', lat, lng); 

Share this post


Link to post
Share on other sites

Ugh, thanks Ryan, it seems so obvious now....in my defence, it was late last night I posted that.

Although how would I grab the anchor link of the parent of each marker i.e. #australia rather than #dealer1?

Edit: Got it!

$js .= "\nRCDMap.addMarker('{$marker->title}', '#{$marker->parent->title}', {$marker->map_marker->lat}, {$marker->map_marker->lng});";

Share this post


Link to post
Share on other sites

In the admin the map doesn't load fully if the field is set to be collapsed on page load. I think it is because width is set as 100% rather than setting a size explicitly.

.InputfieldMapMarkerMap {
width: 100%;
height: 300px;
}

35343fq.png

Share this post


Link to post
Share on other sites

Another factor is that I don't think the MapMarker works when placed in other tabs. I think gmaps probably just needs to be visible when the editor is rendered in order for everything to work optimally.

Share this post


Link to post
Share on other sites

Yep, there is a problem when gmap is hidden. This happened to me on the frontend of a site where I was using jqueryUi to show the map, and apparently it's very common with lightboxes. The problem is that, if you are using display: none; to hide the map, it first gets rendered with 0px size, and this is what jquery's .hide() uses. The solution would be to use visibility:hidden; or position it absolutely outside of the screen instead. But I think this wouldn't be easy to do in the admin, since it's using jqueryUi...

  • Like 2

Share this post


Link to post
Share on other sites

I have recently also a problem with the plugin. The address will not be geocoded.

How can I set the value status from my own form?

$mitgliedPage->geocode->address = $form['strasse'].', '.$form['plz'].' '.$form['ort'];
$mitgliedPage->geocode->status = ...?

Thank you for your help and the great work here!

Share this post


Link to post
Share on other sites

To Geocode from the API side, you need to set the address field and save the page:

$page->map->address = '411 Holly Road, Hopkins, MN';
$page->save();

If that doesn't do it, you may sometimes need to give $page a hint:

$page->trackChange('map');
$page->save();

If it still doesn't work, you might want to double check that your PHP install supports allow_url_fopen.

The 'status' field is not meant to be set by you. It is set by Google Maps geocoder.

Share this post


Link to post
Share on other sites

ryan - this is an amazing module! I'm just using it on a website I'm building and it is spot on :)

Just a note to others: I originally had a separate Address field, but you don't need that with this module. I wasn't sure how much you could customise the address input, but you can do whatever you like within reason.

What I mean is Google is pretty forgiving - you can put things like "Somewhere over the rainbow, Rydal, Ambleside, LA22 9LX" then it will just take the parts of the address it understands and find the location from that which essentially allows you to begin the address however you like (useful if you want to put a specific brand name or other title in there at the beginning). What you can't then do of course is drag and drop the pin as the address changes again, but so far the pins have been spot on for me since they're using UK postcodes and I'm picking items in the wilderness for now.

I've also been putting commas in so that when I output the address on the page it can do a new line in the address based on the commas.

  • Like 1

Share this post


Link to post
Share on other sites

I've also been putting commas in so that when I output the address on the page it can do a new line in the address based on the commas.

Thanks, Pete. You just saved me a load of work. (Why didn't I think of that?)

Share this post


Link to post
Share on other sites
What you can't then do of course is drag and drop the pin as the address changes again, but so far the pins have been spot on for me since they're using UK postcodes and I'm picking items in the wilderness for now.

If you uncheck the checkbox separating the address and the lat/lng boxes, you can adjust the coordinates separately from the address, or vice versa.

  • Like 1

Share this post


Link to post
Share on other sites

Ah, didn't see that - that's even better :D

Share this post


Link to post
Share on other sites

The above uses my RCDMap class. Feel free to grab it if you find it helpful. You'll want to view the source on any of those URLs above to see how it works. http://www.di.net/al...ripts/RCDMap.js

An addition to the RCDMap.js to contol the zoom level if there's only one marker ( ryan script needs at least 2 markers to set the zoom level, wich is nice if you've more then one marker )

Just replace the fitToMarkers at the bottom of the script & it wil work for 1 marker with zoom level 10, or the zoom level depending on multiple markers.

fitToMarkers: function() {
   if(RCDMap.numMarkers == 1 ) {
       RCDMap.map.setZoom(10);
   } else {
       var bounds = new google.maps.LatLngBounds();
       for(var i = 0; i < RCDMap.numMarkers; i++) {
           var latLng = RCDMap.markers[i].position;
           bounds.extend(latLng);
       }
       RCDMap.map.fitBounds(bounds);
   }
}
  • Like 1

Share this post


Link to post
Share on other sites

Hi ryan

Just tried to integrate the MapMarker address field with search and it won't let me. Am I doing something wrong?

My selector is as follows:

$matches = $pages->find("map_marker.address%=$q, limit=50"); 

I think I might just be being thick :)

Share this post


Link to post
Share on other sites

FieldtypeMapMarker doesn't implement a getMatchQuery method, which is required in order to support any operators that don't exist in MySQL. For instance, MySQL knows what "=" and ">" are, but it doesn't know what "%=" is. So I'm guessing you are getting a "Operator '%=' is not implemented in FieldtypeMapMarker" error message.

The second issue is that there isn't actually a field named 'address' in the DB, as this fieldtype represents it with the default 'data' field. Meaning you would just refer to it as "map_marker" (or whatever you field name is) rather than "map_marker.address". But the truth is, since we're using 'address' as in this Fieldtype at runtime, we really should allow it for queries too. Try adding this to your FieldtypeMapMarker.module, which should solve both issues: 

public function getMatchQuery($query, $table, $subfield, $operator, $value) {
  if(!$subfield || $subfield == 'address') $subfield = 'data';
  if($operator != '%=') return parent::getMatchQuery($query, $table, $subfield, $operator, $value); 
  $ft = new DatabaseQuerySelectFulltext($query);
  $ft->match($table, $subfield, $operator, $value);
  return $query;
}
Let me know if that works out for you, and I'll add it to mine too. I'm also going to add a fulltext index to the 'data' field so that we can use other partial match operators. 
 

Share this post


Link to post
Share on other sites

Perfect - works for me :)

So is that function basically useful for any module that implements its own tables if you want such a field to be searchable?

Share this post


Link to post
Share on other sites

Ah, except I have two issues that I suspect are more general Selector issues.

If I'm searching for the partial word "test" but the actual word is "testing" for example, it won't return a result. I thought it might be a length limitation, but I even tried "testin" without the G and it doesn't work no matter which selector I try. :(

The other issue is postcodes. I have a post code (zip code) in the map marker field that goes something like "LA22 X99". Typing in either LA22 or X99 returns nothing :( Is it possible they're too short? I seem to remember something about mySQL defaults limiting short word searches so this one might not be a bug :)

Share this post


Link to post
Share on other sites

I think you hit here some full text mysql stopwords or number get filtered out and it's too short :)

Share this post


Link to post
Share on other sites

I think Soma's right. The %= selector works for postcodes and part postcodes cos it doesn't use the fulltext index. It's a bit less versatile than a fulltext search and it is a bit slower but I have it searching about 7000 pages with no noticeable speed issues. (Even 'slow' mySQL is still fast.)

Share this post


Link to post
Share on other sites

What I mean though is that %= doesn't work for me, so it's likely a length issue I need to change in my mySQL config like Soma said.

Share this post


Link to post
Share on other sites

Hmmm, %= doesn't use fulltext indexes (indices?), so word length shouldn't matter.

Share this post


Link to post
Share on other sites
If I'm searching for the partial word "test" but the actual word is "testing" for example, it won't return a result. I thought it might be a length limitation, but I even tried "testin" without the G and it doesn't work no matter which selector I try.

Since it's using LIKE in this case (rather than fulltext) it won't matter. 

I just tested it out here on the skyscrapers profile. These queries worked for me:

$pages->find("map.address%=peachtree"); // returned all skyscrapers on peachtree road
$pages->find("map.address%=pea"); // returned the same thing
$pages->find("map.address%=191"); // Returned "191 peachtree road" skyscraper

Try grabbing the latest version of FieldtypeMapMarker. I updated it to have the new getMatchQuery method. I also modified it a bit so that it supports ^= and $=, and all the fulltext searching operators. Though the fulltext operators will only work on newly created fields, since existing installs won't have a fulltext index. But like DaveP said, you'd have to have a very large quantity of items before you'd see the speed difference. 

Share this post


Link to post
Share on other sites

Hi!

I just came across a strange problem and I hope you can help me. It's something that worked before, but suddenly stopped working. As far as I know I did not change the code in any way,

Ok, here we go:

I use an older version of this module and the module itself works perfectly fine. I use it together with Ryan's RCDMap class (for Google Maps) and the source code generated using the module is:

<script type='text/javascript'>
RCDMap.options.zoom = 4;
RCDMap.options.mapTypeId = google.maps.MapTypeId.HYBRID;
RCDMap.init('map', 60.128162,18.643501);

RCDMap.addMarker('Fotografiska Museet', '/bezienswaardigheden-en-attracties/fotografiska-museet/', 59.319450, 18.077618, 'FFFF00','A');
RCDMap.addMarker('Koninklijk paleis', '/bezienswaardigheden-en-attracties/koninklijk-paleis/', 59.326756, 18.071651, 'FFFF00','B');
RCDMap.addMarker('Skälby', '/bezienswaardigheden-en-attracties/skalby/', 56.682201, 16.336901, 'FF0000','C');
RCDMap.addMarker('Finspångs Slott', '/bezienswaardigheden-en-attracties/finsp-ngs-slott/', 58.709824, 15.770853, 'FF0000','D');
RCDMap.addMarker('Brudfjällsvägen', '/bezienswaardigheden-en-attracties/brudfjallsvagen/', 58.860771, 12.401965, 'FF0000','E');
RCDMap.fitToMarkers();</script>
 

So far no problems...

The RCDMap.addMarker function is:

	addMarker: function(title, url, lat, lng, poicolor, poi_id) {

		var latLng = new google.maps.LatLng(lat, lng);
		
		var marker = new StyledMarker({ 
			styleIcon:new StyledIcon(StyledIconTypes.MARKER,{color:poicolor,text:poi_id}),
			position: latLng, 
			map: RCDMap.map,
		});

		RCDMap.markers[RCDMap.numMarkers] = marker;
		RCDMap.numMarkers++;

		google.maps.event.addListener(marker, 'mouseover', function(e) { 
			RCDMap.currentUrl = url; 
			RCDMap.mapNote.html("<span>" + title + "</span>").show()
				.css('top', '0px')
				.css('left', '0px')
				.css('display', 'block')
				.css('width', 'auto')
				.css('color', '#ffffff')
				.css('background', '#000000')
				.css('padding', '2px 5px 2px 5px');

			$(document).mousemove(function(e) {
				$("#map_note").css({
					'top': e.pageY-10, 	
					'left': e.pageX+15
					});
			}); 

		});

		google.maps.event.addListener(marker, 'mouseout', function(e) {
			RCDMap.mapNote.hide();
			$(document).unbind("mousemove"); 
		}); 

		google.maps.event.addListener(marker, 'click', function(e) {
			window.location.href = RCDMap.currentUrl; 
		}); 
	},
 

The goal is that every marker has its own letter (poi_id) and color (poicolor). This used to work fine, but suddenly something happened and now is every marker getting the same letter and color as the last marker.

The titles, links etc. working fine and are unique for every marker. Any suggestions about what I am missing?

You can see the problem live at: http://www.zwedenweb.com/bezienswaardigheden-en-attracties/

Thanks in advance!

/Jasper

Share this post


Link to post
Share on other sites

I'm not up-to-speed enough on Google Maps to be able to troubleshoot very well. But if it stopped working on its own without there being some change somewhere, then it's got to be related to a change at Google Maps? Still, you might want to put a console.log(poi_id) and console.log(poicolor) in there to monitor and isolate what's going on. It would be nice to know specifically where the info is getting lost. 

  • Like 1

Share this post


Link to post
Share on other sites

Join the conversation

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

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

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

×   Your previous content has been restored.   Clear editor

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


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

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




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

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