@ieeesa-npm/presentation 0.0.9 → 0.1.2

package/lib/components/footer/footer.component.d.ts

@@ -0,0 +1,34 @@
+import { OnInit } from '@angular/core';
+import { FooterConfig, FooterLink } from '../../models/footer-config.model';
+import * as i0 from "@angular/core";
+/**
+ * Implements & displays copyright information and IEEE quick access links.
+ * @class FooterComponent
+ * @implements {OnInit}
+ */
+export declare class FooterComponent implements OnInit {
+    /**
+     * Input property to get the configuration information of footer copyright text and quick access links.
+     * @type {FooterConfig}
+     * @memberof FooterComponent
+     */
+    footerConfig: FooterConfig;
+    screenTexts: any;
+    currentYear: number;
+    /**
+     * Initializes the component with default values if not provided.
+     * @return -returns nothing
+     * @memberof FooterComponent
+     */
+    ngOnInit(): void;
+    /**
+     * TrackByFunction is called for each item in the collection and return a unique identifier for that item.
+     * @param {number} index -The index of the current item in the collection.
+     * @param {FooterLink} link -Link object with required properties.
+     * @return {string} -returns link label as an unique identifier.
+     * @memberof FooterComponent
+     */
+    trackByFunc(index: number, link: FooterLink): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FooterComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FooterComponent, "ieeesa-footer", never, { "footerConfig": { "alias": "footerConfig"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/components/header/header.component.d.ts

@@ -0,0 +1,37 @@
+import { OnDestroy } from '@angular/core';
+import { HeaderConfig } from '../../models/header-config.model';
+import { Router } from '@angular/router';
+import { BreakpointObserver } from '@angular/cdk/layout';
+import { Subject } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Implements & displays application logo, title, signed in user information, sign-out link, and hamburger link for mobile view.
+ * @class HeaderComponent
+ */
+export declare class HeaderComponent implements OnDestroy {
+    private router;
+    private breakpointObserver;
+    /**
+     * HeaderConfig represents the configurable properties required for header component.
+     * Input property of the component to get the configurable values such as logo, app title, signed in user name and logout redirect URL.
+     * @type {HeaderConfig}
+     * @memberof HeaderComponent
+     */
+    headerConfig: HeaderConfig;
+    destroy$: Subject<boolean>;
+    screenTexts: any;
+    isMobileView: boolean;
+    constructor(router: Router, breakpointObserver: BreakpointObserver);
+    /**
+     * Desktop event to navigate to logout page.
+     * @memberof HeaderComponent
+     */
+    logout(): void;
+    /**
+     * Cleans up resources when the component is destroyed.
+     * @memberof HeaderComponent
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HeaderComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<HeaderComponent, "ieeesa-header", never, { "headerConfig": { "alias": "headerConfig"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/components/modal/modal.component.d.ts

@@ -0,0 +1,61 @@
+import { ComponentRef, EventEmitter, OnDestroy, OnInit, ViewContainerRef } from '@angular/core';
+import { MatDialogRef } from '@angular/material/dialog';
+import { ModalType } from '@ieeesa-npm/feature';
+import { ToggleButton } from '../../models/toggle-button.model';
+import * as i0 from "@angular/core";
+/**
+ * This component encapsulates the functionality of a modal dialog and implements reusable contents part of the modal components such as text content, loading another component into the modal and emitting modal events to consumed component.
+ * It utilizes Angular Material's MatDialog module to display the modal dialog.
+ * @usageNotes -Pass ModalComponent and data options as parameters to MatDialog open method as given below
+ this.dialog.open(ConfirmationDialogComponent, {data: {}})
+ * @class ModalComponent
+ */
+export declare class ModalComponent implements OnInit, OnDestroy {
+    dialogRef: MatDialogRef<ModalComponent>;
+    modalData: any;
+    componentContainer: ViewContainerRef;
+    componentRef: ComponentRef<any>;
+    toggleButtonClicked: EventEmitter<any>;
+    isComponentLoaded: boolean;
+    heading: string;
+    subHeading: string;
+    promptMessage: string;
+    leftButtonLabel: string;
+    rightButtonLabel: string;
+    toggleButtons: ToggleButton[];
+    componentReference: any;
+    modalType: ModalType;
+    isCloseNeeded: boolean;
+    modalConfirm: EventEmitter<any>;
+    constructor(dialogRef: MatDialogRef<ModalComponent>, modalData: any);
+    /**
+     * Initializes the component.
+     * @return -returns nothing
+     */
+    ngOnInit(): void;
+    /**
+     * Emit onToggleButtonClicked event when a toggle button is selected.
+     * @param {ToggleButton} selected -Selected toggle button object.
+     */
+    onToggleButtonSelect(selected: ToggleButton): void;
+    /**
+     * Loads the component into the view container.
+     */
+    loadComponent(): void;
+    /**
+     * Handles the confirmation event.
+     * @param {boolean} value - The confirmation value.
+     */
+    onConfirm(value: boolean): void;
+    /**
+     * Returns dialog type
+     * @return {number} value-Dialog type enum
+     */
+    getModalType(): boolean;
+    /**
+     * Cleans up resources when the component is destroyed.
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ModalComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ModalComponent, "ieeesa-modal", never, {}, {}, never, never, true, never>;
+}

package/lib/components/navigation-menu/navigation-menu.component.d.ts

@@ -0,0 +1,38 @@
+import { ChangeDetectorRef, OnDestroy } from '@angular/core';
+import { MediaMatcher } from '@angular/cdk/layout';
+import { SideMenuItem } from '../../models/navigation-menu.model';
+import * as i0 from "@angular/core";
+/**
+ * The component accepts menu items data as configurable input parameter and the menus are populated based on it.
+ * The component checks the defined mobile device resolution and accordingly updates the side navigation menu view.
+ * The component accepts menu opened/closed state as an input parameter. By default, the side menu is configured to open state.
+ * @export
+ * @class NavigationMenuComponent
+ * @implements {OnDestroy}
+ */
+export declare class NavigationMenuComponent implements OnDestroy {
+    changeDetectorRef: ChangeDetectorRef;
+    media: MediaMatcher;
+    isMenuOpen: boolean;
+    SideMenu: SideMenuItem[];
+    mobileQuery: MediaQueryList;
+    mobileQueryListener: () => void;
+    constructor(changeDetectorRef: ChangeDetectorRef, media: MediaMatcher);
+    /**
+     * Takes the index and the current item as arguments and needs to return the unique identifier for this item.
+     * @param {number} index
+     * @param {array} menuItems
+     * @return {number}
+     * @memberof NavigationMenuComponent
+     */
+    trackByFn(index: number, menuItems: any): number;
+    /**
+     * This method returns the status for menu to be opened or closed by default, basis on device resolution
+     * @return {boolean}
+     * @memberof NavigationMenuComponent
+     */
+    isMenuOpened(): boolean;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NavigationMenuComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NavigationMenuComponent, "ieeesa-navigation-menu", never, { "isMenuOpen": { "alias": "isMenuOpen"; "required": false; }; "SideMenu": { "alias": "SideMenu"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/components/toggle-button/toggle-button.component.d.ts

@@ -0,0 +1,47 @@
+import { EventEmitter, OnInit } from "@angular/core";
+import { ToggleButton } from "../../models/toggle-button.model";
+import * as i0 from "@angular/core";
+/**
+ * ToggleButtonComponent allows users to select toggle between group of buttons.
+ * The component takes an array of ToggleButton objects as an input, where each object contains id, label and isDisabled property. Default the first button is selected when selectedLabel is not provided.
+ * @class ToggleButtonComponent
+ * @implements {OnInit}
+ */
+export declare class ToggleButtonComponent implements OnInit {
+    /**
+     * Label of the selected button. Default is an empty string.
+     * @type {string}
+     */
+    selectedLabel: string;
+    /**
+     * An array of ToggleButton objects that represent the buttons in the toggle group.
+     * Each ToggleButton object must have properties: id, label, and isDisabled.
+     * @type {ToggleButton[]}
+     */
+    buttons: ToggleButton[];
+    /**
+     * Event emitter that emits the selected ToggleButton object when a button is clicked.
+     * @type {EventEmitter<ToggleButton>}
+     */
+    toggleSelected: EventEmitter<ToggleButton>;
+    /**
+     * By default, the first button in a group is selected when selectedLabel is not provided.
+     * @return -returns nothing
+     */
+    ngOnInit(): void;
+    /**
+     * Updates the selectedLabel with the clicked button label and emits the toggleSelected event with the selected ToggleButton object.
+     * @param {ToggleButton} button -Selected ToggleButton object.
+     * @return -returns nothing
+     */
+    toggleButtonClicked(button: ToggleButton): void;
+    /**
+     * TrackByFunction is called for each item in the collection and return a unique identifier for that item.
+     * @param {number} index -The index of the current item in the collection.
+     * @param {ToggleButton} button -The current button object from the collection being iterated.
+     * @return {number} -returns number
+     */
+    trackByFn(index: number, button: ToggleButton): number;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ToggleButtonComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ToggleButtonComponent, "ieeesa-toggle-button", never, { "selectedLabel": { "alias": "selectedLabel"; "required": false; }; "buttons": { "alias": "buttons"; "required": false; }; }, { "toggleSelected": "toggleSelected"; }, never, never, true, never>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ieeesa-npm/presentation",
-  "version": "0.0.9",
+  "version": "0.1.2",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0",
@@ -18,8 +18,7 @@
     "moment": "^2.29.4",
     "rxjs": "~7.8.0",
     "zone.js": "~0.13.0",
-    "@ieeesa-npm/shared-styles": "^0.0.1",
-    "@ieeesa-npm/utility": "^0.0.1"
+    "@ieeesa-npm/shared-styles": "^0.0.2"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -11,6 +11,11 @@ export * from './lib/components/search/search.component';
 export * from './lib/components/date-picker/date-picker.component';
 export * from './lib/components/date-picker-header/date-picker-header.component';
 export * from './lib/components/select/select.component';
+export * from './lib/components/header/header.component';
+export * from './lib/components/footer/footer.component';
+export * from './lib/components/navigation-menu/navigation-menu.component';
+export * from './lib/components/modal/modal.component';
+export * from './lib/components/toggle-button/toggle-button.component';
 export * from './lib/directives/dynamic-form-field/dynamic-form-field.directive';
 export * from './lib/models/field-config.model';
 export * from './lib/models/form-field.model';