diff --git a/src/@types/global.d.ts b/src/@types/global.d.ts
index d79ca75f9f..080cdacafd 100644
--- a/src/@types/global.d.ts
+++ b/src/@types/global.d.ts
@@ -24,6 +24,7 @@ import { RoomListStoreClass } from "../stores/room-list/RoomListStore";
import { PlatformPeg } from "../PlatformPeg";
import RoomListLayoutStore from "../stores/room-list/RoomListLayoutStore";
import {IntegrationManagers} from "../integrations/IntegrationManagers";
+import {ModalManager} from "../Modal";
declare global {
interface Window {
@@ -41,6 +42,7 @@ declare global {
mxRoomListLayoutStore: RoomListLayoutStore;
mxPlatformPeg: PlatformPeg;
mxIntegrationManagers: typeof IntegrationManagers;
+ singletonModalManager: ModalManager;
}
// workaround for https://github.com/microsoft/TypeScript/issues/30933
diff --git a/src/ContentMessages.tsx b/src/ContentMessages.tsx
index e0597f5e59..6f55a75d0c 100644
--- a/src/ContentMessages.tsx
+++ b/src/ContentMessages.tsx
@@ -386,7 +386,7 @@ export default class ContentMessages {
const isQuoting = Boolean(RoomViewStore.getQuotingEvent());
if (isQuoting) {
const QuestionDialog = sdk.getComponent("dialogs.QuestionDialog");
- const {finished} = Modal.createTrackedDialog('Upload Reply Warning', '', QuestionDialog, {
+ const {finished} = Modal.createTrackedDialog<[boolean]>('Upload Reply Warning', '', QuestionDialog, {
title: _t('Replying With Files'),
description: (
{_t(
@@ -397,7 +397,7 @@ export default class ContentMessages {
hasCancelButton: true,
button: _t("Continue"),
});
- const [shouldUpload]: [boolean] = await finished;
+ const [shouldUpload] = await finished;
if (!shouldUpload) return;
}
@@ -420,12 +420,12 @@ export default class ContentMessages {
if (tooBigFiles.length > 0) {
const UploadFailureDialog = sdk.getComponent("dialogs.UploadFailureDialog");
- const {finished} = Modal.createTrackedDialog('Upload Failure', '', UploadFailureDialog, {
+ const {finished} = Modal.createTrackedDialog<[boolean]>('Upload Failure', '', UploadFailureDialog, {
badFiles: tooBigFiles,
totalFiles: files.length,
contentMessages: this,
});
- const [shouldContinue]: [boolean] = await finished;
+ const [shouldContinue] = await finished;
if (!shouldContinue) return;
}
@@ -437,12 +437,12 @@ export default class ContentMessages {
for (let i = 0; i < okFiles.length; ++i) {
const file = okFiles[i];
if (!uploadAll) {
- const {finished} = Modal.createTrackedDialog('Upload Files confirmation', '', UploadConfirmDialog, {
+ const {finished} = Modal.createTrackedDialog<[boolean, boolean]>('Upload Files confirmation', '', UploadConfirmDialog, {
file,
currentIndex: i,
totalFiles: okFiles.length,
});
- const [shouldContinue, shouldUploadAll]: [boolean, boolean] = await finished;
+ const [shouldContinue, shouldUploadAll] = await finished;
if (!shouldContinue) break;
if (shouldUploadAll) {
uploadAll = true;
diff --git a/src/Modal.js b/src/Modal.tsx
similarity index 50%
rename from src/Modal.js
rename to src/Modal.tsx
index 9b9f190d58..b744dbacf4 100644
--- a/src/Modal.js
+++ b/src/Modal.tsx
@@ -1,5 +1,6 @@
/*
Copyright 2015, 2016 OpenMarket Ltd
+Copyright 2020 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -17,6 +18,8 @@ limitations under the License.
import React from 'react';
import ReactDOM from 'react-dom';
+import classNames from 'classnames';
+
import Analytics from './Analytics';
import dis from './dispatcher/dispatcher';
import {defer} from './utils/promise';
@@ -25,36 +28,48 @@ import AsyncWrapper from './AsyncWrapper';
const DIALOG_CONTAINER_ID = "mx_Dialog_Container";
const STATIC_DIALOG_CONTAINER_ID = "mx_Dialog_StaticContainer";
-class ModalManager {
- constructor() {
- this._counter = 0;
+interface IModal
{
+ elem: React.ReactNode;
+ className?: string;
+ beforeClosePromise?: Promise;
+ closeReason?: string;
+ onBeforeClose?(reason?: string): Promise;
+ onFinished(...args: T): void;
+ close(...args: T): void;
+}
- // The modal to prioritise over all others. If this is set, only show
- // this modal. Remove all other modals from the stack when this modal
- // is closed.
- this._priorityModal = null;
- // The modal to keep open underneath other modals if possible. Useful
- // for cases like Settings where the modal should remain open while the
- // user is prompted for more information/errors.
- this._staticModal = null;
- // A list of the modals we have stacked up, with the most recent at [0]
- // Neither the static nor priority modal will be in this list.
- this._modals = [
- /* {
- elem: React component for this dialog
- onFinished: caller-supplied onFinished callback
- className: CSS class for the dialog wrapper div
- } */
- ];
+interface IHandle {
+ finished: Promise;
+ close(...args: T): void;
+}
- this.onBackgroundClick = this.onBackgroundClick.bind(this);
- }
+interface IProps {
+ onFinished?(...args: T): void;
+ // TODO improve typing here once all Modals are TS and we can exhaustively check the props
+ [key: string]: any;
+}
- hasDialogs() {
- return this._priorityModal || this._staticModal || this._modals.length > 0;
- }
+interface IOptions {
+ onBeforeClose?: IModal["onBeforeClose"];
+}
- getOrCreateContainer() {
+type ParametersWithoutFirst any> = T extends (a: any, ...args: infer P) => any ? P : never;
+
+export class ModalManager {
+ private counter = 0;
+ // The modal to prioritise over all others. If this is set, only show
+ // this modal. Remove all other modals from the stack when this modal
+ // is closed.
+ private priorityModal: IModal = null;
+ // The modal to keep open underneath other modals if possible. Useful
+ // for cases like Settings where the modal should remain open while the
+ // user is prompted for more information/errors.
+ private staticModal: IModal = null;
+ // A list of the modals we have stacked up, with the most recent at [0]
+ // Neither the static nor priority modal will be in this list.
+ private modals: IModal[] = [];
+
+ private static getOrCreateContainer() {
let container = document.getElementById(DIALOG_CONTAINER_ID);
if (!container) {
@@ -66,7 +81,7 @@ class ModalManager {
return container;
}
- getOrCreateStaticContainer() {
+ private static getOrCreateStaticContainer() {
let container = document.getElementById(STATIC_DIALOG_CONTAINER_ID);
if (!container) {
@@ -78,63 +93,99 @@ class ModalManager {
return container;
}
- createTrackedDialog(analyticsAction, analyticsInfo, ...rest) {
+ public hasDialogs() {
+ return this.priorityModal || this.staticModal || this.modals.length > 0;
+ }
+
+ public createTrackedDialog(
+ analyticsAction: string,
+ analyticsInfo: string,
+ ...rest: Parameters
+ ) {
Analytics.trackEvent('Modal', analyticsAction, analyticsInfo);
- return this.createDialog(...rest);
+ return this.createDialog(...rest);
}
- appendTrackedDialog(analyticsAction, analyticsInfo, ...rest) {
+ public appendTrackedDialog(
+ analyticsAction: string,
+ analyticsInfo: string,
+ ...rest: Parameters
+ ) {
Analytics.trackEvent('Modal', analyticsAction, analyticsInfo);
- return this.appendDialog(...rest);
+ return this.appendDialog(...rest);
}
- createDialog(Element, ...rest) {
- return this.createDialogAsync(Promise.resolve(Element), ...rest);
+ public createDialog(
+ Element: React.ComponentType,
+ ...rest: ParametersWithoutFirst
+ ) {
+ return this.createDialogAsync(Promise.resolve(Element), ...rest);
}
- appendDialog(Element, ...rest) {
- return this.appendDialogAsync(Promise.resolve(Element), ...rest);
+ public appendDialog(
+ Element: React.ComponentType,
+ ...rest: ParametersWithoutFirst
+ ) {
+ return this.appendDialogAsync(Promise.resolve(Element), ...rest);
}
- createTrackedDialogAsync(analyticsAction, analyticsInfo, ...rest) {
+ public createTrackedDialogAsync(
+ analyticsAction: string,
+ analyticsInfo: string,
+ ...rest: Parameters
+ ) {
Analytics.trackEvent('Modal', analyticsAction, analyticsInfo);
- return this.createDialogAsync(...rest);
+ return this.createDialogAsync(...rest);
}
- appendTrackedDialogAsync(analyticsAction, analyticsInfo, ...rest) {
+ public appendTrackedDialogAsync(
+ analyticsAction: string,
+ analyticsInfo: string,
+ ...rest: Parameters
+ ) {
Analytics.trackEvent('Modal', analyticsAction, analyticsInfo);
- return this.appendDialogAsync(...rest);
+ return this.appendDialogAsync(...rest);
}
- _buildModal(prom, props, className, options) {
- const modal = {};
+ private buildModal(
+ prom: Promise,
+ props?: IProps,
+ className?: string,
+ options?: IOptions
+ ) {
+ const modal: IModal = {
+ onFinished: props ? props.onFinished : null,
+ onBeforeClose: options.onBeforeClose,
+ beforeClosePromise: null,
+ closeReason: null,
+ className,
+
+ // these will be set below but we need an object reference to pass to getCloseFn before we can do that
+ elem: null,
+ close: null,
+ };
// never call this from onFinished() otherwise it will loop
- const [closeDialog, onFinishedProm] = this._getCloseFn(modal, props);
+ const [closeDialog, onFinishedProm] = this.getCloseFn(modal, props);
// don't attempt to reuse the same AsyncWrapper for different dialogs,
// otherwise we'll get confused.
- const modalCount = this._counter++;
+ const modalCount = this.counter++;
// FIXME: If a dialog uses getDefaultProps it clobbers the onFinished
// property set here so you can't close the dialog from a button click!
- modal.elem = (
-
- );
- modal.onFinished = props ? props.onFinished : null;
- modal.className = className;
- modal.onBeforeClose = options.onBeforeClose;
- modal.beforeClosePromise = null;
+ modal.elem = ;
modal.close = closeDialog;
- modal.closeReason = null;
return {modal, closeDialog, onFinishedProm};
}
- _getCloseFn(modal, props) {
- const deferred = defer();
- return [async (...args) => {
+ private getCloseFn(
+ modal: IModal,
+ props: IProps
+ ): [IHandle["close"], IHandle["finished"]] {
+ const deferred = defer();
+ return [async (...args: T) => {
if (modal.beforeClosePromise) {
await modal.beforeClosePromise;
} else if (modal.onBeforeClose) {
@@ -147,26 +198,26 @@ class ModalManager {
}
deferred.resolve(args);
if (props && props.onFinished) props.onFinished.apply(null, args);
- const i = this._modals.indexOf(modal);
+ const i = this.modals.indexOf(modal);
if (i >= 0) {
- this._modals.splice(i, 1);
+ this.modals.splice(i, 1);
}
- if (this._priorityModal === modal) {
- this._priorityModal = null;
+ if (this.priorityModal === modal) {
+ this.priorityModal = null;
// XXX: This is destructive
- this._modals = [];
+ this.modals = [];
}
- if (this._staticModal === modal) {
- this._staticModal = null;
+ if (this.staticModal === modal) {
+ this.staticModal = null;
// XXX: This is destructive
- this._modals = [];
+ this.modals = [];
}
- this._reRender();
+ this.reRender();
}, deferred.promise];
}
@@ -207,38 +258,49 @@ class ModalManager {
* @param {onBeforeClose} options.onBeforeClose a callback to decide whether to close the dialog
* @returns {object} Object with 'close' parameter being a function that will close the dialog
*/
- createDialogAsync(prom, props, className, isPriorityModal, isStaticModal, options = {}) {
- const {modal, closeDialog, onFinishedProm} = this._buildModal(prom, props, className, options);
+ private createDialogAsync(
+ prom: Promise,
+ props?: IProps,
+ className?: string,
+ isPriorityModal = false,
+ isStaticModal = false,
+ options: IOptions = {}
+ ): IHandle {
+ const {modal, closeDialog, onFinishedProm} = this.buildModal(prom, props, className, options);
if (isPriorityModal) {
// XXX: This is destructive
- this._priorityModal = modal;
+ this.priorityModal = modal;
} else if (isStaticModal) {
// This is intentionally destructive
- this._staticModal = modal;
+ this.staticModal = modal;
} else {
- this._modals.unshift(modal);
+ this.modals.unshift(modal);
}
- this._reRender();
+ this.reRender();
return {
close: closeDialog,
finished: onFinishedProm,
};
}
- appendDialogAsync(prom, props, className) {
- const {modal, closeDialog, onFinishedProm} = this._buildModal(prom, props, className, {});
+ private appendDialogAsync(
+ prom: Promise,
+ props?: IProps,
+ className?: string
+ ): IHandle {
+ const {modal, closeDialog, onFinishedProm} = this.buildModal(prom, props, className, {});
- this._modals.push(modal);
- this._reRender();
+ this.modals.push(modal);
+ this.reRender();
return {
close: closeDialog,
finished: onFinishedProm,
};
}
- onBackgroundClick() {
- const modal = this._getCurrentModal();
+ private onBackgroundClick = () => {
+ const modal = this.getCurrentModal();
if (!modal) {
return;
}
@@ -249,21 +311,21 @@ class ModalManager {
modal.closeReason = "backgroundClick";
modal.close();
modal.closeReason = null;
+ };
+
+ private getCurrentModal(): IModal {
+ return this.priorityModal ? this.priorityModal : (this.modals[0] || this.staticModal);
}
- _getCurrentModal() {
- return this._priorityModal ? this._priorityModal : (this._modals[0] || this._staticModal);
- }
-
- _reRender() {
- if (this._modals.length === 0 && !this._priorityModal && !this._staticModal) {
+ private reRender() {
+ if (this.modals.length === 0 && !this.priorityModal && !this.staticModal) {
// If there is no modal to render, make all of Riot available
// to screen reader users again
dis.dispatch({
action: 'aria_unhide_main_app',
});
- ReactDOM.unmountComponentAtNode(this.getOrCreateContainer());
- ReactDOM.unmountComponentAtNode(this.getOrCreateStaticContainer());
+ ReactDOM.unmountComponentAtNode(ModalManager.getOrCreateContainer());
+ ReactDOM.unmountComponentAtNode(ModalManager.getOrCreateStaticContainer());
return;
}
@@ -274,49 +336,48 @@ class ModalManager {
action: 'aria_hide_main_app',
});
- if (this._staticModal) {
- const classes = "mx_Dialog_wrapper mx_Dialog_staticWrapper "
- + (this._staticModal.className ? this._staticModal.className : '');
+ if (this.staticModal) {
+ const classes = classNames("mx_Dialog_wrapper mx_Dialog_staticWrapper", this.staticModal.className);
const staticDialog = (
- { this._staticModal.elem }
+ { this.staticModal.elem }
-
+
);
- ReactDOM.render(staticDialog, this.getOrCreateStaticContainer());
+ ReactDOM.render(staticDialog, ModalManager.getOrCreateStaticContainer());
} else {
// This is safe to call repeatedly if we happen to do that
- ReactDOM.unmountComponentAtNode(this.getOrCreateStaticContainer());
+ ReactDOM.unmountComponentAtNode(ModalManager.getOrCreateStaticContainer());
}
- const modal = this._getCurrentModal();
- if (modal !== this._staticModal) {
- const classes = "mx_Dialog_wrapper "
- + (this._staticModal ? "mx_Dialog_wrapperWithStaticUnder " : '')
- + (modal.className ? modal.className : '');
+ const modal = this.getCurrentModal();
+ if (modal !== this.staticModal) {
+ const classes = classNames("mx_Dialog_wrapper", modal.className, {
+ mx_Dialog_wrapperWithStaticUnder: this.staticModal,
+ });
const dialog = (
);
- ReactDOM.render(dialog, this.getOrCreateContainer());
+ ReactDOM.render(dialog, ModalManager.getOrCreateContainer());
} else {
// This is safe to call repeatedly if we happen to do that
- ReactDOM.unmountComponentAtNode(this.getOrCreateContainer());
+ ReactDOM.unmountComponentAtNode(ModalManager.getOrCreateContainer());
}
}
}
-if (!global.singletonModalManager) {
- global.singletonModalManager = new ModalManager();
+if (!window.singletonModalManager) {
+ window.singletonModalManager = new ModalManager();
}
-export default global.singletonModalManager;
+export default window.singletonModalManager;
diff --git a/src/SlashCommands.tsx b/src/SlashCommands.tsx
index 40bf0a8e49..ad3dc7002a 100644
--- a/src/SlashCommands.tsx
+++ b/src/SlashCommands.tsx
@@ -401,14 +401,16 @@ export const Commands = [
// If we need an identity server but don't have one, things
// get a bit more complex here, but we try to show something
// meaningful.
- let finished = Promise.resolve();
+ let prom = Promise.resolve();
if (
getAddressType(address) === 'email' &&
!MatrixClientPeg.get().getIdentityServerUrl()
) {
const defaultIdentityServerUrl = getDefaultIdentityServerUrl();
if (defaultIdentityServerUrl) {
- ({ finished } = Modal.createTrackedDialog('Slash Commands', 'Identity server',
+ const { finished } = Modal.createTrackedDialog<[boolean]>(
+ 'Slash Commands',
+ 'Identity server',
QuestionDialog, {
title: _t("Use an identity server"),
description: {_t(
@@ -421,9 +423,9 @@ export const Commands = [
)}
,
button: _t("Continue"),
},
- ));
+ );
- finished = finished.then(([useDefault]: any) => {
+ prom = finished.then(([useDefault]) => {
if (useDefault) {
useDefaultIdentityServer();
return;
@@ -435,7 +437,7 @@ export const Commands = [
}
}
const inviter = new MultiInviter(roomId);
- return success(finished.then(() => {
+ return success(prom.then(() => {
return inviter.invite([address]);
}).then(() => {
if (inviter.getCompletionState(address) !== "invited") {