feat(package): individual module imports for modal components (#409)

dlabrecq · web-flow · commit db02d4f5d097 · 2018-06-28T17:10:03.000-04:00
This will allow future components to be imported individually without having to install an unused, optional dependency.

Deprecations

- ModalModule: Use About ModalModule
diff --git a/src/app/modal/about-modal/about-modal-config.ts b/src/app/modal/about-modal/about-modal-config.ts
@@ -1,5 +1,5 @@
 /**
- * A config containing properties for About Modal
+ * A config containing properties for about modal
  */
 export class AboutModalConfig {
   /**
diff --git a/src/app/modal/about-modal/about-modal-event.ts b/src/app/modal/about-modal/about-modal-event.ts
@@ -1,7 +1,6 @@
 /**
- * An object containing events for pagination events
+ * An object containing events for about modal events
  */
-
 export class AboutModalEvent {
     /**
      * Flag indicating Modal is open
diff --git a/src/app/modal/about-modal/about-modal.component.html b/src/app/modal/about-modal/about-modal.component.html
diff --git a/src/app/modal/about-modal/about-modal.component.spec.ts b/src/app/modal/about-modal/about-modal.component.spec.ts
@@ -4,6 +4,7 @@ import {
   TestBed } from '@angular/core/testing';
 import { By } from '@angular/platform-browser';
 import { FormsModule } from '@angular/forms';
+
 import { ModalModule } from 'ngx-bootstrap';
 
 import { AboutModalComponent } from './about-modal.component';
diff --git a/src/app/modal/about-modal/about-modal.component.ts b/src/app/modal/about-modal/about-modal.component.ts
diff --git a/src/app/modal/about-modal/about-modal.module.ts b/src/app/modal/about-modal/about-modal.module.ts
@@ -0,0 +1,13 @@
+import { CommonModule } from '@angular/common';
+import { NgModule } from '@angular/core';
+
+import { AboutModalComponent } from './about-modal.component';
+
+@NgModule({
+  imports: [
+    CommonModule
+  ],
+  declarations: [AboutModalComponent],
+  exports: [AboutModalComponent]
+})
+export class AboutModalModule {}
diff --git a/src/app/modal/about-modal/example/about-modal-example.component.html b/src/app/modal/about-modal/example/about-modal-example.component.html
@@ -7,7 +7,7 @@ <h4>About Modal Component Example</h4>
     <div class="col-sm-12">
       <button (click)="openModal(aboutTemplate)" class="btn btn-default">Launch About Modal</button>
       <ng-template #aboutTemplate>
-        <pfng-about-modal [config]="aboutConfig"  
+        <pfng-about-modal [config]="aboutConfig"
                           (onCancel)="closeModal($event)">
           <div>
             Custom Content
@@ -28,10 +28,10 @@ <h4>Code</h4>
         <iframe class="demoframe" src="docs/classes/aboutmodalcomponent.html"></iframe>
       </tab>
       <tab heading="html">
-        <include-content src="src/app/modal/example/about-modal-example.component.html"></include-content>
+        <include-content src="src/app/modal/about-modal/example/about-modal-example.component.html"></include-content>
       </tab>
       <tab heading="typescript">
-        <include-content src="src/app/modal/example/about-modal-example.component.ts"></include-content>
+        <include-content src="src/app/modal/about-modal/example/about-modal-example.component.ts"></include-content>
       </tab>
     </tabset>
   </div>
diff --git a/src/app/modal/about-modal/example/about-modal-example.component.ts b/src/app/modal/about-modal/example/about-modal-example.component.ts
@@ -2,7 +2,6 @@ import {
   Component,
   OnInit,
   TemplateRef,
-  ViewChild,
   ViewEncapsulation
 } from '@angular/core';
 
@@ -18,7 +17,6 @@ import { AboutModalEvent } from '../about-modal-event';
   templateUrl: './about-modal-example.component.html'
 })
 export class AboutModalExampleComponent implements OnInit {
-
   aboutConfig: AboutModalConfig;
   modalRef: BsModalRef;
 
diff --git a/src/app/modal/about-modal/example/about-modal-example.module.ts b/src/app/modal/about-modal/example/about-modal-example.module.ts
@@ -5,19 +5,19 @@ import { ModalModule as BSModalModule } from 'ngx-bootstrap/modal';
 import { TabsetConfig, TabsModule } from 'ngx-bootstrap/tabs';
 
 import { AboutModalExampleComponent } from './about-modal-example.component';
-import { DemoComponentsModule } from '../../../demo/components/demo-components.module';
-import { ModalModule } from '../modal.module';
+import { DemoComponentsModule } from '../../../../demo/components/demo-components.module';
+import { AboutModalModule } from '../about-modal.module';
 
 @NgModule({
   declarations: [
     AboutModalExampleComponent
   ],
   imports: [
+    AboutModalModule,
     CommonModule,
     DemoComponentsModule,
     BSModalModule.forRoot(),
-    TabsModule.forRoot(),
-    ModalModule
+    TabsModule.forRoot()
   ],
   providers: [TabsetConfig]
 })
diff --git a/src/app/modal/about-modal/index.ts b/src/app/modal/about-modal/index.ts
@@ -0,0 +1,4 @@
+export { AboutModalConfig } from './about-modal-config';
+export { AboutModalComponent } from './about-modal.component';
+export { AboutModalEvent } from './about-modal-event';
+export { AboutModalModule } from './about-modal.module';
diff --git a/src/app/modal/index.ts b/src/app/modal/index.ts
@@ -1,3 +1,3 @@
-export { AboutModalConfig } from './about-modal-config';
-export { AboutModalComponent } from './about-modal.component';
 export { ModalModule } from './modal.module';
+
+export * from './about-modal/index';
diff --git a/src/app/modal/modal.module.ts b/src/app/modal/modal.module.ts
@@ -1,19 +1,26 @@
 import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 
-import { AboutModalComponent } from './about-modal.component';
-import { AboutModalConfig } from './about-modal-config';
+import { AboutModalComponent } from './about-modal/about-modal.component';
+import { AboutModalConfig } from './about-modal/about-modal-config';
+import { AboutModalModule } from './about-modal/about-modal.module';
 
 export {
   AboutModalConfig
 };
 
+/**
+ * A module containing objects associated with modal components
+ *
+ * @deprecated Use individual module imports
+ *
+ * import { AboutModule } from 'patternfly-ng/module';
+ */
 @NgModule({
-    imports: [
-      CommonModule
-    ],
-    declarations: [AboutModalComponent],
-    exports: [AboutModalComponent]
+  imports: [
+    CommonModule,
+    AboutModalModule
+  ],
+  exports: [AboutModalComponent]
 })
-
 export class ModalModule {}
diff --git a/src/app/notification/notification-drawer/example/notification-drawer-example.component.ts b/src/app/notification/notification-drawer/example/notification-drawer-example.component.ts
@@ -273,7 +273,6 @@ export class NotificationDrawerExampleComponent implements OnInit {
         moreActions: this.actionConfig.moreActions,
         timeStamp: this.currentTime - (240 * 60 * 60 * 1000)
       }]
-    },
-    ];
+    }];
   }
 }
diff --git a/src/app/notification/notification-drawer/example/notification-drawer-example.module.ts b/src/app/notification/notification-drawer/example/notification-drawer-example.module.ts
@@ -4,10 +4,10 @@ import { NgModule } from '@angular/core';
 
 import { TabsetConfig, TabsModule } from 'ngx-bootstrap/tabs';
 
+import { ActionModule } from '../../../action/action.module';
+import { DemoComponentsModule } from '../../../../demo/components/demo-components.module';
 import { NotificationDrawerExampleComponent } from './notification-drawer-example.component';
 import { NotificationDrawerModule } from '../notification-drawer.module';
-import { DemoComponentsModule } from '../../../../demo/components/demo-components.module';
-import { ActionModule } from '../../../action/action.module';
 
 @NgModule({
   imports: [
diff --git a/src/demo/app-routing.module.ts b/src/demo/app-routing.module.ts
@@ -1,7 +1,7 @@
 import { NgModule } from '@angular/core';
 import { RouterModule, Routes } from '@angular/router';
 
-import { AboutModalExampleComponent } from '../app/modal/example/about-modal-example.component';
+import { AboutModalExampleComponent } from '../app/modal/about-modal/example/about-modal-example.component';
 import { ActionExampleComponent } from '../app/action/example/action-example.component';
 import { ApplicationLauncherExampleComponent }
   from '../app/navigation/application-launcher/example/application-launcher-example.component';
diff --git a/src/demo/app.module.ts b/src/demo/app.module.ts
@@ -13,7 +13,7 @@ import { NavbarModule } from './navbar/navbar.module';
 
 // Main areas
 //  import example modules
-import { AboutModalExampleModule } from '../app/modal/example/about-modal-example.module';
+import { AboutModalExampleModule } from '../app/modal/about-modal/example/about-modal-example.module';
 import { ActionExampleModule } from '../app/action/example/action-example.module';
 import { ApplicationLauncherExampleModule }
   from '../app/navigation/application-launcher/example/application-launcher-example.module';
