brewdigital-modal v0.1.4

Brew Modal Angular

A modal system for Angular

Install

npm install brewdigital-modal
or
yarn add brewdigital-modal

Components

The brewdigital-modal contains a couple of components that are read to use

• BrewMessageModalComponent
• BrewConfirmModalComponent
• BrewMessageModalBootstrapComponent
• BrewConfirmModalBootstrapComponent

Styling

The first two contain unstyled modals with some prefixed classes that can be used to style them.

.brew-modal-overlay {}
.brew-modal-holder {}
.brew-modal-header {}
.brew-modal-body {}
.brew-modal-footer {}
.brew-modal--padding {} 
.brew-modal--section-divider {}

// Container wrappers
.brew-modal--message {}
.brew-modal--confirm {}

The last two have Twitter Bootstrap styling applied. Use these if you are already using Bootstrap for styling.

Usage

Start by adding BrewModalModule to a modules imports.

For example it could be added to the AppModule

app.module.ts

import {NgModule} from '@angular/core';
import {AppComponent} from './app.component';
import {BrewModalModule} from 'brewdigital-modal';

@NgModule({
    declarations: [
        AppComponent,
    ],
    imports: [
        // ... Other imports
        BrewModalModule
    ],
    providers: [],
    bootstrap: [AppComponent]
})
export class AppModule {}

BrewMessageComponent

Once the library has been included the components can be added to any component that uses the module.

Message Component

<brew-message-modal>
    <p>This is a message.</p>
</brew-message-modal>

In order to access the methods on the component you need to add an Angular Template Reference Variable eg #messageModal

Message Component with Tag

<brew-message-modal #messageModal>
    <p>This is a message.</p>
</brew-message-modal>

You can pick up a reference to your component with ViewChild.

Passing the reference #messageModal to @ViewChild('messageModal') messageModalRef: BrewMessageModalComponent gives you the variable messageModalRef that can access the BrewMessageModalComponents methods.

In this example we call the this.messageModal.toggle() method on (click)="toggleMessageModal()".

import {Component, ViewChild} from '@angular/core';
import {BrewMessageModalComponent} from 'brewdigital-modal';

@Component({
    selector: 'app-demo-message-modal',
    template: `
        <brew-message-modal #messageModal>
            <p>This is a message.</p>
        </brew-message-modal>
        <button (click)="toggleMessageModal()">Toggle Message Modal</button>
    `,
})
export class DemoMessageComponent {
    @ViewChild('messageModal') messageModalRef: BrewMessageModalComponent;

    toggleMessageModal() {
        this.messageModalRef.toggle();
    }
}

BrewConfirmComponentModal

The BrewConfirmComponentModal has a confirmActionResult output.

This is fired when the modals confirmation button is clicked and can be picked up with (confirmActionResult)="handleConfirm($event).

Confirm Component with Confirm Action

<brew-confirm-modal #confirmModal (confirmActionResult)="handleConfirm($event)">
    <p class="modal-text">Are you really, really sure?</p>
</brew-confirm-modal>

Actions

An Action can be passed to the modals this.confirmModal.setConfirmAction() method, its execute method is called when the confirm button is clicked.

In the example below ConfirmAction is passed to the setConfirmAction on ngAfterViewInit.

The ConfirmAction returns true when it's execute method is called.

Data can be passed to an actions execute method and can be handled however you like.

Example Confirm Action

export class ConfirmAction implements Action {
    execute(data?: any): any {
        return true;
    }
}

Passing Confirm Action to BrewConfirmModalComponent

ngAfterViewInit() {
    this.confirmModal.setConfirmAction(new ConfirmAction());
}

Example Confirm Component

import {Component, ViewChild} from '@angular/core';
import {BrewConfirmModalComponent, ConfirmAction, CancelAction} from 'brewdigital-modal';

@Component({
    selector: 'app-confirm-demo',
    template: `
        <brew-confirm-modal 
            #confirmModal 
            (confirmActionResult)="handleAccepted($event)"
            (cancelActionResult)="handleAccepted($event)"
            >
            <p class="modal-text">Are you really, really sure?</p>
        </brew-confirm-modal>
        <button (click)="toggleConfirmModal()">Toggle Confirm Modal</button>
        <div *ngIf="accepted">
            <p>You're sure.</p>
        </div>
    `,
})
export class DemoConfirmComponent {

    @ViewChild('confirmModal') confirmModal: BrewConfirmModalComponent;

    accepted: boolean;

    ngAfterViewInit() {
        this.confirmModal.setConfirmAction(new ConfirmAction());
        this.confirmModal.setCancelAction(new CancelAction());
    }

    toggleConfirmModal() {
        this.accepted = false;
        this.confirmModal.toggle();
    }

    toggleFormModal() {
        this.message = '';
        this.modalForm.toggle();
    }
    
    handleAccepted(confirmed: boolean) {
        this.accepted = confirmed;
    }
}

Actions

To handle events that occur inside a modal window classes that implement the Action interface can be passed to the modal. The Action.execute() method is then called to handle the event, the result should be exposed in an @Output in the modal. The execute method of an Action is called in the event emitter to expose the data to external components.

ModalActionBase and ModalBase are two abstract classes that can be extended to create custom modals. They provide useful methods for showing and hiding the modal and, accepting and cancelling events.

ModalActionBase

import {EventEmitter, Output} from '@angular/core';
import {ModalBase} from './modal-base';
import {Action} from '../../interface/action';

export abstract class ModalActionBase extends ModalBase {
    @Output() confirmActionResult = new EventEmitter();
    @Output() cancelActionResult = new EventEmitter();
    protected confirmAction: Action;
    protected cancelAction: Action;

    setConfirmAction(onConfirmCallback: Action) {
        this.confirmAction = onConfirmCallback;
    }

    setCancelAction(onCancelCallback: Action) {
        this.cancelAction = onCancelCallback;
    }

    confirmActionAndClose() {
        if (this.confirmAction) {
            this.confirmActionResult.emit(this.confirmAction.execute());
        }
        this.hideModal();
    }

    cancelActionAndClose() {
        if (this.cancelAction) {
            this.cancelActionResult.emit(this.cancelAction.execute());
        }
        this.hideModal();
    }
}