101 lines
2.7 KiB
JavaScript
101 lines
2.7 KiB
JavaScript
import Flag from '@atlaskit/flag';
|
|
import EditorInfoIcon from '@atlaskit/icon/glyph/editor/info';
|
|
import React, { Component } from 'react';
|
|
|
|
import { translate } from '../../base/i18n';
|
|
|
|
/**
|
|
* Implements a React {@link Component} to display a notification.
|
|
*
|
|
* @extends Component
|
|
*/
|
|
class Notification extends Component {
|
|
/**
|
|
* {@code Notification} component's property types.
|
|
*
|
|
* @static
|
|
*/
|
|
static propTypes = {
|
|
/**
|
|
* The translation key to display as the title of the notification if
|
|
* no title is provided.
|
|
*/
|
|
defaultTitleKey: React.PropTypes.string,
|
|
|
|
/**
|
|
* The translation arguments that may be necessary for the description.
|
|
*/
|
|
descriptionArguments: React.PropTypes.object,
|
|
|
|
/**
|
|
* The translation key to use as the body of the notification.
|
|
*/
|
|
descriptionKey: React.PropTypes.string,
|
|
|
|
/**
|
|
* Whether or not the dismiss button should be displayed. This is passed
|
|
* in by {@code FlagGroup}.
|
|
*/
|
|
isDismissAllowed: React.PropTypes.bool,
|
|
|
|
/**
|
|
* Callback invoked when the user clicks to dismiss the notification.
|
|
* this is passed in by {@code FlagGroup}.
|
|
*/
|
|
onDismissed: React.PropTypes.func,
|
|
|
|
/**
|
|
* Invoked to obtain translated strings.
|
|
*/
|
|
t: React.PropTypes.func,
|
|
|
|
/**
|
|
* The text to display at the top of the notification. If not passed in,
|
|
* the passed in defaultTitleKey will be used.
|
|
*/
|
|
title: React.PropTypes.string,
|
|
|
|
/**
|
|
* The unique identifier for the notification. Passed back by the
|
|
* {@code Flag} component in the onDismissed callback.
|
|
*/
|
|
uid: React.PropTypes.number
|
|
};
|
|
|
|
/**
|
|
* Implements React's {@link Component#render()}.
|
|
*
|
|
* @inheritdoc
|
|
* @returns {ReactElement}
|
|
*/
|
|
render() {
|
|
const {
|
|
defaultTitleKey,
|
|
descriptionArguments,
|
|
descriptionKey,
|
|
isDismissAllowed,
|
|
onDismissed,
|
|
t,
|
|
title,
|
|
uid
|
|
} = this.props;
|
|
|
|
return (
|
|
<Flag
|
|
appearance = 'normal'
|
|
description = { t(descriptionKey, descriptionArguments) }
|
|
icon = { (
|
|
<EditorInfoIcon
|
|
label = 'info'
|
|
size = 'medium' />
|
|
) }
|
|
id = { uid }
|
|
isDismissAllowed = { isDismissAllowed }
|
|
onDismissed = { onDismissed }
|
|
title = { title || t(defaultTitleKey) } />
|
|
);
|
|
}
|
|
}
|
|
|
|
export default translate(Notification);
|