@craftsjs/modal
v7.0.1
Published
Material modal is a library for angular
Maintainers
Readme
craftsjs modal
craftsjs modal is a library for angular
Getting Started
To get started, let's install the package through npm:
Choose the version corresponding to your Angular version:
Angular | @craftsjs/modal ----------- | ------------------- 19 | 7.x 18 | 6.x 15 | 5.x 13 | 4.x 12 | 3.x 11 | 2.x
npm i @craftsjs/modal --SCompatibility
Current version: 7.0.1 (Compatible with Angular v19)
Install peer dependencies
npm i
@craftsjs/perfect-scrollbar
perfect-scrollbar
@angular/material
@angular/cdk
@angular/animations --SHow to use
- Import the module ModalModule into the AppModule
import { ModalModule } from '@craftsjs/modal';
@NgModule({
imports: [ModalModule.forRoot({ width: '800px' })]
})
export class AppModule { }- Standalone (Angular 15+ / 18): usa providers en vez de NgModule
// main.ts
import { bootstrapApplication, importProvidersFrom } from '@angular/platform-browser';
import { provideAnimations } from '@angular/platform-browser/animations';
import { provideCraftsjsModal } from '@craftsjs/modal';
import { AppComponent } from './app/app.component';
bootstrapApplication(AppComponent, {
providers: [
provideAnimations(),
provideCraftsjsModal({ width: '800px' })
]
});- Alternativa standalone compat (reutilizando NgModule):
// main.ts
import { bootstrapApplication, importProvidersFrom } from '@angular/platform-browser';
import { ModalModule } from '@craftsjs/modal';
import { AppComponent } from './app/app.component';
bootstrapApplication(AppComponent, {
providers: [
importProvidersFrom(ModalModule.forRoot({ width: '800px' }))
]
});- Create a component modal
@Component({
...
})
export class FormModalComponent {
constructor(
private _dialogRef: MatDialogRef<FormModalComponent>,
@Optional() @Inject(MAT_DIALOG_DATA) public data: any
) { }
close() {
this._dialogRef.close();
}
}<craftsjs-modal>
<modal-header>
<h3 class="text-accent">Title</h3>
<button mat-icon-button (click)="close()">
<mat-icon suffix>close</mat-icon>
</button>
</modal-header>
<modal-body>
//modal body
</modal-body>
<modal-footer>
<button type="submit" mat-raised-button color="accent">
Save
</button>
<button type="button" mat-raised-button (click)="close()">Close</button>
</modal-footer>
</craftsjs-modal>import { ModalModule } from '@craftsjs/modal';
@NgModule({
imports: [ModalModule],
entryComponents: [
FormModalComponent // this line is important
]
})
export class OtherModule { }
```typescript
@Component({
...
})
export class ProductListComponent {
constructor(
private _modalService: ModalService
showModal() {
this._modalService.show(FormModalComponent);
}
}Styles
The modal ships a Sass theme mixin. Apply it from your global styles using the modern Sass module system and the Angular Material M2 theming API:
@use '@angular/material' as mat;
@use '@craftsjs/modal/craftsjs-modal.theme' as modal;
@include mat.core();
$craftsjs-app-primary: mat.m2-define-palette(mat.$m2-teal-palette, 800);
$craftsjs-app-accent: mat.m2-define-palette(mat.$m2-pink-palette, 800, A100, 100);
$craftsjs-app-warn: mat.m2-define-palette(mat.$m2-red-palette);
$craftsjs-app-theme: mat.m2-define-light-theme((
color: (
primary: $craftsjs-app-primary,
accent: $craftsjs-app-accent,
warn: $craftsjs-app-warn,
),
));
// The modal mixin expects the Material color config map.
$craftsjs-color-config: mat.m2-get-color-config($craftsjs-app-theme);
@include mat.all-component-themes($craftsjs-app-theme);
body.theme-default {
@include modal.modal($craftsjs-color-config);
}Multiple themes (theme switching)
modal($theme) emits the full structure plus colors. When you support more than
one theme, emit the structure once and apply only the colors per theme with
modal-color($theme):
// structure once
.modal-host { @include modal.modal($light-color-config); }
// colors per theme
.theme-dark .modal-host { @include modal.modal-color($dark-color-config); }Note: the library uses the modern Sass module system (
@use) and the Angular Material M2 theming API. The legacy@import '~@angular/material/theming'/mat-palette/mat-light-themeAPI was removed in Angular Material 19.
