cita/image-cropper

CitaNZ's image cropper for SilverStripe 4

Maintainers

Package info

github.com/CITANZ/image-cropper

Language:JavaScript

Type:silverstripe-vendormodule

pkg:composer/cita/image-cropper

Statistics

Installs: 430

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 10

Security

Advisories: 0

Aikido package health analysis

2.0.3 2021-08-07 04:15 UTC

Requires

MIT 91d6781cd81048aba1cc889b69512d0333bd8439

cropperjsimage croppercropper toolsilverstripe image cropper

This package is auto-updated.

Last update: 2026-06-05 17:28:24 UTC

README

It's a continious development of Salted Herring's Cropper Field for SilverStripe - 4 (https://github.com/salted-herring/salted-cropper)

Usage

  1. Install
composer require cita/image-cropper

  1. /dev/build?flush=all

  2. Sample code:

    ...
use Cita\ImageCropper\Model\CitaCroppableImage;
use Cita\ImageCropper\Fields\CroppableImageField;
...
private static $has_one = array(
    'Photo'     =>  CitaCroppableImage::class
);


public function getCMSFields()
{
    $fields = parent::getCMSFields();
    ...
    // adding a free cropper
    $fields->addFieldToTab(TAB_NAME, CroppableImageField::create('PhotoID', A_TITLE_TO_THE_FILED));

    // adding cropper with ratio
    $fields->addFieldToTab(TAB_NAME, CroppableImageField::create('PhotoID', A_TITLE_TO_THE_FILED)->setCropperRatio(16/9));
    ...
    return $fields;        
}

  3. Add image > upload/select > save > edit > do your cropping > save

  4. Output

    $Photo
$Photo.Cropped
$Photo.Cropped.SetWidth(100)

AWS support

If you are using SS's S3 assets module to store your images, you may also want to add this into your site's config yaml

SilverStripe\Admin\LeftAndMain:
  extra_requirements_javascript:
    - 'resources/vendor/cita/image-cropper/client/js/s3-workaround.js'