npmpackage.info

Gathering detailed insights and metrics for ngx-fragments

ngx-fragments - 1.0.2 | npmpackage.info

ngx-fragments

Extensible module for easy creation of URL based modals, pop-ups and asides

1.0.2

TypeScript

218.14 kB

2.2

Installations

npm install ngx-fragments

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.22.5

NPM Version

6.14.14 Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

TypeScript

HTML

JavaScript

SCSS

TypeScript (72.14%)

HTML (23.7%)

JavaScript (2.43%)

SCSS (1.73%)

Developer

mayinbun

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

89 Commits

1 Watchers

2 Branches

1 Contributors

Updated on Aug 22, 2021

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.2

Package Id

ngx-fragments@1.0.2

Unpacked Size

218.14 kB

Size

51.23 kB

File Count

NPM Version

6.14.14

Node Version

12.22.5

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

tslib

Peer Dependencies

@angular/common @angular/core rxjs

ngx-fragments

Ever needed a modal, popup or sidenav that worked based on the URL?
This module takes care of that!

This module does NOT provide the implementation of above mentioned use cases.

Demo

Getting Started

1npm install ngx-fragments

Usage

Create Fragment Container Component

The container component is basically the component you want to render your child components content.
Since this module does not provide any container components, we have to provide it to the module.

An example modal container component could look like this:

1import { Component } from '@angular/core';
2import { FragmentOutletComponent } from 'ngx-fragments';
3
4@Component({
5  styles: [`
6   :host {
7    position: relative;
8    display: block;
9  }
10  
11  /* The Modal (background) */
12  .modal {
13    display: block;
14    position: fixed;
15    z-index: 9999;
16    left: 0;
17    top: 0;
18    width: 100%;
19    height: 100%;
20    overflow: auto;
21  }
22  
23  .modal-content {
24    margin: 15% auto;
25    padding: 20px;
26    border: 1px solid #888;
27    width: 80%;
28  }
29  
30  .close {
31    color: #aaa;
32    float: right;
33    font-size: 28px;
34    font-weight: bold;
35  }
36`],
37  template: `
38  
39    <div class="modal" (click)="outerClick($event)">
40    
41        <div class="modal-content">
42            <span class="close" (click)="outlet.close()">&times;</span>
43            <ng-content></ng-content>
44        </div>
45        
46    </div>
47
48  `
49})
50export class MyCustomModalContainerComponent {
51  constructor(public outlet: FragmentOutletComponent) {
52  }
53
54  public outerClick(event: any): void {
55    event.stopPropagation();
56    if (event.target.className === 'modal') {
57      this.outlet.close();
58    }
59  }
60}
61
62

By injecting the FragmentOutletComponent we have access to the close function.

Create Entry Component

Now that we have a container, we will create a component which we want to show inside the container.
For this we will create a simple GreeterModalComponent. This component will display the value of the queryParameter as greeting.

1import { Component } from '@angular/core';
2import { FragmentOutletBase } from 'ngx-fragments';
3
4@Component({
5  styles: [
6    `.greeting {
7      font-size: 1.5rem;
8      color: cornflowerblue;
9      text-shadow: #333333;
10    }
11    `,
12  ],
13  template: `
14    <div class="greeting">
15      Greeting: {{ whenQueryParamValueChanged$ | async }}
16    </div>
17  `,
18})
19export class GreeterModalComponent extends FragmentOutletBase {
20  constructor() {
21    super();
22  }
23}

Notice that we extend FragmentOutletBase class. This class provides the following observables we can subscribe to.

Property	Description
whenClosed$	Event on close
whenQueryParamValueChanged$	Event on query param value changed
queryParamValue	Initial query param value

Provide the configuration

The configuration object is a dictionary of Fragment where each key can have his own containerComponent and entries list consisting out of FragmentEntry objects

1export interface Fragment {
2  containerComponent: Type<any>;
3  entries: FragmentEntry[];
4}

Property	Description
containerComponent	Angular component we want to use as container
entries	List of `FragmentEntry` objects

1export interface FragmentEntry {
2  key: string;
3  type: Type<T>;
4  priority?: number;
5}

Property	Description
key	The query parameter key to use to display this fragment
type	The component to render inside the container
priority (optional)	Useful if you want to control which fragment should always be on top

Configuration (based on the example from above)

1const configuration = {
2  modal: {
3    containerComponent: MyCustomModalContainerComponent,
4    entries: [
5      {
6        key: 'greeter',
7        type: GreeterModalComponent,
8      },
9    ],
10  }
11}

Finally, pass the configuration to the forRoot method in your AppModule.

1
2@NgModule({
3  imports: [
4    NgxFragmentsModule.forRoot(configuration)
5  ]
6})

Or use forFeature for lazy loaded modules

1// In AppModule
2@NgModule({
3  imports: [
4    NgxFragmentsModule.forRoot() // --> configuration object is optional here
5  ]
6})
7
8// In Feature Module
9@NgModule({
10  imports: [
11    NgxFragmentsModule.forFeature(configuration) // --> configuration is REQUIRED for lazy modules
12  ]
13})

To test the working, we have to navigate to the route we defined.
Since our greeter modal is part of the modal parent object, the key greeter will automatically get prefixed with modal: to avoid query parameter collisions.

1 <a [routerLink]="[]" [queryParams]="{'modal:greeter': 'Hello from year 2021!'}" queryParamsHandling="merge">open greeter</a>

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

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

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

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

101 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-c75v-2vq8-878f
Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
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-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
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-q8pj-2vqx-8ggc
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-273r-mgr4-v34f
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-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-cj88-88mr-972w
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
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-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
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-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-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
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-rp65-9cf3-cjxr
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-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-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
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-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
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-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
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-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

2.2

/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