Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

docs(dialog): clarify promise rejection behavior in descriptions #11889

Merged
Splaktar merged 1 commit into from
Apr 21, 2020
Merged

docs(dialog): clarify promise rejection behavior in descriptions #11889

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
11 changes: 7 additions & 4 deletions src/components/dialog/dialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,9 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {
* @name $mdDialog#confirm
*
* @description
* Builds a preconfigured dialog with the specified message. You can call show and the promise returned
* will be resolved only if the user clicks the confirm action on the dialog.
* Builds a preconfigured dialog with the specified message. You can call show and the promise
* returned will be resolved if the user clicks the confirm action on the dialog. The promise will
* be rejected if the user clicks the cancel action or dismisses the dialog.
*
* @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
*
Expand All @@ -460,8 +461,10 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {
* @name $mdDialog#prompt
*
* @description
* Builds a preconfigured dialog with the specified message and input box. You can call show and the promise returned
* will be resolved only if the user clicks the prompt action on the dialog, passing the input value as the first argument.
* Builds a preconfigured dialog with the specified message and input box. You can call show and the
* promise returned will be resolved, if the user clicks the prompt action on the dialog, passing
* the input value as the first argument. The promise will be rejected if the user clicks the cancel
* action or dismisses the dialog.
*
* @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
*
Expand Down