theluyuan
38ba663466
Some checks failed
Close stale issues and PRs / stale (push) Has been cancelled
63 lines
2.0 KiB
TypeScript
63 lines
2.0 KiB
TypeScript
import { connect } from 'react-redux';
|
|
|
|
import { createToolbarEvent } from '../../analytics/AnalyticsEvents';
|
|
import { sendAnalytics } from '../../analytics/functions';
|
|
import { IReduxState } from '../../app/types';
|
|
import { HELP_BUTTON_ENABLED } from '../../base/flags/constants';
|
|
import { getFeatureFlag } from '../../base/flags/functions';
|
|
import { translate } from '../../base/i18n/functions';
|
|
import { IconHelp } from '../../base/icons/svg';
|
|
import AbstractButton, { IProps as AbstractButtonProps } from '../../base/toolbox/components/AbstractButton';
|
|
import { openURLInBrowser } from '../../base/util/openURLInBrowser';
|
|
|
|
interface IProps extends AbstractButtonProps {
|
|
|
|
/**
|
|
* The URL to the user documentation.
|
|
*/
|
|
_userDocumentationURL: string;
|
|
}
|
|
|
|
/**
|
|
* Implements an {@link AbstractButton} to open the user documentation in a new window.
|
|
*/
|
|
class HelpButton extends AbstractButton<IProps> {
|
|
override accessibilityLabel = 'toolbar.accessibilityLabel.help';
|
|
override icon = IconHelp;
|
|
override label = 'toolbar.help';
|
|
override tooltip = 'toolbar.help';
|
|
|
|
/**
|
|
* Handles clicking / pressing the button, and opens a new window with the user documentation.
|
|
*
|
|
* @private
|
|
* @returns {void}
|
|
*/
|
|
override _handleClick() {
|
|
const { _userDocumentationURL } = this.props;
|
|
|
|
sendAnalytics(createToolbarEvent('help.pressed'));
|
|
openURLInBrowser(_userDocumentationURL);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Maps part of the redux state to the component's props.
|
|
*
|
|
* @param {Object} state - The redux store/state.
|
|
* @returns {Object}
|
|
*/
|
|
function _mapStateToProps(state: IReduxState) {
|
|
const { userDocumentationURL } = state['features/base/config'].deploymentUrls || {};
|
|
const enabled = getFeatureFlag(state, HELP_BUTTON_ENABLED, true);
|
|
const visible = typeof userDocumentationURL === 'string' && enabled;
|
|
|
|
return {
|
|
_userDocumentationURL: userDocumentationURL ?? '',
|
|
visible
|
|
};
|
|
}
|
|
|
|
export default translate(connect(_mapStateToProps)(HelpButton));
|