ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-21 06:03:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8f288751db
openmct/platform/commonUI/dialog
History
Victor Woeltjen 513c06a81b [Persistence] Show persistence failure dialog 
WTD-1033.
2015-03-20 14:23:51 -07:00
..
res/templates [Persistence] Show persistence failure dialog 2015-03-20 14:23:51 -07:00
src [Persistence] Show persistence failure dialog 2015-03-20 14:23:51 -07:00
test [About] Update dialog specs 2015-01-14 13:09:41 -08:00
bundle.json [Dialog] Add options dialog 2015-03-20 12:11:19 -07:00
README.md [Dialog] Add options dialog 2015-03-20 12:11:19 -07:00

README.md

This bundle provides dialogService, which can be used to prompt for user input.

getUserChoice

The getUserChoice method is useful for displaying a message and a set of buttons. This method returns a promise which will resolve to the user's chosen option (or, more specifically, its key), and will be rejected if the user closes the dialog with the X in the top-right;

The dialogModel given as an argument to this method should have the following properties.

  • title: The title to display at the top of the dialog.
  • hint: Short message to display below the title.
  • template: Identifying key (as will be passed to mct-include) for the template which will be used to populate the inner area of the dialog.
  • model: Model to pass in the ng-model attribute of mct-include.
  • parameters: Parameters to pass in the parameters attribute of mct-include.
  • options: An array of options describing each button at the bottom. Each option may have the following properties:
    • name: Human-readable name to display in the button.
    • key: Machine-readable key, to pass as the result of the resolved promise when clicked.
    • description: Description to show in tool tip on hover.