ng-img-editor v1.2.3

Image Cropper for Angular

Features

• NgImgEditor Component Injection without being passed ViewContainerRef
• High performance
• Highly configurable and customizable
• Overridable styles
• Fully Supported

Install

   npm install ng-img-editor --save  
   
   or

   yarn add ng-img-editor

Setup

Step 1:

• Import CSS.

@import "~ng-img-editor/photo-editor.css";

• If you are using angular-cli you can add it to your angular.json

"styles": [
  "styles.scss",
  "node_modules/ng-img-editor/photo-editor.css" // try adding '../' if you're using angular cli before 6
]

Step 2:

• Add NgImgEditorModule to app.module.ts

import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {AppComponent} from './app.component';
import {NgImgEditorModule} from "ng-img-editor";

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgImgEditorModule,
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule {
}

Usage

<input type="file" (change)="fileChangeHandler($event)">
<img [src]="output?.base64" alt="">

And add this to your .ts file:

import {Component} from '@angular/core';
import {NgxCroppedEvent, NgImgEditorService} from "ng-img-editor";

@Component({...})
export class AppComponent {
  output?: NgxCroppedEvent;

  constructor(private service: NgImgEditorService) {}

  fileChangeHandler($event: any) {
    this.service.open($event, {
      aspectRatio: 4 / 3,
      autoCropArea: 1
    }).subscribe(data => {
      this.output = data;
    });
  }
}

You can pass any supported type of parameters to NgImgEditorService.open() to open the cropper. After click Apply button the observer will return an object with the cropped image as a Base64, Blob in its payload.

Parameters

Options

Interfaces

NgxCroppedEvent

viewMode

• Type: Number
• Default: 0
• Options:
  • 0: no restrictions
  • 1: restrict the crop box to not exceed the size of the canvas.
  • 2: restrict the minimum canvas size to fit within the container. If the proportions of the canvas and the container differ, the minimum canvas will be surrounded by extra space in one of the dimensions.
  • 3: restrict the minimum canvas size to fill fit the container. If the proportions of the canvas and the container are different, the container will not be able to fit the whole canvas in one of the dimensions.

Define the view mode of the cropper. If you set viewMode to 0, the crop box can extend outside the canvas, while a value of 1, 2 or 3 will restrict the crop box to the size of the canvas. A viewMode of 2 or 3 will additionally restrict the canvas to the container. Note that if the proportions of the canvas and the container are the same, there is no difference between 2 and 3.