Code Monkey home page Code Monkey logo

kirby3-thumb-imageoptim's Introduction


The used php lib will most likely not recieve an update for php 8 so I decieded to drop support for this plugin.

Kirby 3 Thumb Imageoptim

Release Downloads Build Status Coverage Status Maintainability
Twitter

Kirby 3 CMS Thumb Component to optimize images using ImageOptim Api.

Commercial Usage


Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

โ€ Bruno
ย 
M O N E Y
Github sponsor Patreon Buy Me a Coffee Paypal dontation Hire me

Installation

  • unzip master.zip as folder site/plugins/kirby3-thumb-imageoptim or
  • git submodule add https://github.com/bnomei/kirby3-thumb-imageoptim.git site/plugins/kirby3-thumb-imageoptim or
  • composer require bnomei/kirby3-thumb-imageoptim

Requirements

Setup

In your site/config.php options set the ImageOptim API key.

'options' => [
    'bnomei.thumbimageoptim.apikey' => 'YOUR_API_KEY_HERE',
    // ... other options
]

TIP: You can also set a callback if you use the dotenv Plugin.
'bnomei.thumbimageoptim.apikey' => function() { return env('IMAGEOPTIM_APIKEY'); },

Usage

Generate thumbs as usual using resize() File Method or the srcset() function.

$img = $page->image('ukulele.jpg');
echo $img->resize(234)->html();

If you want your image to be optimized but retain their original size use: $img->thumbimageoptim(). You can providing a width or height but its optional.

$img = $page->image('ukulele.jpg');
echo $img->thumbimageoptim()->html();
// matches
echo $img->resize($img->width())->html();

TIP: if you use $img->resize() without a param you will not generate a thumb and it will not be optimized.

This plugin will work with the Srcset Plugin but be aware that depending on your srcset config a lot of files might be requested to be optimized. The requests are not send aync but one after another waiting for the response. The plugin will discard unfinished requests on next retry.

Settings

bnomei.thumbimageoptim. Default Description
apikey callback or null Your imageoptim apikey as string.
enabled true set to false to disable optimization with this plugin
forceupload false set to true when images are not public available (like a website with htpasswd).
timelimit null or int if int value is set set_time_limit will be called for each request
apirequest array default io_quality and io_dpr values

Localhost and forceupload

Content is always uploaded on localhost. The allow_url_fopen PHP setting must be enabled for the API to do uploading. Check with ini_get('allow_url_fopen'). Please be aware of the potential security risks caused by allow_url_fopen!

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.

kirby3-thumb-imageoptim's People

Contributors

bnomei avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

kirby3-thumb-imageoptim's Issues

make sure file is optimized

... and do not just leave raw copied file around if optimizeation fails/does not finish etc.

if using a cache make sure to flush it on debug.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.