sultonov / yii2-cropper
Yii2 framework widget for uploading and cropping images
Installs: 525
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 1
Language:JavaScript
Type:yii2-extension
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2025-03-01 00:29:41 UTC
README
Yii-Framework extension for uploading and cropping images based on CropperJs.
Readme file in uzbek language: README_UZ.MD
Installation
The preferred way to install this extension is through composer.
Either run
composer require sultonov/yii2-cropper "dev-master"
or add
"sultonov/yii2-cropper": "dev-master"
to the require section of your composer.json
file.
Usage
Once the extension is installed, simply use it in your code by :
use sultonov\cropper\CropperWidget;
<?php $form = ActiveForm::begin(['id' => 'form-profile']); ?>
<?php echo $form->field($model, 'photo')->widget(CropperWidget::className(), [
'uploadUrl' => Url::toRoute('/controller-name/uploadPhoto'),
'width' => 100,
'height' => 300,
]) ?>
<div class="form-group">
<?php echo Html::submitButton('Save', ['class' => 'btn btn-primary']) ?>
</div>
<?php ActiveForm::end(); ?>
Widget has following properties:
Name | Description | Default | Required |
---|---|---|---|
uploadParameter | Upload parameter name | file | No |
width | The final width of the image after cropping | 200 | No |
height | The final height of the image after cropping | 200 | No |
label | Hint in box for preview | It depends on application language. You can translate this message on your language and make pull-request. | No |
uploadUrl | URL for uploading and cropping image | Yes | |
prefixUrl | Prefix URL for uploaded image | No | |
noPhotoImage | The picture, which is used when a photo is not loaded. | Extension default no-image file | No |
maxSize | The maximum file size (kb). | 2097152 | No |
avatar | Circle box for selection area | false | No |
preview | Preview of selection area | false | No |
aspectRatio | Fix aspect ratio of cropping area | null | No |
extensions | Allowed file extensions (string). | jpeg, jpg, png, gif | No |
free | Free box for selection area | false | No |
In UserController:
use sultonov\cropper\actions\UploadAction;
public function actions()
{
return [
'upload-photo' => [
'class' => UploadAction::className(),
'url' => '',
'path' => 'some-path',
]
];
}
Action has following parameters:
Name | Description | Default | Required |
---|---|---|---|
path | Path for saving image after cropping | Yes | |
url | URL to which the downloaded images will be available. | Yes | |
uploadParam | Upload parameter name. It must match the value of a similar parameter of the widget. | file | No |
maxSize | The maximum file size (kb). It must match the value of a similar parameter of the widget. | 2097152 | No |
extensions | Allowed file extensions (string). It must match the value of a similar parameter of the widget. | jpeg, jpg, png, gif | No |
width | The final width of the image after cropping. It must match the value of a similar parameter of the widget. | 200 | No |
height | The final height of the image after cropping. It must match the value of a similar parameter of the widget. | 200 | No |
jpegQuality | Quality of cropped image (JPG) | 100 | No |
pngCompressionLevel | Quality of cropped image (PNG) | 1 | No |
prefixPath | Prefix URL for uploaded image | No |