ngx-lazy-dialog v3.0.1

Ngx Lazy Dialog

This library allows you to create lazy loading dialogs without the need for root app dependency injections. Each dialog is completely independent of the rest of the application.

The dialog is fully customizable!

Standalone components are supported now!

Table of Contents

• Installation
• How to use
  • Module tutorial
  • Standalone tutorial
  • Customizing the container and backdrop
• Breaking Changes
  • 3.0.0 (2022-12-08)
  • 2.0.0 (2022-11-01)
  • 1.0.0 (2022-08-01)

Installation

The ngx-lazy-dialog can be installed with npm:

npm i ngx-lazy-dialog --save

Import LazyDialogModule in your app root module like app.module.ts:

// ...
import { LazyDialogModule } from 'ngx-lazy-dialog';
// ...
@NgModule({
  // ...
  imports: [
    LazyDialogModule.forRoot({ 
      closeOnBackdropClick: true,
      closeButton: true,
    })
  ],
  // ...
})
export class AppModule {}

Import styles to styles.scss of your project:

@import 'node_modules/ngx-lazy-dialog/styles/ngx-lazy-dialog.scss';

How to use

Module tutorial

Each dialog component should have your own module, so generate a dialog component and module using Angular CLI:

ng g module dialogs/alert

ng g component dialogs/alert

After generating dialog and module, the folder structure should be like this:

app   
└───dialogs
│   │   alert
│   │   │   alert.component.html
│   │   │   alert.component.scss
│   │   │   alert.component.ts
│   │   │   alert.module.ts

We need to modify the alert.component.ts file if you want to call close function or receive data in the dialog:

// ...
import { LazyDialogRef } from 'ngx-lazy-dialog';
// ...
export class AlertComponent implements OnInit {
  public myData: any
  
  constructor(private _dialogRef: LazyDialogRef) {
  }
  
  ngOnInit() {
    // getting data
    this.myData = this._dialogRef.data;
  }
  
  close(data?: any) {
    // closing dialog
    this._dialogRef.close(data);
  }
}

After, we are going to modify alert.module.ts:

// ...
import { ModuleWithLazyDialog } from 'ngx-lazy-dialog';
// ...
export class AlertModule implements ModuleWithLazyDialog<AlertComponent> {
  // Implementing 'getDialog' to return module bootstrap component
  getDialog() {
    return AlertComponent;
  }
}

In alert.component.html file, we can add a simple template as example:

<p>Alert dialog</p>
<button (click)="close()">Close</button>
<button (click)="close({bar: 'foo'})">Close with output data</button>

It's done. Now we are going to open the dialog in another component from our app:

// ...
import { LazyDialogService } from 'ngx-lazy-dialog';
// ...
constructor(private _service: LazyDialogService) {
}
// ...
async openDialog() {
  const module = await import('./dialogs/alert/alert.module').then(m => m.AlertModule);
  this._service.create({module});
}
//...

You can try to add data and config to dialog creation or get a callback data:

// ...
async openDialog(): Promise<void> {
  const module = await import('./dialogs/alert/alert.module').then(m => m.AlertModule);
  
  const data = {
    foo: 'bar'
  };

  const config: LazyDialogConfig = {
    closeOnBackdropClick: false,
    closeButton: false,
    customClasses: 'my-custom-class',
  };

  const dialog = await this._service.create({module, data, config});
  dialog.onClose().then((output) => {
    console.log(output);
  });
}
// ...

Standalone tutorial

Generate a standalone dialog component using Angular CLI:

ng g component --standalone dialogs/alert

After generating dialog and module, the folder structure should be like this:

app   
└───dialogs
│   │   alert
│   │   │   alert.component.html
│   │   │   alert.component.scss
│   │   │   alert.component.ts

We need to modify the alert.component.ts file if you want to call close function or receive data in the dialog:

// ...
import { LazyDialogRef } from 'ngx-lazy-dialog';
// ...
@Component({
  // ...
  standalone: true
})
export class AlertComponent implements OnInit {
  public myData: any
  
  constructor(private _dialogRef: LazyDialogRef) {
  }
  
  ngOnInit() {
    // getting data
    this.myData = this._dialogRef.data;
  }
  
  close(data?: any) {
    // closing dialog
    this._dialogRef.close(data);
  }
}

In alert.component.html file, we can add a simple template as example:

<p>Alert dialog</p>
<button (click)="close()">Close</button>
<button (click)="close({bar: 'foo'})">Close with output data</button>

It's done. Now we are going to open the dialog in another component from our app:

// ...
import { LazyDialogService } from 'ngx-lazy-dialog';
// ...
constructor(private _service: LazyDialogService) {
}
// ...
async openDialog() {
  const component = await import('./dialogs/alert/alert.component').then(m => m.AlertComponent);
  this._service.create({component});
}
//...

You can try to add data and config to dialog creation or get a callback data:

// ...
async openDialog() {
  const component = await import('./dialogs/alert/alert.component').then(m => m.AlertComponent);
  
  const data = {
    foo: 'bar'
  };

  const config: LazyDialogConfig = {
    closeOnBackdropClick: false,
    closeButton: false,
    customClasses: 'my-custom-class',
  };

  const dialog = await this._service.create({component, data, config});
  dialog.onClose().then((output) => {
    console.log(output);
  });
}
// ...

Customizing the container and backdrop

You can customize the dialog container and backdrop using CSS variables. See the list of variables and their default values below:

Example:

Add custom css vars to your app global style file (like styles.scss):

:root {
  --dialog-bg: #E7EAEF;
  --dialog-close-color: #123661;
}

Or create a css class and add to dialog creation:

.custom-dialog {
  --dialog-bg: #E7EAEF;
  --dialog-close-color: #123661;
}

this.service.create({component, data, config: {customClasses: 'custom-dialog'}});

Breaking Changes

3.0.0 (2022-12-08)

• Need to import new ngx-lazy-dialog.scss file to your app global style file (like styles.scss)

2.0.0 (2022-11-01)

• New argument type to the create function on LazyDialogService. Now you need to pass only one object: LazyDialogCreateConfig.

1.0.0 (2022-08-01)

• Dialog Ref by DI (It is no longer necessary to extend the Lazy Dialog class)
• Custom classes on config