docs(Dialog): MdDialogConfig ViewContainerRef description #3747
Conversation
I think this comment should be that large because its a rather specific definition. and is a more advanced component. Based on https://github.com/angular/material2/blob/master/src/lib/core/portal/portal.ts#L79
googlebot
added
the
cla: yes
Fixed lint. more specific, added MdDialog.open().
M-a-c
changed the title
src/lib/dialog/dialog-config.ts
Outdated
| /** Where the attached component should live in Angular's *logical* component tree. | ||
| * This is different from where the component *renders*, which is determined by | ||
| * the PortalHost (the component that was passed into MdDialog.open(). | ||
| * Note the origin is necessary when the host is outside of the Angular application context. */ |
There was a problem hiding this comment.
This isn't quite right. A little more accurate would be:
/**
* Where the attached component should live in Angular's *logical* component tree.
* This affects what is available for injection and the change detection order for the
* component instantiated inside of the dialog. This does not affect where the dialog
* content will be rendered.
*/There was a problem hiding this comment.
Yeah this makes more sense. I'll switch that out.
More accurate wording This affects what is available for injection and the change detection order for the component instantiated inside of the dialog
src/lib/dialog/dialog-config.ts
Outdated
| /** Where the attached component should live in Angular's *logical* component tree. | ||
| * This affects what is available for injection and the change detection order for the | ||
| * component instantiated inside of the dialog. This does not affect where the dialog | ||
| * content will be rendered. */ |
There was a problem hiding this comment.
The JsDoc syntax isn't quite right. It goes
/**
* Line one...
* Line two...
* Line three ...
*/
|
@jelbourn LGTY? |
|
Noticed that my branches are all messed up. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
#3651
I looked to find an example of what this is actually used for.
I tried to explain it a little bit more. (line 2)
https://github.com/angular/material2/blob/master/src/lib/core/portal/portal.ts#L79
Does this JsDoc summary suffice?