Jump to content
adrian

Tracy Debugger

Recommended Posts

Hey @bernhard and anyone else who might be interested. Following up on my thoughts over here: 

Here's my first test:

cN2HuqqpHQ.gif.2dd012031f190c034de37754f9aaa2f0.gif

 

This comes from a new file which currently contains:

var getCodeSnippets = function() {
    return [
        {
          content: 'd(\\$pages->find("template=\${1:basic-page}")->each("\${2:title}"));',
          name: 'find-pages',
          tabTrigger: 'pwfind'
        }
    ]
};

 

I feel like there needs to be some thought put into how these should work and what the tabTrigger text should be. As you can see this one is about directly d() 'ing, but I am not sure whether it would be more versatile without that wrapping d(). Perhaps we could have both versions?

Maybe we also want something that simply returns:

foreach($pages->find("template=basic-page") as $p) {
    d($p);
}

 

I am really not sure what approach to take here.

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

Thanks!
 

  • Like 1

Share this post


Link to post
Share on other sites
Quote

or would you prefer being able to define your own in a file or in the config settings? 

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Share this post


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

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Sorry, not sure I understand how this makes things cross editor compatible. 

Honestly I think that all these should probably be in the core. After-all we have the actual snippets panel for you to define and use your own custom ones that others may not find useful.

  • Like 1

Share this post


Link to post
Share on other sites

ACE also comes with a bunch of predefined PHP snippets.

image.png.ff88750ba4cf40080afb8b4e82a77212.png

image.png.034b9b67403a561f549ec843b0c891f3.png

This will all be available in the next release of Tracy.

  • Like 1

Share this post


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

Maybe tracy could even be built a little differently to support 3rd party modules. Just like you did recently with the admin actions module (https://processwire.com/talk/topic/14921-admin-actions/?do=findComment&comment=173496). I'm not requesting this, I'm just thinking out loud here.

Hey @bernhard - sorry I forgot to respond to this before. This is certainly a possibility if there is demand. The advantage of course is that panel authors can maintain the codebase for their panel completely without relying on me to handle PRs etc. The downside is that new Tracy users needs to hunt around to find third-party panels so if we take this approach we'll want to make sure to list them all on a dedicated page on the docs site.

Let me know if anyone out there is interested in this.

Share this post


Link to post
Share on other sites

OK, just released a major new version: 4.12.0

 

1) New Title/View link in Dump tabs, so ID is edit link and title/name is view link

image.png.4e3e74a1eccf862d03727692811409e6.png

 

2) New PagePermissions section added to PW Info panel:

image.png.e67e362f0c591f22edc76a11e9600723.png

 

3) New PHP and custom PW autocomplete snippets added to the Console and File Editor panels. Here's one example, but there are others in the posts prior to this one showing general PHP snippets.

Currently there are two custom PW snippets: pwforeach and pwfind - I'd love to hear what you guys want to see here. If you have new snippet ideas, please take a look at: https://github.com/adrianbj/TracyDebugger/blob/master/scripts/code-snippets.js and feel free to send PRs with new additions.

UPmNZ6c7kf.gif.d0b9e73ed018e3e68fff9876f1e89159.gif

 

4) Ability to dynamically resize the font in the Console and File Editor panels with:

Increase: CTRL + +/=
Decrease: CTRL + -/_
Reset: CTRL + 0

 

5) Changes to the way the Console panel divs are structured and resized - please let me know if you see any issues with the results panel protruding beyond the bottom of the panel or any other issues. It's still not perfect, but it's breaking my brain 🙂

 

6) Some minor Tracy core updates and also general cleanup of many of the custom panels.

 

Please let me know if you have any problems with this new version, or ideas for improvements!

  • Like 5

Share this post


Link to post
Share on other sites
Quote

New PHP and custom PW autocomplete snippets added to the Console and File Editor panels

Thanks fly out for it. Going to edit some of my pages with this and report back.

  • Like 1

Share this post


Link to post
Share on other sites

Great additions as always! Thanks for the tutorial on building panels, I'll try that when I have an idea for something 🙂

9 hours ago, adrian said:

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

IMHO the best would be to have one shared file in the core and one file specific to each user, because habits are different so I think not all snippets will be helpful to everybody. On the other side it would be great (not to say necessary) to be able to define those snippets somewhere shared across multiple installs of tracy, so that we always have all our snippets available.

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

If you are happy with that idea I can try to implement that feature and do a PR

  • Like 2

Share this post


Link to post
Share on other sites
17 minutes ago, bernhard said:

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

I was actually thinking along those lines as well, but I do want to encourage PRs to main file that comes with Tracy as well.

But yeah if you want to add support for pointing to a Github gist URL, or any other URL I suppose, I think that would be a nice addition.

Share this post


Link to post
Share on other sites

I think we should be careful with those snippets. One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive. I'll see when I find time to dig into that!

  • Like 3

Share this post


Link to post
Share on other sites

Ok, I have implemented the ability to link to your own custom snippets file:

image.thumb.png.8034531982094be4c2829ecdd88a205d.png

If you're using a Github Gist, make sure you use the https://rawgit.com/ service because the raw file from Github is served without the correct mime type and won't work. 

The format of the custom snippet file is like this. Note the getCustomCodeSnippets() compared with the core snippets file which uses getCodeSnippets()

var getCustomCodeSnippets = function() {
    return [
        {
          name: "pwfind",
          content: "d(\\$pages->find(\"template=\${1:basic-page}\")->each(\"\${2:title}\"));",
          tabTrigger: "pwfind"
        },
        {
          name: "pwforeach",
          content: "foreach(\\$pages->find(\"template=\${1:basic-page}\") as \\$p) {\n\td(\\$p);\n}",
          tabTrigger: "pwforeach"
        }
    ]
};

At the moment the custom snippets file is PHP only. I don't think we will ever need other languages for this.


I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

If you want to peruse the available ACE core snippets, the best way is probably here: https://github.com/ajaxorg/ace/blob/master/lib/ace/snippets/php.snippets 

You can also check out the snippets for other languages in the parent folder of that file.

 

  • Like 3

Share this post


Link to post
Share on other sites
23 minutes ago, adrian said:

What do you guys think of me adding things like this:

To be honest, I would not care too much about it (I guess). I'll have to think of it during further usage of the console. If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be). Otherwise you'd get plenty of requests to keep everything up to date, I'm afraid. But maybe others think differently...

What annoys me, though, are suggestions like this:

A11PnOr.png

Would it be somehow possible to prevent those suggestions of php functions when I actually want to access an object property/method? Thx

  • Like 1

Share this post


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

If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be).

Yeah, already done on my dev copy - all PW variables are automatically added to the autocomplete.

bFDXXA2w3E.gif.227e25a80f2a945998748d7021bdadb8.gif

 

8 hours ago, bernhard said:

What annoys me, though, are suggestions like this:

Agreed - I am working on this - I don't necessarily want to disable php autocompletions completely, but trying to tweak the triggering so it's not invasive when you don't want it.

  • Like 2

Share this post


Link to post
Share on other sites

Or perhaps this is even cleaner for the plain PW variables when they are not actually snippets:

3c5rQ1tTEV.gif.9e18aa018f149a4cd18347660d1d104d.gif

Share this post


Link to post
Share on other sites

Also just got this working, all generated automatically from the currently PW install, so it's always up-to-date.

Do you guys think you'd make use of this?

image.png.dfcf093aecb0c631d236908f56df4209.png

  • Like 6

Share this post


Link to post
Share on other sites
Quote

One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive.

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

I noticed that this editor has much lesser lag compared to other editors I use who update edited code through ftp. I like the update speed of this editor when you click on save. I also like that it shows hidden formats like empty space and new line to spot any other format that might got in when copying and pasting code from your own snippets.

The Increase: CTRL + works very nice to increase editors font size.

Also like it a lot that the editors window can sticky float anywhere in the backend window.

Quote

I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

I saw it in action when I was editing some css. I even noticed a little red box with a white cross that indicates typos made when editing. That is just great.

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

 

Share this post


Link to post
Share on other sites
13 hours ago, pwired said:

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

Agreed - I don't want either the Console panel or FileEditor panel to slow down at all - I'll make sure that any autocomplete/snippet stuff I add doesn't cause any slowdown.

Glad that in general you enjoy using these tools.

13 hours ago, pwired said:

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

The best way to change the editor color is to use the built in themes. I actually haven't included any other themes with the Tracy package, but I could easily add these and create a new module config setting so you can choose the theme - there are a lot of options - check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

  • Like 1

Share this post


Link to post
Share on other sites
Quote

check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

Hi,

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

 

image.png.8e0a7250d5554c759a66237fa74e97d1.png

 

 

Share this post


Link to post
Share on other sites
3 hours ago, pwired said:

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested. I initially went with just one theme (my favorite) because I wasn't sure how much use the Console and File Editor panels would get, but given their popularity I think it probably makes sense to include all the themes so you guys can choose what you prefer.

I guess the next question is to figure out whether you guys want to be able to adjust all ACE editor settings via a textarea with key:value pairs or whether I should provide the key settings I think you might want to adjust as dedicated fields in the module settings like I have with the tab size, type and show invisibles settings. What does everyone think?

  • Like 1

Share this post


Link to post
Share on other sites

Is this going too far having the doc comment displayed? It's a good learning tool. Maybe make it optional, or do you guys think just leave it out completely?

qtY05Agimd.thumb.gif.d6c3a62727ebce59e8d27b2ae00efdfa.gif

  • Like 1

Share this post


Link to post
Share on other sites
Quote

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

The TracyDebugger editor can sticky float anywhere and has a full screen toggle which makes it very practical,
so I guess more people are going to pick it up.
Would be nice to have a few themes because everybody experiences different colors as hard colors for the eyes to work with.
Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

  • Like 1

Share this post


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

Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

Thanks but it's super easy. Just before I do I need to decide how to facilitate the various Ace settings like I mentioned above. 

  • Like 1

Share this post


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

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

It doesn't look like they are massive (size), so, maybe yes, one or two more. I'm happy with the dark theme, so I am biased 🙂.

  • Like 3

Share this post


Link to post
Share on other sites
Quote

It doesn't look like they are massive (size), so, maybe yes, one or two more.

I think Kongondo has a point there. To prevent bloat creeping in, maybe it would be an idea to leave it up to the user which theme to get inside the ace-editor folder ?

In the ace-editor folder I noticed the file: theme-tomorrow_night.js

Just the possibility to let users change this file manually into another one e.g. theme-iplastic.js, and also manually edit font size, maybe that would be a bloat free solution ?

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