4bf19d73fd
* Javadoc introduced @code as a replacement of <code> and <tt> which is better aligned with other javadoc tags such as @link. Use it in the Java source code. If we switch to Kotlin, then we'll definitely use Markdown. * There are more uses of @code in the JavaScript source code than <tt> so use @code for the sake of consistency. Eventually, I'd rather we switch to Markdown because it's easier on my eyes. * Xcode is plain confused by @code and @link. The Internet says that Xcode supports the backquote character to denote the beginning and end of a string of characters which should be formatted for display as code but it doesn't work for me. <tt> is not rendered at all. So use the backquote which is rendered itself. Hopefully, if we switch to Markdown, then it'll be common between JavaScript and Objective-C source code.
64 lines
1.8 KiB
JavaScript
64 lines
1.8 KiB
JavaScript
/* @flow */
|
|
|
|
import { HIDE_DIALOG, OPEN_DIALOG } from './actionTypes';
|
|
import { isDialogOpen } from './functions';
|
|
|
|
/**
|
|
* Signals Dialog to close its dialog.
|
|
*
|
|
* @param {Object} [component] - The {@code Dialog} component to close/hide. If
|
|
* {@code undefined}, closes/hides {@code Dialog} regardless of which
|
|
* component it's rendering; otherwise, closes/hides {@code Dialog} only if
|
|
* it's rendering the specified {@code component}.
|
|
* @returns {{
|
|
* type: HIDE_DIALOG,
|
|
* component: (React.Component | undefined)
|
|
* }}
|
|
*/
|
|
export function hideDialog(component: ?Object) {
|
|
return {
|
|
type: HIDE_DIALOG,
|
|
component
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Signals Dialog to open dialog.
|
|
*
|
|
* @param {Object} component - The component to display as dialog.
|
|
* @param {Object} [componentProps] - The React {@code Component} props of the
|
|
* specified {@code component}.
|
|
* @returns {{
|
|
* type: OPEN_DIALOG,
|
|
* component: React.Component,
|
|
* componentProps: (Object | undefined)
|
|
* }}
|
|
*/
|
|
export function openDialog(component: Object, componentProps: ?Object) {
|
|
return {
|
|
type: OPEN_DIALOG,
|
|
component,
|
|
componentProps
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Signals Dialog to open a dialog with the specified component if the component
|
|
* is not already open. If it is open, then Dialog is signaled to close its
|
|
* dialog.
|
|
*
|
|
* @param {Object} component - The component to display as dialog.
|
|
* @param {Object} [componentProps] - The React {@code Component} props of the
|
|
* specified {@code component}.
|
|
* @returns {Function}
|
|
*/
|
|
export function toggleDialog(component: Object, componentProps: ?Object) {
|
|
return (dispatch: Dispatch, getState: Function) => {
|
|
if (isDialogOpen(getState, component)) {
|
|
dispatch(hideDialog(component));
|
|
} else {
|
|
dispatch(openDialog(component, componentProps));
|
|
}
|
|
};
|
|
}
|