2017-11-17 19:06:47 +00:00
|
|
|
// @flow
|
2017-06-04 03:12:04 +00:00
|
|
|
|
2017-11-17 19:06:47 +00:00
|
|
|
export type DialogProps = {
|
2017-11-13 15:54:04 +00:00
|
|
|
|
2017-06-04 03:12:04 +00:00
|
|
|
/**
|
|
|
|
* Whether cancel button is disabled. Enabled by default.
|
|
|
|
*/
|
2017-11-13 15:54:04 +00:00
|
|
|
cancelDisabled: boolean,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional i18n key to change the cancel button title.
|
|
|
|
*/
|
2017-11-17 19:06:47 +00:00
|
|
|
cancelTitleKey: string,
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The React {@code Component} children which represents the dialog's body.
|
|
|
|
*/
|
|
|
|
children: React$Node,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Is ok button enabled/disabled. Enabled by default.
|
|
|
|
*/
|
2017-11-13 15:54:04 +00:00
|
|
|
okDisabled: boolean,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional i18n key to change the ok button title.
|
|
|
|
*/
|
2017-11-17 19:06:47 +00:00
|
|
|
okTitleKey: string,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The handler for onCancel event.
|
|
|
|
*/
|
2017-11-13 15:54:04 +00:00
|
|
|
onCancel: Function,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The handler for the event when submitting the dialog.
|
|
|
|
*/
|
2017-11-13 15:54:04 +00:00
|
|
|
onSubmit: Function,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to obtain translations in children classes.
|
|
|
|
*/
|
2017-11-13 15:54:04 +00:00
|
|
|
t: Function,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Key to use for showing a title.
|
|
|
|
*/
|
2017-11-17 19:06:47 +00:00
|
|
|
titleKey: string,
|
2017-06-04 03:12:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The string to use as a title instead of {@code titleKey}. If a truthy
|
|
|
|
* value is specified, it takes precedence over {@code titleKey} i.e.
|
|
|
|
* the latter is unused.
|
|
|
|
*/
|
2017-11-17 19:06:47 +00:00
|
|
|
titleString: string
|
2017-06-04 03:12:04 +00:00
|
|
|
};
|