ngx-photo-editor

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

ngx-photo-editor

★ 26 Open GitHub ↗

Angular Photo Editor

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Image Cropper for Angular
[![NPM version][npm-img]][npm-url]
[![The MIT License][license-img]][license]
[![The MIT License][downloads-img]][downloads]

![example](https://github.com/AhamedBilal/ngx-photo-editor/blob/master/intro.gif?raw=true)

### [Demo](https://ahamedbilal.github.io/ngx-photo-editor/)

## Features

-   NgxPhotoEditor Component Injection without being passed  `ViewContainerRef`
- High performance
- Highly configurable and customizable
- Overridable styles
- Fully Supported

## Install

```bash  
   npm install ngx-photo-editor --save  
```
## Setup
#### Step 1:
- Import CSS.
```css
@import "~ngx-photo-editor/photo-editor.css";
``` 
-   If you are using angular-cli you can add it to your angular.json
```
"styles": [
  "styles.scss",
  "node_modules/ngx-photo-editor/photo-editor.css" // try adding '../' if you're using angular cli before 6
]
```
#### Step 2:
- Add NgxPhotoEditorModule to app.module.ts
```ts
import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {AppComponent} from './app.component';
import {NgxPhotoEditorModule} from "ngx-photo-editor";

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

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

And add this to your .ts file:
```ts  
import {Component} from '@angular/core';
import {NgxCroppedEvent, NgxPhotoEditorService} from "ngx-photo-editor";

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

constructor(private service: NgxPhotoEditorService) {}

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 `NgxPhotoEditorService.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.

### 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`.

[npm-url]: https://www.npmjs.com/package/ngx-photo-editor
[npm-img]: https://img.shields.io/npm/v/ngx-photo-editor?style=flat-square
[license]:http://opensource.org/licenses/MIT
[license-img]:https://img.shields.io/badge/license-MIT-orange.svg?color=blue&style=flat-square
[downloads]:https://img.shields.io/npm/dt/ngx-photo-editor?style=flat-square
[downloads-img]:https://img.shields.io/npm/dt/ngx-photo-editor?style=flat-square

ngx-photo-editor

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README