jiti-meet/react/features/toolbox/components/HelpButton.js

61 lines
1.7 KiB
JavaScript
Raw Normal View History

2019-10-11 18:09:50 +00:00
// @flow
import { createToolbarEvent, sendAnalytics } from '../../analytics';
import { getFeatureFlag, HELP_BUTTON_ENABLED } from '../../base/flags';
2019-10-11 18:09:50 +00:00
import { translate } from '../../base/i18n';
import { IconHelp } from '../../base/icons';
import { connect } from '../../base/redux';
2020-07-24 12:14:33 +00:00
import { AbstractButton, type AbstractButtonProps } from '../../base/toolbox/components';
2020-05-20 10:57:03 +00:00
import { openURLInBrowser } from '../../base/util';
2019-10-11 18:09:50 +00:00
type Props = AbstractButtonProps & {
/**
* The URL to the user documentation.
2019-10-11 18:09:50 +00:00
*/
_userDocumentationURL: string
};
/**
* Implements an {@link AbstractButton} to open the user documentation in a new window.
*/
class HelpButton extends AbstractButton<Props, *> {
accessibilityLabel = 'toolbar.accessibilityLabel.help';
icon = IconHelp;
label = 'toolbar.help';
tooltip = 'toolbar.help';
2019-10-11 18:09:50 +00:00
/**
* Handles clicking / pressing the button, and opens a new window with the user documentation.
*
* @private
* @returns {void}
*/
_handleClick() {
const { _userDocumentationURL } = this.props;
2019-10-11 18:09:50 +00:00
sendAnalytics(createToolbarEvent('help.pressed'));
openURLInBrowser(_userDocumentationURL);
2019-10-11 18:09:50 +00:00
}
}
/**
* Maps part of the redux state to the component's props.
*
* @param {Object} state - The redux store/state.
* @returns {Object}
*/
function _mapStateToProps(state: Object) {
2019-10-16 18:36:39 +00:00
const { userDocumentationURL } = state['features/base/config'].deploymentUrls || {};
const enabled = getFeatureFlag(state, HELP_BUTTON_ENABLED, true);
const visible = typeof userDocumentationURL === 'string' && enabled;
2019-10-11 18:09:50 +00:00
return {
_userDocumentationURL: userDocumentationURL,
visible
};
}
export default translate(connect(_mapStateToProps)(HelpButton));