详解angular2封装material2对话框组件
1. 说明
angular-material2自身文档不详,控件不齐,使用上造成了很大的障碍。这里提供一个方案用于封装我们最常用的alert和confirm组件。
2. 官方使用方法之alert
①编写alert内容组件
@component({ template : `<p>你好</p>` }) export class alertcomponent { constructor(){ } }
②在所属模块上声明
//必须声明两处 declarations: [ alertcomponent], entrycomponents : [ alertcomponent]
③使用mddialg.open方法打开
//注入mddialog对象 constructor(private mddialog : mddialog) { } //打开 this.mddialog.open(alertcomponent)
3. 官方使用方法之confirm
①编写confirm内容组件
@component({ template : `<div md-dialog-title>'确认操作'</div> <div md-dialog-content>确认执行操作?</div> <div md-dialog-actions> <button md-button (click)="mddialogref.close('ok')">确认</button> <button md-button (click)="mddialogref.close('cancel')">取消</button> </div>` }) export class confirmcomponent { constructor(private mddialogref : mddialogref<dialogcomponent>){ } }
②在所属模块上声明
//必须声明两处 declarations: [ confirmcomponent], entrycomponents : [ confirmcomponent]
③使用mddialog.open打开并订阅相关事件
//注入mddialog对象 constructor(private mddialog : mddialog) { } //打开 this.mddialog.open(confirmcomponent).subscribe(res => { res === 'ok' && dosomething });
4. 分析
如2、3所示,使用material2的对话框组件相当繁琐,甚至仅仅打开一个不同的alert都要声明一个独立的组件,可用性很差。但也不是毫无办法。
mddialog.open原型:
open<t>(componentortemplateref: componenttype<t> | templateref<t>, config?: mddialogconfig): mddialogref<t>;
其中mddialogconfig:
export declare class mddialogconfig { viewcontainerref?: viewcontainerref; /** the aria role of the dialog element. */ role?: dialogrole; /** whether the user can use escape or clicking outside to close a modal. */ disableclose?: boolean; /** width of the dialog. */ width?: string; /** height of the dialog. */ height?: string; /** position overrides. */ position?: dialogposition; /** data being injected into the child component. */ data?: any; }
具体每一个配置项有哪些用途可以参考官方文档,这里data字段,说明了将会被携带注入子组件,也即被open打开的component组件。怎么获取呢?
config : any; constructor(private mddialogref : mddialogref<alertcomponent>){ this.config = mddialogref.config.data || {}; }
有了它我们就可以定义一个模板型的通用dialog组件了。
5. 定义通用化的组件
//alert.component.html <div class="title" md-dialog-title>{{config?.title || '提示'}}</div> <div class="content" md-dialog-content>{{config?.content || ''}}</div> <div class="actions" *ngif="!(config?.hiddenbutton)" md-dialog-actions> <button md-button (click)="mddialogref.close()">{{config?.button || '确认'}}</button> </div>
//alert.component.scss .title, .content{ text-align: center; } .actions{ display: flex; justify-content: center; }
//alert.component.ts @component({ selector: 'app-alert', templateurl: './alert.component.html', styleurls: ['./alert.component.scss'] }) export class alertcomponent { config : {}; constructor(private mddialogref : mddialogref<alertcomponent>){ this.config = mddialogref.config.data || {}; } }
我们将模板的一些可置换内容与config一些字段进行关联,那么我们可以这么使用:
constructor(private mddialog : mddialog) { } let config = new mddialogconfig(); config.data = { content : '你好' } this.mddialog.open(alertcomponent, config)
依然繁琐,但至少我们解决了对话框组件复用的问题。
我们可以声明一个新的模块,暂且起名为customedialogmodule,然后将component声明在此模块里,再将此模块声明到appmodule,这样可以避免appmodule的污染,保证我们的对话框组件独立可复用。
6. 二次封装
如果仅仅是上面的封装,可用性依然很差,工具应当尽可能的方便,所以我们有必要再次进行封装
首先在customdialogmodule建一个服务,暂且起名为customdialogservice
@injectable() export class customdialogservice { constructor(private mddialog : mddialog) { } //封装confirm,直接返回订阅对象 confirm(contentorconfig : any, title ?: string) : observable<any>{ let config = new mddialogconfig(); if(contentorconfig instanceof object){ config.data = contentorconfig; }else if((typeof contentorconfig) === 'string'){ config.data = { content : contentorconfig, title : title } } return this.mddialog.open(dialogcomponent, config).afterclosed(); } //同 alert(contentorconfig : any, title ?: string) : observable<any>{ let config = new mddialogconfig(); if(contentorconfig instanceof object){ config.data = contentorconfig; }else if((typeof contentorconfig) === 'string'){ config.data = { content : contentorconfig, title : title } } return this.mddialog.open(alertcomponent, config).afterclosed(); }
我们把它注册在customdialogmodule里的provides,它就可以被全局使用了。
用法:
constructor(dialog : customdialogservice){} this.dialog.alert('你好'); this.dialog.alert('你好','标题'); this.dialog.alert({ content : '你好', title : '标题', button : 'ok' }); this.dialog.confirm('确认吗').subscribe(res => { res === 'ok' && dosomething });
按照这种思路我们还可以封装更多组件,例如模态框,toast等
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。