Skip to content
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.

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

doc(dialog): document MdDialog #1569

Merged
merged 5 commits into from
Oct 25, 2016
Merged

doc(dialog): document MdDialog #1569

merged 5 commits into from
Oct 25, 2016

Conversation

feloy
Copy link
Contributor

@feloy feloy commented Oct 22, 2016

Heavily based on the snack-bar doc. Comments are welcome.
Refs #1566

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 22, 2016
@feloy feloy mentioned this pull request Oct 22, 2016
| 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`. |
Copy link
Member

Choose a reason for hiding this comment

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

Also mention "Defaults to 'dialog'"

}

@Component({
selector: 'my-dialog',
Copy link
Member

Choose a reason for hiding this comment

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

I like to use example components names that are super obviously examples (which is why there are so many PizzaComponents in the source). This avoid the problem of people seeing this selector and thinking it's a magic identifier that you must use.

Can you change MyDialog and MyComponent to be something else?

@jelbourn
Copy link
Member

LGTM, thanks!

@jelbourn jelbourn added the action: merge The PR is ready for merge by the caretaker label Oct 24, 2016
@kara kara merged commit c9ef34c into angular:master Oct 25, 2016
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants