npmpackage.info

Gathering detailed insights and metrics for ng2-modal-module

Other packages similar to ng2-modal-module

ng2-router-modal

0.0.8

Angular2 module that integrates ng-bootstrap modal with ui-router state's tree

@agilie/ng2-dialog-window

0.1.12

Modal dialogs and popups module for Angular applications

Gathering detailed insights and metrics for ng2-modal-module

ng2-modal-module - 1.0.1 | npmpackage.info

ng2-modal-module

bootstrap modal component adjusted for angular2! framework based on rx-pubsub service. NO jQuery!!!

1.0.1

TypeScript

194.50 kB

1.3

Installations

npm install ng2-modal-module

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.4.0

NPM Version

6.9.0 Pull Requests

Open

27

Total

39

Closed

12

Issues

Open

0

Total

1

Closed

1

Releases

1.0.1

Updated on Jun 26, 2019

0.4.1

Updated on Jun 23, 2019

View All 2 releases

Languages

TypeScript

JavaScript

HTML

CSS

TypeScript (73.13%)

JavaScript (12.94%)

HTML (12.49%)

CSS (1.45%)

Developer

kageoni

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

6 Commits

1 Forks

28 Branches

1 Contributors

Updated on Jun 26, 2019

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.1

Package Id

ng2-modal-module@1.0.1

Unpacked Size

194.50 kB

Size

39.50 kB

File Count

NPM Version

6.9.0

Node Version

12.4.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

component-injector pubsub-distinct trust-html xdom-util tslib

Peer Dependencies

@angular/core @angular/common bootstrap

ng2-modal-module

Description
Installation
Usage
Ng2ModalWindow static methods
ModalWindow Options
Examples
Git repository
Build
Publish to npm
Version

1. Description

ng2-modal-module or ModalModule is a module for angular2+ which exposes the bootstrap (3.3.*) modal component (no jQuery required!!!) with the util class Ng2ModalWindow which makes the component usage easier.
It is based on pubsub-distinct.

2. Installation

Install the module into your application and save it as a dev dependency in your package.json file

npm install ng2-modal-module --save-dev

WARNIGNG Don't forget to include the bootstrap (3.3.*) styles!

3. Usage

In order to use the ModalModule module you have to include/import it into your application:

import {ModalModule} from 'ng2-modal-module';

Add the module into the app's module imports section:

1import { ModalModule } from 'ng2-modal-module';
2
3@NgModule({
4  //...
5  imports: [
6	//...
7	ModalModule // <<--- HERE
8  ],
9  //...
10})

Include the modal component into your template:

1<ng2-modal-window id="{{modalId}}"></ng2-modal-window>

where modalId is a unique ID of the modal component.

Call the modal component (display or hide it) using the Ng2ModalWindow util class:

1import { Component, OnInit } from '@angular/core';
2import { Ng2ModalWindow } from 'ng2-modal-module';
3
4export class AppComponent  implements OnInit {  
5  modalId: string = 'modalId';  
6  
7  constructor() {  
8  }  
9  
10  ngOnInit() {  
11    Ng2ModalWindow.showModal(this.modalId, {  
12      title: 'Modal title',  
13      htmlContent: 'Modal content'  
14    });  
15  }  
16}

4. Ng2ModalWindow static methods

showModal(modalId: string, options: any = {}): void

Display the Ng2ModalWindowComponent

Parameters:
modalId - Id of the modal window which should be displayed
options - Options used to customize the displayed modal window The options list is described here.

Return:
Method returns nothing - void.

hideModal(modalId: string): void

Hide the Ng2ModalWindowComponent

Parameters:
modalId - Id of the modal window which should be hidden

Return:
Method returns nothing - void.

resetEventsSubscribers(eventsList: any[]): void

Reset (remove) the events subscribers of the Ng2ModalWindowComponent actions buttons if such events are provided using the options parameter.

Parameters:
eventsList - List of events name which should be removed/unsubscribed

Return:
Method returns nothing - void.

5. ModalWindow Options

Option	Type	Default	Description	Example
componentInputs	Object	NULL	Properties list of the dynamically injected component into the modal's body	{title: 'new value of the title property of the injected component'}
componentSelector	String	NULL	Selector of the component which should be injected dynamically into the modal's body	{componentSelector: 'test-component'}
customClass	String	NULL	Custom class which will be attached to the modal window. Here can be passed the bootstraps classes which handle the size of the modal (`modal-lg`, `modal-sm` etc.)	{customClass: 'modal-lg'}
hide	Boolean	NULL	Forcibly hide the modal window when its value is `true`	{hide: true}
htmlContent	String	Empty	The HTML content which should be injected in the modal's body as innerHTML content (HTML tags are not escaped!)	{htmlContent: '<strong>test content</strong>'}
overlayClick	Boolean	true	Enable/disable the click over the modal's overlay. If it's `true` then the click over the overlay hides/closes the modal window.	{overlayClick: false} // disable the overlay click
show	Boolean	NULL	Forcibly shows/display the modal window if its value is `true`	{show: true}
showEvent	String	NULL	Name of the event which will be triggered when the modal window is displayed	{showEvent: 'show-event'}
title	String	Empty	Title of the modal window	{title: 'Modal window title'}
buttons.visible	Boolean	true	Display or hide the footer section with the action buttons (cancel/success). `true` - buttons are visible `false` - buttons are hidden	{buttons: {visible: false}} // hide buttons
buttons.cancel.visible	Boolean	true	Display or hide the `cancel` button `true` - button is visible `false` - button is hidden	{buttons: {cancel: {visible: false}}} // hide cancel button
buttons.cancel.label	String	'Cancel'	Label of the `cancel` button	{buttons: {cancel: {label: 'Close'}}}
buttons.cancel.event	String	NULL	Name of the event which will be triggered (using pubsub-distinct) when the `cancel` button is clicked	{buttons: {cancel: {event: 'cancel-event'}}}
buttons.success.visible	Boolean	true	Display or hide the `success` button `true` - button is visible `false` - button is hidden	{buttons: {success: {visible: false}}} // hide success button
buttons.success.label	String	'Save'	Label of the `success` button	{buttons: {success: {label: 'Save changes'}}}
buttons.success.event	String	NULL	Name of the event which will be triggered (using pubsub-distinct) when the `success` button is clicked	{buttons: {cancel: {event: 'success-event'}}}

6. Examples

Before using the Ng2ModalWindowComponent don't forget to import the Ng2ModalWindow util class into your component/service:

1import { Ng2ModalWindow } from 'ng2-modal-module';
2
3//...
4// define an unique ID for the modal component
5modalId: string = 'test-modal-window';
6//...

display simple modal window:

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  htmlContent: 'Modal content'
4});

display modal with the disabled overlay, HTML content and custom class (large modal window)

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  htmlContent: '<b>test bold</b> and simple text',
4  customClass: 'modal-lg',
5  overlayClick: false
6});

display modal window without footer (action buttons are hidden).

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  htmlContent: 'modal content',
4  buttons: {
5    visible: false
6  }
7});

display modal without the success button:

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  htmlContent: 'modal content',
4  buttons: {
5    success: {visible: false}
6  }
7});

inject a custom component into the modal's body/content

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  componentSelector: 'app-test'
4});

where app-test is the selector of the component which should be injected in the modal window.
WARNING! To make it dynamically injectable, the component app-test should be included in the entryComponents: [] list of the @NgModule(...) of your application module;

inject a custom component into the modal's body/content and pass some custom properties to it

1Ng2ModalWindow.showModal(this.modalId, {
2  title: 'Modal title',
3  componentSelector: 'app-test',
4  componentInputs: {componentTitle: 'CUSTOM TITLE'}
5});

where componentTitle is a public property of the component app-test.

1// events names  
2let successEventName = 'successEvent';  
3let cancelEventName = 'cancelEvent';  
4  
5// remove previously added subscriber and publisher  
6Ng2ModalWindow.resetEventsSubscribers([successEventName, cancelEventName]);  
7  
8// pass the events name to the modal window component  
9Ng2ModalWindow.showModal(this.modalId, {  
10  title: 'Modal title',  
11  htmlContent: 'listen actions events',  
12  buttons: {  
13    cancel: { event: cancelEventName },  
14    success: { event: successEventName }  
15  }  
16});  
17  
18// subscribe to events 
19Ng2ModalWindow.subscribe(successEventName, (data) => {  
20  console.log('successEventName triggered!', data);  
21  // hide modal  
22  Ng2ModalWindow.hideModal(this.modalId); 
23});  
24Ng2ModalWindow.subscribe(cancelEventName, (data) => {  
25  console.log('cancelEventName triggered!', data);  
26});

Before registering new events listeners, is suggested to remove them if they are already subscribed to the same events:

1Ng2ModalWindow.resetEventsSubscribers([successEventName, cancelEventName]);

hide already visible modal window

1Ng2ModalWindow.hideModal(this.modalId);

7. Git repository

https://github.com/kageoni/ng2-modal-module

8. Build

To build the final package run this command:

ng build ng2-modal

The build process will generate the packed sources into the dist folder.

9. Publish to npm

To publish the new version to npm, go into the dist folder:

cd ./dist/ng2-modal

and publish it to npm:

npm publish

10. Version

1.0.1

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

144 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-c75v-2vq8-878f
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-9mvj-f7w8-pvh2
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-jg8v-48h5-wgxg
Warn: Project is vulnerable to: GHSA-36fh-84j7-cv5h
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-qm28-7hqv-wg5j
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-884p-74jh-xrg2
Warn: Project is vulnerable to: GHSA-j7fq-p9q7-5wfv
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-4fc4-chg7-h8gh
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More