Skip to content

docs(material/dialog): add missing descriptions #22854

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
Jun 2, 2021
Merged

docs(material/dialog): add missing descriptions #22854

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
7 changes: 7 additions & 0 deletions src/material/dialog/dialog-content-directives.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ export class MatDialogClose implements OnInit, OnChanges {
@Input('matDialogClose') _matDialogClose: any;

constructor(

/**
* Reference to the containing dialog.
* @deprecated `dialogRef` property to become private.
* @breaking-change 13.0.0
*/
// The dialog title directive is always used in combination with a `MatDialogRef`.
// tslint:disable-next-line: lightweight-tokens
@Optional() public dialogRef: MatDialogRef<any>,
Expand Down Expand Up @@ -93,6 +99,7 @@ export class MatDialogClose implements OnInit, OnChanges {
},
})
export class MatDialogTitle implements OnInit {
/** Unique id for the dialog title. If none is supplied, it will be auto-generated. */
@Input() id: string = `mat-dialog-title-${dialogElementUid++}`;

constructor(
Expand Down
1 change: 1 addition & 0 deletions src/material/dialog/dialog-ref.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export class MatDialogRef<T, R = any> {
constructor(
private _overlayRef: OverlayRef,
public _containerInstance: _MatDialogContainerBase,
/** Id of the dialog. */
readonly id: string = `mat-dialog-${uniqueId++}`) {

// Pass the id along to the container.
Expand Down
6 changes: 4 additions & 2 deletions tools/public_api_guard/material/dialog.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ export declare class MatDialogClose implements OnInit, OnChanges {
dialogRef: MatDialogRef<any>;
dialogResult: any;
type: 'submit' | 'button' | 'reset';
constructor(dialogRef: MatDialogRef<any>, _elementRef: ElementRef<HTMLElement>, _dialog: MatDialog);
constructor(
dialogRef: MatDialogRef<any>, _elementRef: ElementRef<HTMLElement>, _dialog: MatDialog);
_onButtonClick(event: MouseEvent): void;
ngOnChanges(changes: SimpleChanges): void;
ngOnInit(): void;
Expand Down Expand Up @@ -148,7 +149,8 @@ export declare class MatDialogRef<T, R = any> {
componentInstance: T;
disableClose: boolean | undefined;
readonly id: string;
constructor(_overlayRef: OverlayRef, _containerInstance: _MatDialogContainerBase, id?: string);
constructor(_overlayRef: OverlayRef, _containerInstance: _MatDialogContainerBase,
id?: string);
addPanelClass(classes: string | string[]): this;
afterClosed(): Observable<R | undefined>;
afterOpened(): Observable<void>;
Expand Down