feat(): add forRoot method for module

zyra · Apr 4, 2017 · 6881a1f · 6881a1f
1 parent 1039f8e
commit 6881a1f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -41,18 +41,33 @@ npm i --save @ionic-native/transfer
 ionic plugin add cordova-plugin-file-transfer --save
 ```
 
-#### 3. Import `IonicImageLoader` module into your app's module.
+#### 3. Import `IonicImageLoader` module
 
+**Add `IonicImageLoader.forRoot()` in your app's root module**
 ```typescript
 import { IonicImageLoader } from 'ionic-image-loader';
 
 // import the module
+@NgModule({
+  ...
+  imports: [
+    IonicImageLoader.forRoot()
+  ]
+})
+export class AppModule {}
+```
+
+Then **add `IonicImageLoader` in your child/shared module(s)
+```typescript
+import { IonicImageLoader } from 'ionic-image-loader';
+
 @NgModule({
   ...
   imports: [
     IonicImageLoader
   ]
 })
+export class SharedModule {}
 ```
 
 # Usage

diff --git a/src/image-loader.module.ts b/src/image-loader.module.ts
@@ -1,4 +1,4 @@
-import { NgModule } from '@angular/core';
+import { NgModule, ModuleWithProviders } from '@angular/core';
 import { ImgLoader } from './components/img-loader';
 import { ImageLoader } from './providers/image-loader';
 import { ImageLoaderConfig } from './providers/image-loader-config';
@@ -10,17 +10,23 @@ import { Transfer } from '@ionic-native/transfer';
   declarations: [
     ImgLoader
   ],
-  providers: [
-    ImageLoaderConfig,
-    ImageLoader,
-    File,
-    Transfer
-  ],
   imports: [
     IonicModule
   ],
   exports: [
     ImgLoader
   ]
 })
-export class IonicImageLoader {}
+export class IonicImageLoader {
+  static forRoot(): ModuleWithProviders {
+    return {
+      ngModule: IonicImageLoader,
+      providers: [
+        ImageLoaderConfig,
+        ImageLoader,
+        File,
+        Transfer
+      ]
+    };
+  }
+}