bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/layout/modal/component.jsx
Arthur B. Grossi 064fd1d13c
feat(layout): Add propagate layout toggle (#21027)
* feat(layout): add propagation toggle

Transforms the 'update everyone' button in the layout modal into a
toggle, so that presenter get immediate visual feedback of the current
layout propagation setting when the modal is opened.

* fix: update propagation button locale to 'update to everyone'

* test: update layout test

---------

Co-authored-by: Anton B <antonbsa.bck@gmail.com>
2024-09-09 08:48:07 -03:00

236 lines
7.3 KiB
JavaScript

import React, { useState } from 'react';
import PropTypes from 'prop-types';
import { defineMessages, injectIntl } from 'react-intl';
import { LAYOUT_TYPE, CAMERADOCK_POSITION, HIDDEN_LAYOUTS } from '/imports/ui/components/layout/enums';
import SettingsService from '/imports/ui/components/settings/service';
import deviceInfo from '/imports/utils/deviceInfo';
import Button from '/imports/ui/components/common/button/component';
import Toggle from '/imports/ui/components/common/switch/component';
import Styled from './styles';
const LayoutModalComponent = ({
intl,
setIsOpen,
isModerator = false,
isPresenter,
application,
updateSettings,
onRequestClose,
isOpen,
setLocalSettings,
}) => {
const [selectedLayout, setSelectedLayout] = useState(application.selectedLayout);
const [keepPushingLayout, setKeepPushingLayout] = useState(application.pushLayout);
const BASE_NAME = window.meetingClientSettings.public.app.cdn + window.meetingClientSettings.public.app.basename;
const LAYOUTS_PATH = `${BASE_NAME}/resources/images/layouts/`;
const isKeepPushingLayoutEnabled = SettingsService.isKeepPushingLayoutEnabled();
const intlMessages = defineMessages({
title: {
id: 'app.layout.modal.title',
description: 'Modal title',
},
update: {
id: 'app.layout.modal.update',
description: 'Modal confirm button',
},
updateAll: {
id: 'app.layout.modal.updateAll',
description: 'Modal updateAll button',
},
layoutLabel: {
id: 'app.layout.modal.layoutLabel',
description: 'Layout label',
},
layoutToastLabelAuto: {
id: 'app.layout.modal.layoutToastLabelAuto',
description: 'Layout toast label',
},
layoutToastLabelAutoOff: {
id: 'app.layout.modal.layoutToastLabelAutoOff',
description: 'Layout toast label',
},
layoutToastLabel: {
id: 'app.layout.modal.layoutToastLabel',
description: 'Layout toast label',
},
customLayout: {
id: 'app.layout.style.custom',
description: 'label for custom layout style',
},
smartLayout: {
id: 'app.layout.style.smart',
description: 'label for smart layout style',
},
presentationFocusLayout: {
id: 'app.layout.style.presentationFocus',
description: 'label for presentationFocus layout style',
},
videoFocusLayout: {
id: 'app.layout.style.videoFocus',
description: 'label for videoFocus layout style',
},
layoutSingular: {
id: 'app.layout.modal.layoutSingular',
description: 'label for singular layout',
},
layoutBtnDesc: {
id: 'app.layout.modal.layoutBtnDesc',
description: 'label for singular layout',
},
on: {
id: 'app.switch.onLabel',
description: 'label for toggle switch on state',
},
off: {
id: 'app.switch.offLabel',
description: 'label for toggle switch off state',
},
});
const handleSwitchLayout = (e) => {
setSelectedLayout(e);
};
const handleUpdateLayout = () => {
const obj = {
application:
{ ...application, selectedLayout, pushLayout: keepPushingLayout },
};
if ((isModerator || isPresenter) && keepPushingLayout) {
updateSettings(obj, intlMessages.layoutToastLabelAuto);
} else if ((isModerator || isPresenter) && !keepPushingLayout) {
updateSettings(obj, intlMessages.layoutToastLabelAutoOff);
} else {
updateSettings(obj, intlMessages.layoutToastLabel);
}
updateSettings(obj, intlMessages.layoutToastLabel, setLocalSettings);
setIsOpen(false);
};
const toggleKeepPushingLayout = () => {
setKeepPushingLayout((current) => !current);
};
const displayToggleStatus = (toggleValue) => (
<Styled.ToggleLabel>
{toggleValue ? intl.formatMessage(intlMessages.on)
: intl.formatMessage(intlMessages.off)}
</Styled.ToggleLabel>
);
const renderToggle = () => (
<Styled.ToggleStatusWrapper>
{displayToggleStatus(keepPushingLayout)}
<Toggle
id="TogglePush"
icons={false}
defaultChecked={keepPushingLayout}
onChange={toggleKeepPushingLayout}
ariaLabel="push"
data-test="updateEveryoneLayoutToggle"
showToggleLabel={false}
/>
</Styled.ToggleStatusWrapper>
);
const renderPushLayoutsOptions = () => {
if (!isModerator && !isPresenter) {
return null;
}
if (isKeepPushingLayoutEnabled) {
return (
<Styled.PushContainer>
<Styled.LabelPushLayout>
{intl.formatMessage(intlMessages.updateAll)}
</Styled.LabelPushLayout>
{renderToggle()}
</Styled.PushContainer>
);
}
return null;
};
const renderLayoutButtons = () => (
<Styled.ButtonsContainer>
{Object.values(LAYOUT_TYPE)
.filter((layout) => !HIDDEN_LAYOUTS.includes(layout))
.map((layout) => (
<Styled.ButtonLayoutContainer key={layout}>
<Styled.LayoutBtn
label=""
customIcon={(
<Styled.IconSvg
src={`${LAYOUTS_PATH}${layout}.svg`}
alt={`${layout} ${intl.formatMessage(intlMessages.layoutSingular)}`}
/>
)}
onClick={() => {
handleSwitchLayout(layout);
if (layout === LAYOUT_TYPE.CUSTOM_LAYOUT && application.selectedLayout !== layout) {
document.getElementById('layout')?.setAttribute('data-cam-position', CAMERADOCK_POSITION.CONTENT_TOP);
}
}}
active={(layout === selectedLayout).toString()}
aria-describedby="layout-btn-desc"
data-test={`${layout}Layout`}
/>
<Styled.LabelLayoutNames aria-hidden>{intl.formatMessage(intlMessages[`${layout}Layout`])}</Styled.LabelLayoutNames>
</Styled.ButtonLayoutContainer>
))}
</Styled.ButtonsContainer>
);
return (
<Styled.LayoutModal
contentLabel={intl.formatMessage(intlMessages.title)}
shouldShowCloseButton
shouldCloseOnOverlayClick
isPhone={deviceInfo.isPhone}
data-test="layoutChangeModal"
onRequestClose={() => setIsOpen(false)}
title={intl.formatMessage(intlMessages.title)}
{...{
isOpen,
onRequestClose,
}}
>
<Styled.Content>
<Styled.BodyContainer>
{renderLayoutButtons()}
</Styled.BodyContainer>
</Styled.Content>
<Styled.ButtonBottomContainer>
{renderPushLayoutsOptions()}
<Button
color="primary"
label={intl.formatMessage(intlMessages.update)}
onClick={() => handleUpdateLayout()}
data-test="updateLayoutBtn"
/>
</Styled.ButtonBottomContainer>
<div style={{ display: 'none' }} id="layout-btn-desc">{intl.formatMessage(intlMessages.layoutBtnDesc)}</div>
</Styled.LayoutModal>
);
};
const propTypes = {
intl: PropTypes.shape({
formatMessage: PropTypes.func.isRequired,
}).isRequired,
isModerator: PropTypes.bool,
isPresenter: PropTypes.bool.isRequired,
application: PropTypes.shape({
selectedLayout: PropTypes.string.isRequired,
}).isRequired,
updateSettings: PropTypes.func.isRequired,
setLocalSettings: PropTypes.func.isRequired,
};
LayoutModalComponent.propTypes = propTypes;
export default injectIntl(LayoutModalComponent);