Skip to content

Add info about entryComponents in Dialog documentation #2686

Closed
@coder925

Description

@coder925

Bug, feature request, or proposal:

Proposal

What is the expected behavior?

It should be easy to follow the dialog overview sample and get it up and running using a new app created with Angular CLI.

What is the current behavior?

I was struggling with getting the Dialog component to work without showing errors in the console. I finally solved it by adding my DialogContentComponent to the module’s entryComponents. It would be helpful if there was a section in the documentation if this is a requirement.

What are the steps to reproduce?

The steps to reproduce the errors in the console is available from:
https://github.com/coder925/sample-angular-material-dialog-overview#sample-angular-material-dialog-overview

What is the use-case or motivation for changing an existing behavior?

It would improve the documentation if this is a requirement and help other people who might struggle with the same issue.

Which versions of Angular, Material, OS, browsers are affected?

https://github.com/coder925/sample-angular-material-dialog-overview#versions

Is there anything else we should know?

I can submit a PR for improved documentation. However, I am afraid my knowledge regarding why you must place the content dialog component in entryComponents is not sufficient to be able to describe the reasons for this requirement correctly.
The Plunkr sample of the Dialog Overview places the content dialog component in the module’s bootstrap instead. I was not able to get this to work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1Impacts a large percentage of users; if a workaround exists it is partial or overly painfuldocsThis issue is related to documentationin progressThis issue is currently in progress

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions