jitsi-meet/react/features/video-menu/components/web/HideSelfViewVideoButton.tsx
theluyuan 38ba663466
Some checks failed
Close stale issues and PRs / stale (push) Has been cancelled
init
2025-09-02 14:49:16 +08:00

125 lines
3.2 KiB
TypeScript

import React, { PureComponent } from 'react';
import { WithTranslation } from 'react-i18next';
import { connect } from 'react-redux';
import { IReduxState, IStore } from '../../../app/types';
import { translate } from '../../../base/i18n/functions';
import { updateSettings } from '../../../base/settings/actions';
import { getHideSelfView } from '../../../base/settings/functions';
import ContextMenuItem from '../../../base/ui/components/web/ContextMenuItem';
import { NOTIFY_CLICK_MODE } from '../../../toolbox/types';
/**
* The type of the React {@code Component} props of {@link HideSelfViewVideoButton}.
*/
interface IProps extends WithTranslation {
/**
* Button text class name.
*/
className: string;
/**
* Whether or not to hide the self view.
*/
disableSelfView: boolean;
/**
* The redux dispatch function.
*/
dispatch: IStore['dispatch'];
/**
* Callback to execute when the button is clicked.
*/
notifyClick?: Function;
/**
* Notify mode for `participantMenuButtonClicked` event -
* whether to only notify or to also prevent button click routine.
*/
notifyMode?: string;
/**
* Click handler executed aside from the main action.
*/
onClick?: Function;
}
/**
* Implements a React {@link Component} which displays a button for hiding the local video.
*
* @augments Component
*/
class HideSelfViewVideoButton extends PureComponent<IProps> {
/**
* Initializes a new {@code HideSelfViewVideoButton} instance.
*
* @param {Object} props - The read-only React Component props with which
* the new instance is to be initialized.
*/
constructor(props: IProps) {
super(props);
// Bind event handlers so they are only bound once for every instance.
this._onClick = this._onClick.bind(this);
}
/**
* Implements React's {@link Component#render()}.
*
* @inheritdoc
* @returns {null|ReactElement}
*/
override render() {
const {
className,
t
} = this.props;
return (
<ContextMenuItem
accessibilityLabel = { t('videothumbnail.hideSelfView') }
className = 'hideselflink'
id = 'hideselfviewButton'
onClick = { this._onClick }
text = { t('videothumbnail.hideSelfView') }
textClassName = { className } />
);
}
/**
* Hides the local video.
*
* @private
* @returns {void}
*/
_onClick() {
const { disableSelfView, dispatch, notifyClick, notifyMode, onClick } = this.props;
notifyClick?.();
if (notifyMode === NOTIFY_CLICK_MODE.PREVENT_AND_NOTIFY) {
return;
}
onClick?.();
dispatch(updateSettings({
disableSelfView: !disableSelfView
}));
}
}
/**
* Maps (parts of) the Redux state to the associated {@code HideSelfViewVideoButton}'s props.
*
* @param {Object} state - The Redux state.
* @private
* @returns {IProps}
*/
function _mapStateToProps(state: IReduxState) {
return {
disableSelfView: Boolean(getHideSelfView(state))
};
}
export default translate(connect(_mapStateToProps)(HideSelfViewVideoButton));