sylvainjule/autofocus

Content aware image cropping for Kirby

1.0.3 2022-02-23 16:57 UTC

Requires

• getkirby/composer-installer: ^1.1

MIT

• Sylvain Julé

README

Content aware image cropping for kirby.

Overview

This plugin is completely free and published under the MIT license. However, if you are using it in a commercial project and want to help me keep up with maintenance, please consider making a donation of your choice or purchasing your license(s) through my affiliate link.

Autofocus is an extension for the Focus plugin.

This plugin acts as a JS image.upload hook, processing the / each image with the focus component, determining its appropriate focus point and saving it to the meta data file.

Please note that :

• This is an experimental plugin. The algorithm isn't foolproof, it works best with certain kinds of images, and obviously the more the context of an image is « clear », the more its efficiency increases. I have included a sample test with 30 images, as well as a way to run your own.

• The aim of this plugin is therefore to provide a « better than nothing » fallback to the Focus plugin whenever the editor didn't specify a focus point (omission, too many images, you name it).

• The plugin will only process images uploaded with the files section. It will not process replaced images. Suggestions welcome if you find a way to register a better hook.

Installation

If you are looking to use this plugin with Kirby 2, please switch to the kirby-2 branch.

First, you must install the Focus plugin.

Note : the plugin would still work without it, but apart from adding the focus point to the .txt file, you wouldn't be able to preview / override / use it with the Focus methods.

Once it is done, download and copy this repository to /site/plugins/autofocus

Alternatively, you can install it with composer: composer require sylvainjule/autofocus

Usage

There's nothing else to do.

The plugin will now process any image you upload through the panel, find a focus point, and use the flokosiol.focus.field.key to write the coordinates. Then you can use the Focus plugin as you usually do.

Run tests

I have included a sample test with 30 images.

You can run you own tests to determine if the algorithm suits your needs. One simple way is to add the focus field in your blueprint, so that you can have a preview of where the focus is set for every image you upload.

An other way is to open the index.html of the _test folder in a browser, and upload an image. The images used for calculation will be displayed on the page, as well as the coordinates in the console.

Credits

• @flokosiol for his great help with this extension.
• The focus component is used to determine the focus point on upload.

License

MIT