cita/image-cropper

CitaNZ's image cropper for SilverStripe 4

Installs: 64

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 1

Open Issues: 7

Language:JavaScript

Type:silverstripe-vendormodule


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'