Skip to content

docs(dialog): add new option and update example #1814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2016
Merged

docs(dialog): add new option and update example #1814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/demo-app/dialog/dialog-demo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {Component, ViewContainerRef} from '@angular/core';
import {Component} from '@angular/core';
import {MdDialog, MdDialogRef} from '@angular/material';

@Component({
Expand All @@ -11,9 +11,7 @@ export class DialogDemo {
dialogRef: MdDialogRef<JazzDialog>;
lastCloseResult: string;

constructor(
public dialog: MdDialog,
public viewContainerRef: ViewContainerRef) { }
constructor(public dialog: MdDialog) { }

open() {
this.dialogRef = this.dialog.open(JazzDialog);
Expand Down
16 changes: 7 additions & 9 deletions src/lib/dialog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MdDialog

MdDialog is a service, which opens dialogs components in the view.
MdDialog is a service, which opens dialogs components in the view.

### Methods

Expand All @@ -12,8 +12,9 @@ MdDialog is a service, which opens dialogs components in the view.

| Key | Description |
| --- | --- |
| `viewContainerRef: ViewContainerRef` | The view container ref to attach the dialog to. |
| `role: DialogRole = 'dialog'` | The ARIA role of the dialog element. Possible values are `dialog` and `alertdialog`. Defaults to `dialog`. |
Copy link
Member

@jelbourn jelbourn Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't remove this because it is still an option, but it is optional.

| `disableClose: boolean = false` | Whether to prevent the user from closing a dialog by clicking on the backdrop or pressing escape. Defaults to `false`. |
| `viewContainerRef: ViewContainerRef` | The view container ref to attach the dialog to. Optional. |

## MdDialogRef

Expand All @@ -40,15 +41,12 @@ export class PizzaComponent {

dialogRef: MdDialogRef<PizzaDialog>;

constructor(
public dialog: MdDialog,
public viewContainerRef: ViewContainerRef) { }
constructor(public dialog: MdDialog) { }

openDialog() {
let config = new MdDialogConfig();
config.viewContainerRef = this.viewContainerRef;

this.dialogRef = this.dialog.open(PizzaDialog, config);
this.dialogRef = this.dialog.open(PizzaDialog, {
disableClose: false
});

this.dialogRef.afterClosed().subscribe(result => {
console.log('result: ' + result);
Expand Down