140 lines
4.1 KiB
TypeScript
140 lines
4.1 KiB
TypeScript
// Copyright 2019-2022 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
import React, { useEffect } from 'react';
|
|
import { createPortal } from 'react-dom';
|
|
import FocusTrap from 'focus-trap-react';
|
|
import type { SpringValues } from '@react-spring/web';
|
|
import { animated } from '@react-spring/web';
|
|
import classNames from 'classnames';
|
|
import { noop } from 'lodash';
|
|
|
|
import type { ModalConfigType } from '../hooks/useAnimated';
|
|
import type { Theme } from '../util/theme';
|
|
import { assertDev } from '../util/assert';
|
|
import { getClassNamesFor } from '../util/getClassNamesFor';
|
|
import { themeClassName } from '../util/theme';
|
|
import { useEscapeHandling } from '../hooks/useEscapeHandling';
|
|
import { usePrevious } from '../hooks/usePrevious';
|
|
import { handleOutsideClick } from '../util/handleOutsideClick';
|
|
import * as log from '../logging/log';
|
|
|
|
export type PropsType = Readonly<{
|
|
children: React.ReactElement;
|
|
modalName: string;
|
|
moduleClassName?: string;
|
|
noMouseClose?: boolean;
|
|
onClose: () => unknown;
|
|
onEscape?: () => unknown;
|
|
onTopOfEverything?: boolean;
|
|
overlayStyles?: SpringValues<ModalConfigType>;
|
|
theme?: Theme;
|
|
useFocusTrap?: boolean;
|
|
}>;
|
|
|
|
export const ModalHost = React.memo(
|
|
({
|
|
children,
|
|
modalName,
|
|
moduleClassName,
|
|
noMouseClose,
|
|
onClose,
|
|
onEscape,
|
|
onTopOfEverything,
|
|
overlayStyles,
|
|
theme,
|
|
useFocusTrap = true,
|
|
}: PropsType) => {
|
|
const [root, setRoot] = React.useState<HTMLElement | null>(null);
|
|
const containerRef = React.useRef<HTMLDivElement | null>(null);
|
|
const previousModalName = usePrevious(modalName, modalName);
|
|
|
|
if (previousModalName !== modalName) {
|
|
log.error(
|
|
`ModalHost detected conflict between ${previousModalName} ` +
|
|
`and ${modalName}. Consider using "key" attributes on both modals.`
|
|
);
|
|
assertDev(false, 'Modal conflict');
|
|
}
|
|
|
|
useEffect(() => {
|
|
const div = document.createElement('div');
|
|
document.body.appendChild(div);
|
|
setRoot(div);
|
|
|
|
return () => {
|
|
document.body.removeChild(div);
|
|
setRoot(null);
|
|
};
|
|
}, []);
|
|
|
|
useEscapeHandling(onEscape || onClose);
|
|
useEffect(() => {
|
|
if (noMouseClose) {
|
|
return noop;
|
|
}
|
|
return handleOutsideClick(
|
|
() => {
|
|
onClose();
|
|
return true;
|
|
},
|
|
{ containerElements: [containerRef], name: modalName }
|
|
);
|
|
}, [noMouseClose, onClose, containerRef, modalName]);
|
|
|
|
const className = classNames([
|
|
theme ? themeClassName(theme) : undefined,
|
|
onTopOfEverything ? 'module-modal-host--on-top-of-everything' : undefined,
|
|
]);
|
|
const getClassName = getClassNamesFor('module-modal-host', moduleClassName);
|
|
|
|
const modalContent = (
|
|
<div className={className}>
|
|
<animated.div
|
|
role="presentation"
|
|
className={getClassName('__overlay')}
|
|
style={overlayStyles}
|
|
/>
|
|
<div className={getClassName('__overlay-container')}>
|
|
<div ref={containerRef} className={getClassName('__width-container')}>
|
|
{children}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
|
|
return root
|
|
? createPortal(
|
|
useFocusTrap ? (
|
|
<FocusTrap
|
|
focusTrapOptions={{
|
|
allowOutsideClick: ({ target }) => {
|
|
if (!target || !(target instanceof HTMLElement)) {
|
|
return false;
|
|
}
|
|
|
|
// TitleBar should always receive clicks. Quill suggestions
|
|
// are placed in the document.body so they should be exempt
|
|
// too.
|
|
const exemptParent = target.closest(
|
|
'.TitleBarContainer__title, ' +
|
|
'.module-composition-input__suggestions'
|
|
);
|
|
if (exemptParent) {
|
|
return true;
|
|
}
|
|
return false;
|
|
},
|
|
}}
|
|
>
|
|
{modalContent}
|
|
</FocusTrap>
|
|
) : (
|
|
modalContent
|
|
),
|
|
root
|
|
)
|
|
: null;
|
|
}
|
|
);
|