Jump to content
Soma

MarkupSimpleNavigation

Recommended Posts

Pete, i think you want to use the markup cache in PW to do simple caching to your needs.

Share this post


Link to post
Share on other sites

Soma - thanks for building this module, it's the first time I have come across this in the forums and should save a fair bit of time when rapid prototyping. Good documentation too.

Share this post


Link to post
Share on other sites

Pete, i think you want to use the markup cache in PW to do simple caching to your needs.

Yeah, my original thought was to somehow make this a checkbox config option in your module to keep things really simple, but it would only be a few minutes' work to cache it in the template anyway :) Of course, if you wanted to cache it properly, say for a day or more you'd want it to rebuild the menu and re-cache it whenever a page is saved to be on the safe side, so whilst my original idea seemed simple it's actually a bit more complicated than that ;)

Share this post


Link to post
Share on other sites

Hi, thanks for this module, everything work as i wanted except that

$treeMenu = $modules->get("MarkupSimpleNavigation"); // load the module

echo $treeMenu->render();

dosnt get all the pages. It shows all pages except the root page. Am im missing something or did i misunderstand something?

Simon

Share this post


Link to post
Share on other sites

Hi gottberg!

To include the root page you would pass the option "show_root" like:

echo $treeMenu->render(array( "show_root"  => true ));

Share this post


Link to post
Share on other sites

Hi gottberg!

To include the root page you would pass the option "show_root" like:

echo $treeMenu->render(array( "show_root"  => true ));

Thank you! Worked like a charm! :)

Share this post


Link to post
Share on other sites

I just commited an update, with improvements to simplify module code.

Originally fixing an issue with "has_children" behaviour. Which now works also with custom selector (that would ommit pages by template) and max_levels as expected. It will now only append if there really is children to be shown.

Also fixed and updated some documentation.

Thanks

  • Like 1

Share this post


Link to post
Share on other sites

Hi Soma,

Thanks for this plugin. I'm just putting it through the paces, and I noticed something related to the "has_children" behavior your mentioned above.

If you specify something like:

'selector' => 'parent!=1011'

The "has_parent" class isn't appended on the first level, but deeper than that it shows back up.

For example, there's no "has_parent" appended for 1011 for:

/
/about-us/
etc...

But it does get appended for something like:

/about-us/meet-the-staff/
etc...

Maybe I'm doing something wrong and need to set something differently in the options array, but from what I can tell this doesn't seem like the behavior you intended.

:)

Share this post


Link to post
Share on other sites

renobird, can you give me more to chew? Code you use for the navigation, and the output? Feel free to send me pm if you don't want to post here.

I think you mean "has_children" because there's no "has_parent" :)

Share this post


Link to post
Share on other sites

Hi Soma,

Sorry, meant "has_children". :)

<?php $treeMenu = $modules->get("MarkupSimpleNavigation");
$options = array(
  'parent_class' => 'parent', // string (default 'parent') overwrite class name for current parent levels
  'current_class' => 'current', // string (default 'current') overwrite current class
  'has_children_class' => 'parent', // string (default 'has_children') overwrite class name for entries with children
  'levels' => false, // bool (default false) wether to output "level-1, level-2, ..." as css class in links
  'levels_prefix' => 'level-', // bool (default 'level-') prefix string that will be used for level class
  'max_levels' => 3, // int (default null) set the max level rendered
  'firstlast' => true, // bool (default false) puts last,first class to link items
  'collapsed' => false, // bool (default false) if you want to auto-collapse the tree you set this to true
  'show_root' => true, // bool (default false) set this to true if you want to rootPage to get prepended to the menu
  'selector' => 'parent!=1011', // string (default '') define custom PW selector, you may sanitize values from user input
  'outer_tpl' => '<ul id="nav" class="clearfix">||</ul>', // template string for the outer most wrapper. || will contain entries
  'inner_tpl' => '<ul>||</ul>', // template string for inner wrappers. || will contain entries
  'list_tpl' => '<li%s>||</li>', // template string for the items. || will contain entries, %s will replaced with class="..." string
  'item_tpl' => '<a href="{url}">{title}</a>', // template string for the inner items. Use {anyfield} and {url}, i.e. {headline|title}, if field is of type image it will return url to image (first image if multiple)
  'item_current_tpl' => '<a href="{url}">{title}</a>' // template string for the current active inner items.
)
?>

Called like so:

<?=$treeMenu->render($options);?>

Let's say I have this nav structure (simplified):

home

portfolio
--project 1
--project 2
--project 3
--project 4
--project 5
etc...

about-us
--meet the staff
--history

services
--stuff we do
--more stuff we do

contact us

The "portfolio" page is the one I want to omit children from because it could have a lot of children, and the drop down menu gets too long.

'selector' => 'parent!=1011' corresponds to that page.

What happens now is that if I visit:

/portfolio/

There is no "has_children" appended.

But if I visit:

/portfolio/project-1

the "has_children" class shows up again.

Share this post


Link to post
Share on other sites

Bah! I spotted it as soon as I posted this code.

My "parent_class" and "has_children_class" are set to the same thing. That's what is causing it to act like it's showing up again.

My apologies for the wild goose chase.

*Bad Renobird, Bad...*

Share this post


Link to post
Share on other sites

Hah! That happens regularely including myself. :D

The behavior (if set right) I think is correct. ( After all it's surely possible I missed something while testing )

So if you ommit pages by saying "parent!=1002", the page 1002 will have no "has_children" as there's no children to be rendered in the menu.

It will only append the "has_children" class to items that really have children show up in the navigation at some point, cutting of at the max_levels or if excluded by a selector. Only side effect of it I noticed recently is if you have two navigation (top, sidebar) and set the top to max_levels 1, and render the rest of the navigation on a separate call in the sidebar. The top level won't have "has_children" class appended. But I don't know if that would make sense, needed or even possible with this apporoach. :)

Share this post


Link to post
Share on other sites

Thanks Soma,

Again, apologies for the false alarm.

I do have another (hopefully legitimate) question. Is there a way to optionally suppress the href attribute on top level parent items?

Meaning, if the "has_children" class is set then the href for that top level item would be set to href="#"

A lot of times I find that the parent items are just containers for the children. So if you link to them, there really isn't a need to have anything there.

There's a great Textpattern plugin (adi_menu) that has this functionality, and I've just realized how much I use it.

Share this post


Link to post
Share on other sites

I would take this route...

Make the "container" pages you're saying having a template "redirect", with only a single page field "redirect_page" with pagelistSelectMultiple input

Then have the template file code:

$session->redirect($page->redirect_page->url);

or how about "redirect-to-firstchild".

$session->redirect($page->children->first()->url);

Edit:

Another option would be to use javascript to set urls of first level to "#".

  • Like 1

Share this post


Link to post
Share on other sites

I've used JS to suppress those links in the past.

I've just always wondered how it effects search engine results, since the url still actually gets displayed, so the page will get crawled.

If it's set to '#", then it's basically invisible. :)

I'll explore the redirect route, I think that would solve any issue with "dead" URL's floating around.

Thanks.

Share this post


Link to post
Share on other sites

Would there be an easy way to use MarkupSimpleNavigation and maybe something like in_array()(?) to check if an ID (that will come from a GET so we must test it) was the same as one of the pages that the navigation would normally display?

I assume one initial step would be working out if I can configure the options for MarkupSimpleNavigation so it only returns the IDs of pages (no markup) and it returns all pages one would want the public to see, the same list one would have in a sitemap.xml.

I'll take a longer look at the options the very good documentation has to see how I might do this.

Update:

Progress, this


$options = array(
//      'parent_class' => '',
//      'current_class' => '',
//      'has_children_class' => '',
       'outer_tpl' => '',
       'inner_tpl' => '',
       'list_tpl' => '',
       'item_tpl' => '{id}',
       'item_current_tpl' => '',
//        'item_current' => '{title}'
);
echo $nav->render($options);

returns only the IDs (with whitespace, dunno if that matters as regards interpreting the o/p with something like in_array(). I'll see...

Edited by alan

Share this post


Link to post
Share on other sites

Glad you figured it out somehow. Yes I also thought something like this it could work getting only the ids. But this module is usually used for markup generation.

I still don't understand completely what you're trying to do though, you could try this:

$options = array(
	'outer_tpl' => '',
	'inner_tpl' => '',
	'list_tpl' => '{id} ',
	'item_tpl' => '',
	'item_current_tpl' => ''
);
$array_ids = explode(" ",trim($nav->render($options));

Share this post


Link to post
Share on other sites
I still don't understand completely what you're trying to do though

:D Soma, you are in good company if you don't understand what I am doing — I am sure a lot of people feel the same; I don't understand me sometimes ;)

Joking aside, I am trying to check if an ID is for a page that is normally publicly visible or not. I plan to show a short-version permanent link to each page so if someone wants to tweet about (or email easily) a page, they can refer to:

example.com/p/1987

rather than having to refer to

example.com/animals/houses/the-squirrel-house/cheeky-the-red-squirrel-eating-some-cheese

My code uses a GET to check if a visitor has typed

example.com/p/1987

and I want the code to then check that 1987 is a valid page I want to allow sending them too, if not I will 404 or just show a message etc.

Edit: I tried your code like this:

$options = array(
			'outer_tpl' => '',
			'inner_tpl' => '',
			'list_tpl' => '{id} ',
			'item_tpl' => '',
			'item_current_tpl' => ''
);
$array_ids = explode(" ",trim($nav->render($options)));
echo $nav->render($options);

but it looks like list_tpl' => '{id} ' results in {id} {id} {id} {id} {id} {id} {id} etc being output rather than the actual ID numbers — but thank you for the clues I will keep working on it and if I solve this, repost here.

Edit 2: I typo'd, your code works (of course ;)) — thanks again for the help!

If I finish this functionality off I'd like to see if I can make it into a Module(!), but I don't want to get too excited yet, it's not even working ;)

Edited by alan

Share this post


Link to post
Share on other sites

Ah so you're trying to have an id permalink to pages (shortcut). I'm not sure if this woud help but this is how I would solve it.

Normally you would setup your tree to have pages that will be in the navigation, and set pages not in navigation to hidden. From there it would just be a simple check to see if the page (id) requested is not hidden.

if(!$pages->get($id)->isHidden()) $session->redirect($pages->get($id)->url);
else $session->redirect($pages->get($config->http404PageID)->url);

Or you could add a field (checkbox) "not_permalink", and give that to templates you need. You could use it for single pages, or just the parent of a branch. So all children pages will either be shown or not.

if(!$pages->get($id)->parents->has("not_permalink=1") || $pages->get($id)->not_permalink == 0)  $session->redirect($pages->get($id)->url);
else $session->redirect($pages->get($config->http404PageID)->url);

It depend a lot how you setup you page tree and how you make them appear in your navigation, but I'm sure you'll find a very simple solution. I think it can be as simple as a 2 line code and no module would be required.

Share this post


Link to post
Share on other sites

WoW! Thanks Soma, I thought it should be easy with the power of PWs API but my limited and the fun of trying other ways meant I was OK to try other routes such as re-purposing your cool module. Thanks again, I will try out your code here and see what I get!

Share this post


Link to post
Share on other sites

OK, thanks to that code [soma, thank you] without (yet) resorting to using the "not-permalink" option (which may be the way I have to go) the only pages I seem to have problems with are ones where when I try some IDs at random (to see if I can 'break' the system) result in a URL like this and a login prompt:

http://example.com.site/pw/repeaters/for-field-107/for-page-1188/

I'm now looking to see if there is an API way to detect if an ID is 'as a result of a repeater' or 'normal' (if that even makes sense).

Share this post


Link to post
Share on other sites

Since repeaters (pages) are in the admin section hidden. You could exlude them by id of the admin page.

$p = $pages->get($id);

if($p->isHidden() || $p->rootParent->id == 2)  $session->redirect($pages->get($config->http404PageID)->url) 
   else $session->redirect($p->url);;

I think if you want to exlude other branches you could try something like this.

$p = $pages->get($id);
if($p->isHidden() || $p->is("has_parent=2|10|1033")) $session->redirect($pages->get($config->http404PageID)->url);
   else $session->redirect($p->url);

NOt really tested but let me know if it doesn't work out.

Share this post


Link to post
Share on other sites

:D Soma, you are in good company if you don't understand what I am doing — I am sure a lot of people feel the same; I don't understand me sometimes ;)

Joking aside, I am trying to check if an ID is for a page that is normally publicly visible or not. I plan to show a short-version permanent link to each page so if someone wants to tweet about (or email easily) a page, they can refer to:

example.com/p/1987

rather than having to refer to

example.com/animals/houses/the-squirrel-house/cheeky-the-red-squirrel-eating-some-cheese

Allen; judging from a couple of recent threads i scanned your quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

Allen; judging from a couple of recent threads i scanned you're quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

Share this post


Link to post
Share on other sites
Allen; judging from a couple of recent threads i scanned your quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

@SiNNuT you're right, I certainly am trying to solve this, but I'm not hung up on it ;) just interested in finding the answer. And I agree with you about Twitter and that perhaps this is less important now:

Now Twitter self-shortens links <- insert debate if that's good here -> what I am trying to do is perhaps less important, but I like the idea of being able to refer to a page with an alternate, ultra-short, permanent URL.

But often I will still stick to using plain-text (not HTML) email and sometimes I want a short way to refer to a URL in an email. Although this may be an edge case it's enough to make me want to explore if I can do this easily with PW.

Added to that, solving a challenge like this is not only valuable for the resulting functionality, but also it makes me learn, and as I need all the learning I can get (being a bit weak at PHP and API/jQuery style constructions) I kept trying to solve this one.

I just hope one or more of the posts in the thread end up helping someone else, either directly or in some way I had not envisaged.

And thanks for your comments about bit.ly etc, I ended up choosing the Google shortener extension in Chrome a while back after that outage from one of the shortening services. And yes, wherever appropriate I think using full URLs is the best way to go. Cheers!

Share this post


Link to post
Share on other sites

@Soma

...NOt really tested but let me know if it doesn't work out.

Thanks Soma! I will certainly post back to let you know and thanks again for the pointers :D

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