openmct/platform/commonUI/dialog
Victor Woeltjen aebae27391 [Tests] Remove suite.json files
Remove obsolete suite.json files; #482
2016-02-02 09:35:50 -08:00
..
res/templates Merge open155 > github/master 2015-10-30 16:20:57 -07:00
src Made changes to error reporting 2015-11-04 22:07:26 -08:00
test [Tests] Remove suite.json files 2016-02-02 09:35:50 -08:00
bundle.js [API] Convert JSON bundles to imperative form 2016-01-07 15:08:08 -08:00
README.md [Dialog] Add options dialog 2015-03-20 12:11:19 -07:00

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.