feat: tour integration

Tour Integration

src/app/users/create-user/create-user.component.html

@@ -6,7 +6,7 @@
 
       <mat-card-content>
 
-        <div fxLayout="row wrap" fxLayoutGap="2%" fxLayout.lt-md="column">
+        <div #userFormRef fxLayout="row wrap" fxLayoutGap="2%" fxLayout.lt-md="column">
 
           <mat-form-field fxFlex="48%">
             <mat-label>Username</mat-label>
@@ -129,3 +129,15 @@
   </mat-card>
 
 </div>
+
+<ng-template #templateUserFormRef let-popover="popover">
+  <h2>Create User</h2>
+  <p class="mw400">Click to start filling the details. * mark fields are neccessary. For more details click: <a href="https://mifosforge.jira.com/wiki/spaces/docs/pages/67141740/Users" target="_blank">Users</a></p>
+  <div fxLayout="row" fxLayoutAlign="end" fxLayoutGap="2%" fxLayout.lt-md="column">
+    <button mat-raised-button color="warn" (click)="popover.close();configurationWizardService.closeConfigWizard()">Close</button>
+    <button mat-raised-button color="primary" (click)="popover.close()">Create User</button>
+    <button mat-raised-button color="primary" (click)="popover.close();previousStep()">Back</button>
+    <button mat-raised-button color="primary" (click)="popover.close();nextStep()">Next</button>
+  </div>
+</ng-template>
+

src/app/users/create-user/create-user.component.ts

@@ -1,14 +1,21 @@
 /** Angular Imports */
-import { Component, OnInit } from '@angular/core';
+import { Component, OnInit, TemplateRef, ElementRef , ViewChild,
+         AfterViewInit } from '@angular/core';
 import { FormGroup, FormBuilder, FormControl, Validators } from '@angular/forms';
 import { Router, ActivatedRoute } from '@angular/router';
+import { MatDialog } from '@angular/material/dialog';
 
 /** Custom Services */
 import { UsersService } from '../users.service';
+import { PopoverService } from '../../configuration-wizard/popover/popover.service';
+import { ConfigurationWizardService } from '../../configuration-wizard/configuration-wizard.service';
 
 /** Custom Validators */
 import { confirmPasswordValidator } from '../../login/reset-password/confirm-password.validator';
 
+/** Custom Dialog Component */
+import { ContinueSetupDialogComponent } from '../../configuration-wizard/continue-setup-dialog/continue-setup-dialog.component';
+
 /**
  * Create user component.
  */
@@ -17,7 +24,7 @@ import { confirmPasswordValidator } from '../../login/reset-password/confirm-pas
   templateUrl: './create-user.component.html',
   styleUrls: ['./create-user.component.scss']
 })
-export class CreateUserComponent implements OnInit {
+export class CreateUserComponent implements OnInit, AfterViewInit {
 
   /** User form. */
   userForm: FormGroup;
@@ -28,17 +35,27 @@ export class CreateUserComponent implements OnInit {
   /** Staff data. */
   staffData: any;
 
+  /* Reference of create user form */
+  @ViewChild('userFormRef') userFormRef: ElementRef<any>;
+  /* Template for popover on create user form */
+  @ViewChild('templateUserFormRef') templateUserFormRef: TemplateRef<any>;
+
   /**
    * Retrieves the offices and roles data from `resolve`.
    * @param {FormBuilder} formBuilder Form Builder.
    * @param {UsersService} UsersService Users Service.
    * @param {ActivatedRoute} route Activated Route.
    * @param {Router} router Router for navigation.
+   * @param {ConfigurationWizardService} configurationWizardService ConfigurationWizard Service.
+   * @param {PopoverService} popoverService PopoverService.
    */
   constructor(private formBuilder: FormBuilder,
               private usersService: UsersService,
               private route: ActivatedRoute,
-              private router: Router) {
+              private router: Router,
+              private popoverService: PopoverService,
+              private configurationWizardService: ConfigurationWizardService,
+              public dialog: MatDialog) {
     this.route.data.subscribe((data: {
         usersTemplate: any
       }) => {
@@ -110,8 +127,78 @@ export class CreateUserComponent implements OnInit {
   submit() {
     const user = this.userForm.value;
     this.usersService.createUser(user).subscribe((response: any) => {
-      this.router.navigate(['../', response.resourceId], { relativeTo: this.route });
+      if (this.configurationWizardService.showUsersForm === true) {
+        this.configurationWizardService.showUsersForm = false;
+        this.openDialog();
+      } else {
+        this.router.navigate(['../', response.resourceId], { relativeTo: this.route });
+      }
     });
   }
 
+  /**
+   * Popover function
+   * @param template TemplateRef<any>.
+   * @param target HTMLElement | ElementRef<any>.
+   * @param position String.
+   * @param backdrop Boolean.
+   */
+  showPopover(template: TemplateRef<any>, target: HTMLElement | ElementRef<any>, position: string, backdrop: boolean): void {
+    setTimeout(() => this.popoverService.open(template, target, position, backdrop, {}), 200);
+  }
+
+  /**
+   * To show popover.
+   */
+  ngAfterViewInit() {
+    if (this.configurationWizardService.showUsersForm === true) {
+    setTimeout(() => {
+        this.showPopover(this.templateUserFormRef, this.userFormRef.nativeElement, 'top', true);
+    });
+    }
+  }
+
+  /**
+   * Next Step (Maker Checker Tasks System Page) Configuration Wizard.
+   */
+  nextStep() {
+    this.configurationWizardService.showUsersForm = false;
+    this.configurationWizardService.showMakerCheckerTable = true;
+    this.router.navigate(['/system']);
+  }
+
+  /**
+   * Previous Step (Users page) Configuration Wizard.
+   */
+  previousStep() {
+    this.configurationWizardService.showUsersForm = false;
+    this.configurationWizardService.showUsersList = true;
+    this.router.navigate(['/users']);
+  }
+
+  /**
+   * Opens dialog if the user wants to create more users.
+   */
+  openDialog() {
+    const continueSetupDialogRef = this.dialog.open(ContinueSetupDialogComponent, {
+      data: {
+        stepName: 'user'
+      },
+    });
+    continueSetupDialogRef.afterClosed().subscribe((response: { step: number }) => {
+      if (response.step === 1) {
+          this.configurationWizardService.showUsersForm = false;
+          this.router.navigate(['../'], { relativeTo: this.route });
+        } else if (response.step === 2) {
+          this.configurationWizardService.showUsersForm = true;
+          this.router.routeReuseStrategy.shouldReuseRoute = () => false;
+          this.router.onSameUrlNavigation = 'reload';
+          this.router.navigate(['/organization/users/create']);
+        } else if (response.step === 3) {
+          this.configurationWizardService.showUsersForm = false;
+          this.configurationWizardService.showMakerCheckerTable = true;
+          this.router.navigate(['/system']);
+        }
+    });
+  }
 }

src/app/users/users.component.html

@@ -1,20 +1,22 @@
 <div class="container m-b-20" fxLayout="row" fxLayoutAlign="end" fxLayoutGap="20px">
-  <button mat-raised-button color="primary" [routerLink]="['create']">
-    <fa-icon icon="plus"></fa-icon>&nbsp;&nbsp;
-    Create User
-  </button>
+  <div #buttonCreateUser class="in-block">
+    <button mat-raised-button color="primary" [routerLink]="['create']">
+      <fa-icon icon="plus"></fa-icon>&nbsp;&nbsp;
+      Create User
+    </button>
+  </div>
 </div>
 
 <div class="container">
 
-  <div fxLayout="row" fxLayoutGap="20px">
+  <div #filter fxLayout="row" fxLayoutGap="20px">
     <mat-form-field fxFlex>
       <mat-label>Filter</mat-label>
       <input matInput (keyup)="applyFilter($event.target.value)">
     </mat-form-field>
   </div>
 
-  <div class="mat-elevation-z8">
+  <div #usersTable class="mat-elevation-z8">
 
     <table mat-table [dataSource]="dataSource" matSort>
 
@@ -48,3 +50,31 @@
   </div>
 
 </div>
+
+<ng-template #templateButtonCreateUser let-popover="popover">
+  <h2>Create User</h2>
+  <p class="mw300">This option allows you to create new users in your organization.</p>
+  <div fxLayout="row" fxLayoutAlign="end" fxLayoutGap="2%" fxLayout.lt-md="column">
+    <button mat-raised-button color="warn" (click)="popover.close();configurationWizardService.closeConfigWizard()">Close</button>
+    <button mat-raised-button color="primary" (click)="popover.close();previousStep()">Back</button>
+    <button mat-raised-button color="primary" (click)="popover.close();showPopover(templateFilter, filter, 'bottom', true)">Next</button>
+  </div>
+</ng-template>
+
+<ng-template #templateFilter let-popover="popover">
+  <h4>Search bar to filter users.</h4>
+  <div fxLayout="row" fxLayoutAlign="end" fxLayoutGap="2%" fxLayout.lt-md="column">
+    <button mat-raised-button color="warn" (click)="popover.close();configurationWizardService.closeConfigWizard()">Close</button>
+    <button mat-raised-button color="primary" (click)="popover.close();showPopover(templateButtonCreateUser, buttonCreateUser, 'bottom', true)">Back</button>
+    <button mat-raised-button color="primary" (click)="popover.close();showPopover(templateUsersTable, usersTable, 'top', true)">Next</button>
+  </div>
+</ng-template>
+
+<ng-template #templateUsersTable let-popover="popover">
+  <h4>List of Users with their details.</h4>
+  <div fxLayout="row" fxLayoutAlign="end" fxLayoutGap="2%" fxLayout.lt-md="column">
+    <button mat-raised-button color="warn" (click)="popover.close();configurationWizardService.closeConfigWizard()">Close</button>
+    <button mat-raised-button color="primary" (click)="popover.close();showPopover(templateFilter, filter, 'bottom', true)">Back</button>
+    <button mat-raised-button color="primary" (click)="popover.close();nextStep()">Next</button>
+  </div>
+</ng-template>

src/app/users/users.component.ts

@@ -1,13 +1,17 @@
 /** Angular Imports */
-import { Component, OnInit, ViewChild } from '@angular/core';
+import { Component, OnInit, TemplateRef, ElementRef, ViewChild, AfterViewInit  } from '@angular/core';
+import { ActivatedRoute, Router } from '@angular/router';
 import { MatPaginator } from '@angular/material/paginator';
 import { MatSort } from '@angular/material/sort';
 import { MatTableDataSource } from '@angular/material/table';
-import { ActivatedRoute } from '@angular/router';
 
 /** rxjs Imports */
 import { of } from 'rxjs';
 
+/** Custom Services */
+import { PopoverService } from '../configuration-wizard/popover/popover.service';
+import { ConfigurationWizardService } from '../configuration-wizard/configuration-wizard.service';
+
 /**
  * Users component.
  */
@@ -16,7 +20,7 @@ import { of } from 'rxjs';
   templateUrl: './users.component.html',
   styleUrls: ['./users.component.scss']
 })
-export class UsersComponent implements OnInit {
+export class UsersComponent implements OnInit, AfterViewInit {
 
   /** Users data. */
   usersData: any;
@@ -30,11 +34,26 @@ export class UsersComponent implements OnInit {
   /** Sorter for users table. */
   @ViewChild(MatSort, { static: true }) sort: MatSort;
 
+  /* Reference of create user button */
+  @ViewChild('buttonCreateUser') buttonCreateUser: ElementRef<any>;
+  /* Template for popover create user button */
+  @ViewChild('templateButtonCreateUser') templateButtonCreateUser: TemplateRef<any>;
+  /* Reference of users table */
+  @ViewChild('usersTable') usersTable: ElementRef<any>;
+  /* Template for popover on users table */
+  @ViewChild('templateUsersTable') templateUsersTable: TemplateRef<any>;
+
   /**
    * Retrieves the users data from `resolve`.
    * @param {ActivatedRoute} route Activated Route.
+   * @param {Router} router Router for navigation.
+   * @param {ConfigurationWizardService} configurationWizardService ConfigurationWizard Service.
+   * @param {PopoverService} popoverService PopoverService.
    */
-  constructor(private route: ActivatedRoute) {
+  constructor(private route: ActivatedRoute,
+              private router: Router,
+              private configurationWizardService: ConfigurationWizardService,
+              private popoverService: PopoverService) {
     this.route.data.subscribe(( data: { users: any }) => {
       this.usersData = data.users;
     });
@@ -64,4 +83,52 @@ export class UsersComponent implements OnInit {
     this.dataSource.sort = this.sort;
   }
 
+  /**
+   * Popover function
+   * @param template TemplateRef<any>.
+   * @param target HTMLElement | ElementRef<any>.
+   * @param position String.
+   * @param backdrop Boolean.
+   */
+  showPopover(template: TemplateRef<any>, target: HTMLElement | ElementRef<any>, position: string, backdrop: boolean): void {
+    setTimeout(() => this.popoverService.open(template, target, position, backdrop, {}), 200);
+  }
+
+  /**
+   * To show popover.
+   */
+  ngAfterViewInit() {
+    if (this.configurationWizardService.showUsers === true) {
+      setTimeout(() => {
+        this.showPopover(this.templateButtonCreateUser, this.buttonCreateUser.nativeElement, 'bottom', true);
+      });
+    }
+
+    if (this.configurationWizardService.showUsersList === true) {
+      setTimeout(() => {
+        this.showPopover(this.templateUsersTable, this.usersTable.nativeElement, 'top', true);
+      });
+    }
+  }
+
+  /**
+   * Next Step (Create User Page) Configuration Wizard.
+   */
+  nextStep() {
+    this.configurationWizardService.showUsers = false;
+    this.configurationWizardService.showUsersList = false;
+    this.configurationWizardService.showUsersForm = true;
+    this.router.navigate(['/users/create']);
+  }
+
+  /**
+   * Previous Step (Roles and Permission Page) Configuration Wizard.
+   */
+  previousStep() {
+    this.configurationWizardService.showUsers = false;
+    this.configurationWizardService.showUsersList = false;
+    this.configurationWizardService.showRolesandPermissionList = true;
+    this.router.navigate(['/system/roles-and-permissions']);
+  }
+
 }