ng2-bs3-modal   

Angular (2+) Bootstrap 3 Modal Component

Demo

http://dougludlow.github.io/ng2-bs3-modal/demo/

Prerequisites

If you're using Typescript in your project, ng2-bs3-modal requires Typescript v2.0.0 or greater. Also make sure that your editor (Visual Studio Code, Atom, Webstorm, etc.) supports Typescript >= v2.0.0 or you'll see errors even though it compiles.

Dependencies

ng2-bs3-modal depends on bootstrap which depends on jquery, you'll need to include both scripts before ng2-bs3-modal or somehow make them available globally, depending on your build system.

``html


`

Install

npm
`bash
npm install --save ng2-bs3-modal
`

yarn
`bash
yarn add ng2-bs3-modal
`

Then include the ng2-bs3-modal in your project.

Using SystemJS, you can add a mapping to your System.config:

`javascript
System.config({
defaultJSExtensions: true,
map: {
'ng2-bs3-modal': 'node_modules/ng2-bs3-modal'
}
});
`

Or you can include a reference to the bundle in your html:

`html

`

Then include the module in the imports collection of your app's module:

`typescript
import { NgModule } from '@angular/core';
import { BsModalModule } from 'ng2-bs3-modal';

@NgModule({
imports: [ BsModalModule ]
...
})
export class MyAppModule { }
`

Example Projects

The following is a list of basic demo projects that use the ng2-bs3-modal:

- npm
- SystemJS
- jspm
- angular-cli
- webpack

Feel free to request more.

API

$3

#### Inputs

- animation: boolean, default: true

Specify false to simply show the modal rather than having it fade in/out of view.

- backdrop: string | boolean, default: true

Specify 'static' for a backdrop which doesn't close the modal on click or false for no backdrop.

- keyboard: boolean, default: true

Closes the modal when escape key is pressed. Specify false to disable.

- size: string, default: undefined

Specify 'sm' for small and 'lg' for large.

- cssClass: string, default: undefined

Applies the given class to the modal. Can be used to styles the modal; for example, giving it a custom size.

#### Outputs

- onShow: EventEmitter

Emits when the show.bs.modal event is triggered, just before the modal is shown. Call Event.preventDefault() to cancel the modal from showing.

- onHide: EventEmitter

Emits when the hide.bs.modal event is triggered, just before the modal is hidden. Call BsModalHideEvent.event.preventDefault() to cancel the modal from hiding.

- onClose: EventEmitter

Emits when ModalComponent.close() is called. Will emit whatever was passed into ModalComponent.close().

- onDismiss: EventEmitter

Emits when ModalComponent.dismiss() is called, or when the modal is dismissed with the keyboard or backdrop. Returns a BsModalHideType that can be used to determine how the modal was dismissed.

- onOpen: EventEmitter

Emits when ModalComponent.open() is called.

#### Methods

- open(size?: string): Promise

Opens the modal. Size is optional. Specify 'sm' for small and 'lg' for large to override size. Returns a promise that resolves when the modal is completely shown.

- close(value?: any): Promise

Closes the modal. Causes onClose to be emitted. Returns a promise that resolves the value passed to close when the modal is completely hidden.

- dismiss(): Promise

Dismisses the modal. Causes onDismiss to be emitted. Returns a promise that resolves when the modal is completely hidden.

$3

#### Inputs

- showDismiss: boolean, default: false

Show or hide the close button in the header. Specify true to show.



$3

#### Inputs

- showDefaultButtons: boolean, default: false

Show or hide the default 'Close' and 'Dismiss' buttons in the footer. Specify true to show.

- closeButtonLabel: string, default: 'Close'

Change the label in the default 'Close' button in the footer. Has no effect if showDefaultButtons aren't set.

- dismissButtonLabel: string, default: 'Dismiss'

Change the label in the default 'Dismiss' button in the footer. Has no effect if showDefaultButtons aren't set.

$3

#### Methods

- dismissAll(): void

Dismiss all open modals. Inject the BsModalService into a componet/service to use.

Example Usage

$3

`html
Open me!





I'm a modal!




Hello World!



`

!Example

$3

This will create a modal that cannot be closed with the escape key or by clicking outside of the modal.

`html




I'm a modal!




Hello World!



`

$3

`html




I'm a modal!




Hello World!


Cancel
Ok


`

!Example

$3

`typescript
import { Component, ViewChild } from '@angular/core';
import { BsModalComponent } from 'ng2-bs3-modal';

@Component({
selector: 'parent-component',
template:

...


})
export class ParentComponent {
@ViewChild('myModal')
modal: BsModalComponent;

close() {
this.modal.close();
}

open() {
this.modal.open();
}
}
`

$3

`typescript
import { Component, ViewChild, AfterViewInit } from '@angular/core';
import { BsModalComponent } from 'ng2-bs3-modal';

@Component({
selector: 'parent-component',
template:

...


})
export class ParentComponent implements AfterViewInit {
@ViewChild('myModal')
modal: BsModalComponent;

ngAfterViewInit() {
this.modal.open();
}
}
`

Note: ViewChild doesn't resolve the modal property until AfterViewInit. OnInit is too early and will result in an "undefined" error.

$3

`typescript
import { Component, ViewChild } from '@angular/core';
import { BsModalComponent } from 'ng2-bs3-modal';

@Component({
selector: 'parent-component',
template:

...


...


})
export class ParentComponent {
@ViewChild('myFirstModal')
modal1: BsModalComponent;

@ViewChild('mySecondModal')
modal2: BsModalComponent;

...
}
`

$3

`typescript
import { Component, ViewChild } from '@angular/core';
import { BsModalComponent } from 'ng2-bs3-modal';

@Component({
selector: 'parent-component',
styles: ['>>> .modal-xl { width: 1100px; }'],
template:

...


})
export class ParentComponent {
...
}
`

Note: Angular2 emulates the shadow dom by prefixing component styles with a unique identifier. Because the modal is attached to the body tag, it doesn't pick up these styles. You will need to add the /deep/ or >>> selector in order for the style to take effect. See Component Styles.

$3

`typescript
import { Component, ViewChildren } from '@angular/core';
import { BsModalComponent } from 'ng2-bs3-modal';

@Component({
selector: 'parent-component',
template:
Open me!


})
export class ParentComponent {
@ViewChildren(BsModalComponent)
modals: QueryList; // How to access a collection of modals
...
}
`

Note: If you are updating items asynchronously, make sure you are using trackBy in the ngFor directive so that Angular doesn't teardown and redraw the elements each time the collection is changed. See NgFor Directive for more details.

$3

`html



I'm a modal!

First Name

Last Name

Cancel
Save

`

$3

`html




I'm a modal!

I'm a textbox!

`

Building

`bash
git clone https://github.com/dougludlow/ng2-bs3-modal.git
yarn
yarn build
`

Running

`bash
yarn start
`

Navigate to http://localhost:4200/ in your browser.

Testing

`bash
yarn test
`

To run tests once without watching:
`bash
yarn test:single
``

Bugs/Contributions

Report all bugs and feature requests on the issue tracker.

Contributions are welcome! Feel free to open a pull request.