Angular2学习笔记-ng bootstrap中motal组件使用

ng bootstrap是一个angular UI bootstrap库,里面包含了一些基本的UI组件(日期选择组件,按钮,下拉框等)。目前的版本为v1.0.0-alpha.14,基于angular2和bootstrap4。因为在项目中要用到弹出窗口,试着尝试了下该库中的motal组件,效果还不错,因此这里做个记录。

基本的TypeScripe类

NgbModal

用来打开motal窗口的服务,可以采用依赖的方式直接注入到我们定义的组件中。该类仅有一个open(content: any, options: NgbModalOptions):NgbModalRef方法,该方法接收一个content参数:该参数包含窗口的内容;和一个可选的options参数:该参数定义了窗口的一些特性,如尺寸、样式、点击背景关闭窗口等。

NgbModalOptions

这是一个接口的定义,有四个属性:

  • backdrop: boolean | 'static' 是否为窗口生成一个背景,'static'时生成的背景在点击窗口是不会关闭窗口。
  • keyboard: boolean 是否按ESC键时,关闭窗口。
  • size: 'lg' | 'sm' 默认是中等大小,lg为大窗口,sm为小窗口。
  • windowClass: string 用户自定义的窗口样式。

NgbModalRef

一个新打开的modal窗口引用,NgbModal调用open方法时会返回一个该对象引用,有两个重要的属性和两个方法。

  • componentInstance 在open方法中传入的content为组件时的组件实例,若content不为组件是则为 undefined。
  • rusult 一个promise对象,窗口关闭和销毁时会触发。
  • close 关闭一个窗口,窗口扔存在DOM中。
  • dismiss 销毁窗口。

NgbActiveModal

当前打开窗口的引用,包含close和dismiss方法。

modal使用

首先需要angular2及bootstrap4的支持,一般使用npm进行管理。bootstrap也可以直接引入CDN的链接,具体看官网。

1.安装ng bootstrap:
npm install --save @ng-bootstrap/ng-bootstrap
2.引入NgbModule模块
在angular2根模块中引入时,需添加forRoot()方法
imports: [NgbModule.forRoot(), ...]
特性模块中,则不需要
imports: [NgbModule, ...]
3.编写一个窗口模块组件modal-basic.compont.ts

import { Component, OnInit } from '@angular/core';
import {NgbModal, ModalDismissReasons} from '@ng-bootstrap/ng-bootstrap';


@Component({
  selector: 'app-modal-basic',
  templateUrl: './modal-basic.component.html',
  styleUrls: ['./modal-basic.component.css']
})
export class ModalBasicComponent implements OnInit {

  closeResult: string;

  constructor(private modalService: NgbModal) {}

  open(content) {
    this.modalService.open(content).result.then((result) => {
      this.closeResult = `Closed with: ${result}`;
    }, (reason) => {
      this.closeResult = `Dismissed ${this.getDismissReason(reason)}`;
    });
  }

  private getDismissReason(reason: any): string {
    if (reason === ModalDismissReasons.ESC) {
      return 'by pressing ESC';
    } else if (reason === ModalDismissReasons.BACKDROP_CLICK) {
      return 'by clicking on a backdrop';
    } else {
      return  `with: ${reason}`;
    }
  }

  ngOnInit() {
  }
}

组件包含一个NgbModal的服务,调用该服务的open方法即可打开窗口。结合组件页面来看:

<template #content let-c="close">
  <div class="modal-header">
    <button type="button" class="close" aria-label="Close" (click)="dismiss('Cross click')">
      <span aria-hidden="true">×</span>
    </button>
    <h4 class="modal-title">Modal title</h4>
  </div>
  <div class="modal-body">
    <p>One fine body…</p>
  </div>
  <div class="modal-footer">
    <button type="button" class="btn btn-secondary" (click)="c('Close click')">Close</button>
  </div>
</template>

<button class="btn btn-lg btn-outline-primary" (click)="open(content)">Launch demo modal</button>

<hr>

<pre>{{closeResult}}</pre>

1.template定义了窗口的内容,在不打开窗口的情况下,内容是隐藏的。注意该模板添加了一个content变量,在调用open方法时传入。
2.定义了一个按钮,当点击时调用modal-basic组件的open方法,在该方法中调用NgbModal的open方法,打开窗口。

4.使用modal窗口

<div class="container-fluid">
    <hr>
    <p>
        This is a demo plnkr forked from the <strong>ng-bootstrap</strong> project: Angular 2 powered Bootstrap.
        Visit <a href="https://ng-bootstrap.github.io/" target="_blank">https://ng-bootstrap.github.io</a> for more widgets and demos.
    </p>
    <hr>

    <template ngbModalContainer></template>

    <app-modal-basic></app-modal-basic>
</div>

注意添加<template ngbModalContainer></template>元素,ngbModalContainer指令用来标记modal窗口在页面中打开的位置。
另外<template ngbModalContainer></template>需要添加到跟组件中,应用才能正常工作。

后记

当然不要忘了把modal-basic组件在模块中声明,这里假设你一了解基本的angular2知识。本文主要翻译在ng-bootstrap的使用手册,建议你直接看原文档。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容