Skip to content

harryy2510/ngx-img

Repository files navigation

ngx-img - Angular Image Upload & Crop

npm version Build Status Coverage Status dependency Status devDependency Status

Demo

View in action at https://harryy2510.github.io/ngx-img

Dependencies

  • Angular (requires Angular 4 or higher, tested upto 9.1.9)
  • CropperJS (required for cropping)

Installation

Install above dependencies via npm.

Now install ngx-img via:

npm install --save ngx-img

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for ngx-img:

map: {
  'ngx-img': 'node_modules/ngx-img/bundles/ngx-img.umd.js',
}

Once installed you need to import the main module:

import { NgxImgModule } from 'ngx-img';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice NgxImgModule .forRoot()):

import { NgxImgModule } from 'ngx-img';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [NgxImgModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import NgxImgModule:

import { NgxImgModule } from 'ngx-img';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [NgxImgModule, ...], 
})
export class OtherModule {
}

Usage

License

Licensed under the MIT License (MIT)