125 lines
5 KiB
TypeScript
125 lines
5 KiB
TypeScript
/*
|
|
Copyright 2021 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.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import React, { FormEvent } from "react";
|
|
import { MatrixClient } from "matrix-js-sdk/src/matrix";
|
|
import FocusLock from "react-focus-lock";
|
|
|
|
import { MatrixClientPeg } from "../../../MatrixClientPeg";
|
|
import MatrixClientContext from "../../../contexts/MatrixClientContext";
|
|
import { _t } from "../../../languageHandler";
|
|
import AccessibleButton from "../elements/AccessibleButton";
|
|
import { KeyBindingAction } from "../../../accessibility/KeyboardShortcuts";
|
|
import { getKeyBindingsManager } from "../../../KeyBindingsManager";
|
|
|
|
export interface IScrollableBaseState {
|
|
canSubmit: boolean;
|
|
title: string;
|
|
actionLabel: string;
|
|
cancelLabel?: string;
|
|
}
|
|
|
|
/**
|
|
* Scrollable dialog base from Compound (Web Components).
|
|
*/
|
|
export default abstract class ScrollableBaseModal<
|
|
TProps extends { onFinished?: (...args: any[]) => void },
|
|
TState extends IScrollableBaseState,
|
|
> extends React.PureComponent<TProps, TState> {
|
|
protected constructor(props: TProps) {
|
|
super(props);
|
|
}
|
|
|
|
protected get matrixClient(): MatrixClient {
|
|
// XXX: The contract on MatrixClientContext says it is only available within a LoggedInView subtree,
|
|
// given that modals function outside the MatrixChat React tree this simulates that. We don't want to
|
|
// use safeGet as it throwing would mean we cannot use modals whilst the user isn't logged in.
|
|
// The longer term solution is to move our ModalManager into the React tree to inherit contexts properly.
|
|
return MatrixClientPeg.get()!;
|
|
}
|
|
|
|
private onKeyDown = (e: KeyboardEvent | React.KeyboardEvent): void => {
|
|
const action = getKeyBindingsManager().getAccessibilityAction(e);
|
|
switch (action) {
|
|
case KeyBindingAction.Escape:
|
|
e.stopPropagation();
|
|
e.preventDefault();
|
|
this.cancel();
|
|
break;
|
|
}
|
|
};
|
|
|
|
private onCancel = (): void => {
|
|
this.cancel();
|
|
};
|
|
|
|
private onSubmit = (e: MouseEvent | FormEvent): void => {
|
|
e.stopPropagation();
|
|
e.preventDefault();
|
|
if (!this.state.canSubmit) return; // pretend the submit button was disabled
|
|
this.submit();
|
|
};
|
|
|
|
protected abstract cancel(): void;
|
|
protected abstract submit(): void;
|
|
protected abstract renderContent(): React.ReactNode;
|
|
|
|
public render(): React.ReactNode {
|
|
return (
|
|
<MatrixClientContext.Provider value={this.matrixClient}>
|
|
<FocusLock
|
|
returnFocus={true}
|
|
lockProps={{
|
|
onKeyDown: this.onKeyDown,
|
|
role: "dialog",
|
|
["aria-labelledby"]: "mx_CompoundDialog_title",
|
|
|
|
// Like BaseDialog, we'll just point this at the whole content
|
|
["aria-describedby"]: "mx_CompoundDialog_content",
|
|
}}
|
|
className="mx_CompoundDialog mx_ScrollableBaseDialog"
|
|
>
|
|
<div className="mx_CompoundDialog_header">
|
|
<h1>{this.state.title}</h1>
|
|
<AccessibleButton
|
|
onClick={this.onCancel}
|
|
className="mx_CompoundDialog_cancelButton"
|
|
aria-label={_t("dialog_close_label")}
|
|
/>
|
|
</div>
|
|
<form onSubmit={this.onSubmit} className="mx_CompoundDialog_form">
|
|
<div className="mx_CompoundDialog_content">{this.renderContent()}</div>
|
|
<div className="mx_CompoundDialog_footer">
|
|
<AccessibleButton onClick={this.onCancel} kind="primary_outline">
|
|
{this.state.cancelLabel ?? _t("action|cancel")}
|
|
</AccessibleButton>
|
|
<AccessibleButton
|
|
onClick={this.onSubmit}
|
|
kind="primary"
|
|
disabled={!this.state.canSubmit}
|
|
type="submit"
|
|
element="button"
|
|
className="mx_Dialog_nonDialogButton"
|
|
>
|
|
{this.state.actionLabel}
|
|
</AccessibleButton>
|
|
</div>
|
|
</form>
|
|
</FocusLock>
|
|
</MatrixClientContext.Provider>
|
|
);
|
|
}
|
|
}
|