Jump to content
horst

CroppableImage

Recommended Posts

 

--------------------------------------------------------------------------------------------------------------------------------

                             for PW 3.0+ please follow this link!

--------------------------------------------------------------------------------------------------------------------------------

Croppable Image

Module for PW >= 2.5.11 and PW <= 2.7.3

Version 0.8.3 alpha


Hey, today I can announce an early (alpha) release of CroppableImage, what was forked from Anttis Thumbnails module.

Until now there was a lot of work done by owzim, Martijn Geerts and me.

We have solved the issues regarding the list from here:

  • The modules are bundled together so that you only can and have to use FieldtypeCroppableImage for install, uninstall & configure.
     
  • It uses new naming scheme that was introduced with PW 2.5.0 that supports suffixes.
     
  • The complete image rendering is delegated to the core ImageSizer, or to any optional hooked in rendering engine.
     
  • Template-settings are now fully supported, including removing variations when settings have changed.
     
  • It fully respects settings for upscaling. If upscaling is set to false, you cannot select rectangles smaller than the crop setting.
     

We implemented these enhancements:

  • The GridView now is very nice and compact, and also benefits from the lately introduced setting for $config->adminThumbOptions.
     
  • Permanent storage of the crop coordinates, quality and sharpening settings are now implemented native. No need to use PiM for this anymore.
     
  • The usage/display of the Quality and Sharpening DropDown-Selects can be globally disabled/allowed in the modules Configpage. (additionally to that a setting on a 'per field base' is planned.)

And the most wanted feature by the community: It gives back a pageimage and not the URL-string. This way you can use it like this:

// get the first image instance of crop setting 'portrait'
$image = $page->images->first()->getCrop('portrait');

You can further use every pageimage property like 'url', 'description', 'width' & 'height' with it:

// get the first image instance of crop setting 'portrait'
$image = $page->images->first()->getCrop('portrait');
echo "<img src='{$image->url}' alt='{$image->description}' />";

And you can proceed further image rendering with it:

// get the first image instance of crop setting 'portrait' and proceed a resize with imagesizer
$image = $page->images->first()->getCrop('portrait');
$thumb = $image->width(200);

// or like this:
$thumb = $page->images->first()->getCrop('portrait')->width(200);

// and if you have installed Pia, you can use it here too:
$thumb = $page->images->first()->getCrop('portrait')->crop("square=120");

The only downside with this is that when you (as the site developer) have enabled the usage of DropDown-Selects in the images editor, you do not know the values the editors have chosen for the images.

As a workaround for this you can use the getCrop() method with a second param. This is a PW selector string. It can contain as many of the known pageimage options like 'quality', 'sharpening', 'cropping', etc, as you need, but none of them is required. But required is at least one setting for 'width' or 'height':

$image = $page->images->first()->getCrop('portrait', "width=200");
$image = $page->images->first()->getCrop('portrait', "width=200, height=200, quality=80");
$image = $page->images->first()->getCrop('portrait', "height=400, sharpening=medium, quality=75");

.

.

You can get the module from GitHub: https://github.com/horst-n/CroppableImage

(Better Docs are coming soon)


Screenshots

croppable-image_screens-01.jpg

croppable-image_screens-02.jpg
croppable-image_screens-03.jpg



Related Infos

A good setting in site/config.php for the AdminThumbs are: (height=>200 and scale=>0.5 !)

 

$config->adminThumbOptions = array(
  'width' => 0,
  'height' => 200,
  'scale' => 0.5,
  'imageSizer' => array(
    'upscaling' => false,
    'cropping' => true,
    'autoRotation' => true,
    'sharpening' => 'soft',
    'quality' => 90,
    'suffix' => array(),
  )
);
Edited by horst
added link to new PW 3 version
  • Like 33

Share this post


Link to post
Share on other sites

Thanks to the three of you for you work on this! Can't wait to test - will definitely be using it on a new site that is starting dev in the next couple of weeks. I'll let you know how it goes!

  • Like 2

Share this post


Link to post
Share on other sites

Thanks for this, folks. Looks great, can't wait to give it a try!

As a minor observation, you might want to repeat some of the recent fixes for Thumbnails module here too (strict standards, repeater permissions, etc.)

  • Like 2

Share this post


Link to post
Share on other sites

Very nice! As the thumbnails module got more and more out of date it faded from my default modules list. But I think this will be the replacement mighty soon.

  • Like 2

Share this post


Link to post
Share on other sites

How stable is this version? I plan to try this for a recent project that's going live soon. Thanks for the work put into this!

  • Like 2

Share this post


Link to post
Share on other sites

Would be great to build easy gallery fields with different thumbs or a imagefield for blogposts....really thumbs up.

will test asap!

  • Like 1

Share this post


Link to post
Share on other sites

Hey guys - I have just started using this and have a couple of issue:

Notice the way the image is transparent over the grey info bar?

post-985-0-96098200-1421094173_thumb.png

In thumbnail view, the crop button is not showing.

Also I have two croppable image fields and toggling the thumb/list view buttons on one change the view on the other - not sure if this is related to croppable image or not though.

post-985-0-94478100-1421094099_thumb.png

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Thanks!

Share this post


Link to post
Share on other sites

Hey @adrian, just to clarify:

1) in grid view (thumbnail view) you need to hover over the little headline (width x height), than this changes to "Edit" and you need to  click this to get into a little modal window that holds all crop buttons and all the text inputfields, for e.g. description, tags, etc. Does this not work for you? If not, what browser version you are using?

2) what admin theme are you using?

3)

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Is this related to the list view or the grid view, or both?

Share this post


Link to post
Share on other sites
1) in grid view (thumbnail view) you need to hover over the little headline (width x height), than this changes to "Edit" and you need to  click this to get into a little modal window that holds all crop buttons and all the text inputfields, for e.g. description, tags, etc. Does this not work for you? If not, what browser version you are using?

Good point - sorry I had seen that - I was confusing list view with thumbnails displayed vs grid/thumbnails view. I think it works as you have it, but I think things look a little ugly in list view when you don't have the field set to use thumbnails, but rather the full sized version - maybe that is why I am getting the image centered and overlapping the info bar above?

2) what admin theme are you using?

I am just using the standard default theme - PW 2.5.13

Is this related to the list view or the grid view, or both?

Probably doesn't matter in the popup for the grid view, but in the list view I think it would be more obvious for users, but not a big deal.

Share this post


Link to post
Share on other sites

Ah, I always use Thumbnails in Listview, have tried the fullsize images in Listview a while ago.

Yes, the (unhovered) titlebar is transparent and overlaps the image. Maybe we simply should make it opaque? Or do you think this few lines can be important enough to not get covered?

But anyways, I have to hand this over to @Martijn !

------

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields. ( <= Related to Listview with fullsize images)

Probably doesn't matter in the popup for the grid view, but in the list view I think it would be more obvious for users, but not a big deal.

In Listview with thumbnails I like it as it is now, but in Listview with centered fullsize images it may look a bit better if the buttons are appear directly under the image and centered too, followed by the text inputfields. But I have to give this to @Martijn too :)

  • Like 1

Share this post


Link to post
Share on other sites
Or do you think this few lines can be important enough to not get covered?

I guess I don't understand why the look is different to a standard PW images field - ie opaque and not covering the image - I think it is important to see all the image.

Thanks for looking into these things Martijn!

Share this post


Link to post
Share on other sites

Notice the way the image is transparent over the grey info bar?

 

That's not a bug, it's meant to be like that. This wil result in more visual image and less UI (margin/paddings), it'll save you at least 45px height per image. Making it totally transparent can be an option, but i'm a little bit afraid text and buttons in the header will be hard to read.

 

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Problem is amount of crop variations, the length of the crop text (especially in European languages) and extra vertical space the crop should take due to repetitive buttons. In most cases it'll double the vertical space (I started this way), IMHO it's not an option.

  • Like 1

Share this post


Link to post
Share on other sites

@Martijn: ah, for me this makes sense: saving space with full images.

And with a lot of images so boringly showing repetitive cropnames throws away the focus from the thumbnails.

And that it is visually different from default images field is a plus.

@Martijn: have you also read that if you have two or more croppable fields on one page, toggling the viewmode (list/grid) always affects all fields?

  • Like 1

Share this post


Link to post
Share on other sites

@Martijn: have you also read that if you have two or more croppable fields on one page, toggling the viewmode (list/grid) always affects all fields?

No didn't read that. ( I'm a bad reader :unsure:  ) Oké will look into that, should not be hard to fix I guess....

  • Like 1

Share this post


Link to post
Share on other sites

Is there any particular feature from PHP 5.4 you are using? I think many are using Ubuntu's release cycle (5 year LTS from 2012), where there will be PHP 5.3. for two more years (of course possible to update to 14.04).

  • Like 2

Share this post


Link to post
Share on other sites

I can't remember why it was set to PHP >= 5.4.0.  (@owzim: can you remember it?)

I also have no server with PHP 5.3 at hand. Maybe you (or someone other) can edit the three *.info.json files to point to PHP>=5.3.8 and try if it runs or throws any error?

If not it will take a while for me to get ready testing this. But it is noted on my ToDo now.

Share this post


Link to post
Share on other sites

I could quickly set a shared host account via its config panel to run under PHP 5.3.28 cgi.

The CroppableImage Editor worked, - but I could not test all functions in depth. If you want use it in a none productional site with PHP < 5.4.0, simply change the values in the 3 *.info.json files

// from this
	"requires": "ProcessWire>=2.5.11, PHP>=5.4.0, FieldtypeCroppableImage>=82",

// to this
	"requires": "ProcessWire>=2.5.11, PHP>=5.3.8, FieldtypeCroppableImage>=82",
  • modules/CroppableImage/FieldtypeCroppableImage/FieldtypeCroppableImage.info.json
  • modules/CroppableImage/InputfieldCroppableImage/InputfieldCroppableImage.info.json
  • modules/CroppableImage/ProcessCroppableImage/ProcessCroppableImage.info.json

Share this post


Link to post
Share on other sites

Hello,

first of all thank you for this great module!

I still have a feature request though: It would be even greater if it would be possible to have the option to specify an aspect ratio instead of a pixel width and height. That would make this field perfect for my use case :)

Any chance to get this feature?

Cheers

Share this post


Link to post
Share on other sites

Looks very good guys! Its very good to see that finally the cropping module gets an upgrade!

I would love to be able to add some more (very simple) text fields to the images, in the likes of http://modules.processwire.com/modules/fieldtype-image-extra/ This is something that I think the regular image fieldtype should also include, but maybe you take a lead here :)

(My reason is that right now I'm working on a very media-rich site, with artworks needing titles, descriptions, and 3 distinct handmade crops. Separate pages aren't an option because the drag&drop is so much better. I currently tackled this by splitting the description string, but that seems counter intuitive.)

Share this post


Link to post
Share on other sites

@Eelke Feenstra

Especially for rich media sites I would suggest going for flexibility. So using pages would be the better plan. Drag and drop can still be managed with a pagetable.

Share this post


Link to post
Share on other sites

Hey,

actually there is no time, even not for thinking in depth about this request. But maybe this suites your needs better: https://processwire.com/talk/topic/8079-imagefocusarea/

Reading the description it does look like this one does not have any ratio option either though.

Nevertheless thank u very much for the tipp!  I might install it and check it out anyways.

Share this post


Link to post
Share on other sites

@Michael, dealing with aspect ratio is in most cases more the task of CSS. Could you explain more in depth what you are after, then maybe we can help you with other possibilities. 

Share this post


Link to post
Share on other sites

Not sure it was mentioned somewhere, but I can't find a "cancel" button when on the Editor. I know you can just close the tab/window, but hey I had to think about.

  • Like 4

Share this post


Link to post
Share on other sites

I had this thought with the Thumbnails module, too. I don't even know if clients would notice, that there's a new tab opened.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...