Split KeyAction into multiple enums

This gives some additional type safety and makes enum member usage more
clear.
This commit is contained in:
Clemens Zeidler 2021-03-01 21:43:00 +13:00
parent 32ec8b7dc8
commit 601be50b71
8 changed files with 185 additions and 193 deletions

View file

@ -55,7 +55,7 @@ import { IThreepidInvite } from "../../stores/ThreepidInviteStore";
import Modal from "../../Modal";
import { ICollapseConfig } from "../../resizer/distributors/collapse";
import HostSignupContainer from '../views/host_signup/HostSignupContainer';
import { getKeyBindingsManager, KeyAction, KeyBindingContext } from '../../KeyBindingsManager';
import { getKeyBindingsManager, NavigationAction, RoomAction } from '../../KeyBindingsManager';
// We need to fetch each pinned message individually (if we don't already have it)
// so each pinned message may trigger a request. Limit the number per room for sanity.
@ -401,22 +401,22 @@ class LoggedInView extends React.Component<IProps, IState> {
_onKeyDown = (ev) => {
let handled = false;
const roomAction = getKeyBindingsManager().getAction(KeyBindingContext.Room, ev);
const roomAction = getKeyBindingsManager().getRoomAction(ev);
switch (roomAction) {
case KeyAction.RoomFocusRoomSearch:
case RoomAction.FocusRoomSearch:
dis.dispatch({
action: 'focus_room_filter',
});
handled = true;
break;
case KeyAction.RoomScrollUp:
case KeyAction.RoomScrollDown:
case KeyAction.RoomJumpToFirstMessage:
case KeyAction.RoomJumpToLatestMessage:
case RoomAction.ScrollUp:
case RoomAction.RoomScrollDown:
case RoomAction.JumpToFirstMessage:
case RoomAction.JumpToLatestMessage:
this._onScrollKeyPressed(ev);
handled = true;
break;
case KeyAction.RoomSearch:
case RoomAction.FocusSearch:
dis.dispatch({
action: 'focus_search',
});
@ -429,24 +429,24 @@ class LoggedInView extends React.Component<IProps, IState> {
return;
}
const navAction = getKeyBindingsManager().getAction(KeyBindingContext.Navigation, ev);
const navAction = getKeyBindingsManager().getNavigationAction(ev);
switch (navAction) {
case KeyAction.NavToggleUserMenu:
case NavigationAction.ToggleUserMenu:
dis.fire(Action.ToggleUserMenu);
handled = true;
break;
case KeyAction.NavToggleShortCutDialog:
case NavigationAction.ToggleShortCutDialog:
KeyboardShortcuts.toggleDialog();
handled = true;
break;
case KeyAction.NavGoToHome:
case NavigationAction.GoToHome:
dis.dispatch({
action: 'view_home_page',
});
Modal.closeCurrentModal("homeKeyboardShortcut");
handled = true;
break;
case KeyAction.NavToggleRoomSidePanel:
case NavigationAction.ToggleRoomSidePanel:
if (this.props.page_type === "room_view" || this.props.page_type === "group_view") {
dis.dispatch<ToggleRightPanelPayload>({
action: Action.ToggleRightPanel,
@ -455,7 +455,7 @@ class LoggedInView extends React.Component<IProps, IState> {
handled = true;
}
break;
case KeyAction.NavSelectPrevRoom:
case NavigationAction.SelectPrevRoom:
dis.dispatch<ViewRoomDeltaPayload>({
action: Action.ViewRoomDelta,
delta: -1,
@ -463,7 +463,7 @@ class LoggedInView extends React.Component<IProps, IState> {
});
handled = true;
break;
case KeyAction.NavSelectNextRoom:
case NavigationAction.SelectNextRoom:
dis.dispatch<ViewRoomDeltaPayload>({
action: Action.ViewRoomDelta,
delta: 1,
@ -471,14 +471,14 @@ class LoggedInView extends React.Component<IProps, IState> {
});
handled = true;
break;
case KeyAction.NavSelectPrevUnreadRoom:
case NavigationAction.SelectPrevUnreadRoom:
dis.dispatch<ViewRoomDeltaPayload>({
action: Action.ViewRoomDelta,
delta: -1,
unread: true,
});
break;
case KeyAction.NavSelectNextUnreadRoom:
case NavigationAction.SelectNextUnreadRoom:
dis.dispatch<ViewRoomDeltaPayload>({
action: Action.ViewRoomDelta,
delta: 1,

View file

@ -24,7 +24,7 @@ import AccessibleButton from "../views/elements/AccessibleButton";
import { Action } from "../../dispatcher/actions";
import RoomListStore from "../../stores/room-list/RoomListStore";
import { NameFilterCondition } from "../../stores/room-list/filters/NameFilterCondition";
import { getKeyBindingsManager, KeyAction, KeyBindingContext } from "../../KeyBindingsManager";
import { getKeyBindingsManager, RoomListAction } from "../../KeyBindingsManager";
interface IProps {
isMinimized: boolean;
@ -106,17 +106,17 @@ export default class RoomSearch extends React.PureComponent<IProps, IState> {
};
private onKeyDown = (ev: React.KeyboardEvent) => {
const action = getKeyBindingsManager().getAction(KeyBindingContext.RoomList, ev);
const action = getKeyBindingsManager().getRoomListAction(ev);
switch (action) {
case KeyAction.RoomListClearSearch:
case RoomListAction.ClearSearch:
this.clearInput();
defaultDispatcher.fire(Action.FocusComposer);
break;
case KeyAction.RoomListNextRoom:
case KeyAction.RoomListPrevRoom:
case RoomListAction.NextRoom:
case RoomListAction.PrevRoom:
this.props.onVerticalArrow(ev);
break;
case KeyAction.RoomListSelectRoom: {
case RoomListAction.SelectRoom: {
const shouldClear = this.props.onEnter(ev);
if (shouldClear) {
// wrap in set immediate to delay it so that we don't clear the filter & then change room

View file

@ -78,7 +78,7 @@ import Notifier from "../../Notifier";
import { showToast as showNotificationsToast } from "../../toasts/DesktopNotificationsToast";
import { RoomNotificationStateStore } from "../../stores/notifications/RoomNotificationStateStore";
import { Container, WidgetLayoutStore } from "../../stores/widgets/WidgetLayoutStore";
import { getKeyBindingsManager, KeyAction, KeyBindingContext } from '../../KeyBindingsManager';
import { getKeyBindingsManager, RoomAction } from '../../KeyBindingsManager';
const DEBUG = false;
let debuglog = function(msg: string) {};
@ -661,18 +661,18 @@ export default class RoomView extends React.Component<IProps, IState> {
private onReactKeyDown = ev => {
let handled = false;
const action = getKeyBindingsManager().getAction(KeyBindingContext.Room, ev);
const action = getKeyBindingsManager().getRoomAction(ev);
switch (action) {
case KeyAction.RoomDismissReadMarker:
case RoomAction.DismissReadMarker:
this.messagePanel.forgetReadMarker();
this.jumpToLiveTimeline();
handled = true;
break;
case KeyAction.RoomScrollUp:
case RoomAction.ScrollUp:
this.jumpToReadMarker();
handled = true;
break;
case KeyAction.RoomUploadFile:
case RoomAction.UploadFile:
dis.dispatch({ action: "upload_file" }, true);
handled = true;
break;

View file

@ -46,7 +46,7 @@ import {IDiff} from "../../../editor/diff";
import AutocompleteWrapperModel from "../../../editor/autocomplete";
import DocumentPosition from "../../../editor/position";
import {ICompletion} from "../../../autocomplete/Autocompleter";
import { getKeyBindingsManager, KeyBindingContext, KeyAction } from '../../../KeyBindingsManager';
import { AutocompleteAction, getKeyBindingsManager, MessageComposerAction } from '../../../KeyBindingsManager';
// matches emoticons which follow the start of a line or whitespace
const REGEX_EMOTICON_WHITESPACE = new RegExp('(?:^|\\s)(' + EMOTICON_REGEX.source + ')\\s$');
@ -421,21 +421,21 @@ export default class BasicMessageEditor extends React.Component<IProps, IState>
private onKeyDown = (event: React.KeyboardEvent) => {
const model = this.props.model;
let handled = false;
const action = getKeyBindingsManager().getAction(KeyBindingContext.MessageComposer, event);
const action = getKeyBindingsManager().getMessageComposerAction(event);
switch (action) {
case KeyAction.FormatBold:
case MessageComposerAction.FormatBold:
this.onFormatAction(Formatting.Bold);
handled = true;
break;
case KeyAction.FormatItalics:
case MessageComposerAction.FormatItalics:
this.onFormatAction(Formatting.Italics);
handled = true;
break;
case KeyAction.FormatQuote:
case MessageComposerAction.FormatQuote:
this.onFormatAction(Formatting.Quote);
handled = true;
break;
case KeyAction.EditRedo:
case MessageComposerAction.EditRedo:
if (this.historyManager.canRedo()) {
const {parts, caret} = this.historyManager.redo();
// pass matching inputType so historyManager doesn't push echo
@ -444,7 +444,7 @@ export default class BasicMessageEditor extends React.Component<IProps, IState>
}
handled = true;
break;
case KeyAction.EditUndo:
case MessageComposerAction.EditUndo:
if (this.historyManager.canUndo()) {
const {parts, caret} = this.historyManager.undo(this.props.model);
// pass matching inputType so historyManager doesn't push echo
@ -453,18 +453,18 @@ export default class BasicMessageEditor extends React.Component<IProps, IState>
}
handled = true;
break;
case KeyAction.NewLine:
case MessageComposerAction.NewLine:
this.insertText("\n");
handled = true;
break;
case KeyAction.MoveCursorToStart:
case MessageComposerAction.MoveCursorToStart:
setSelection(this.editorRef.current, model, {
index: 0,
offset: 0,
});
handled = true;
break;
case KeyAction.MoveCursorToEnd:
case MessageComposerAction.MoveCursorToEnd:
setSelection(this.editorRef.current, model, {
index: model.parts.length - 1,
offset: model.parts[model.parts.length - 1].text.length,
@ -478,30 +478,30 @@ export default class BasicMessageEditor extends React.Component<IProps, IState>
return;
}
const autocompleteAction = getKeyBindingsManager().getAction(KeyBindingContext.AutoComplete, event);
const autocompleteAction = getKeyBindingsManager().getAutocompleteAction(event);
if (model.autoComplete && model.autoComplete.hasCompletions()) {
const autoComplete = model.autoComplete;
switch (autocompleteAction) {
case KeyAction.AutocompletePrevSelection:
case AutocompleteAction.PrevSelection:
autoComplete.onUpArrow(event);
handled = true;
break;
case KeyAction.AutocompleteNextSelection:
case AutocompleteAction.NextSelection:
autoComplete.onDownArrow(event);
handled = true;
break;
case KeyAction.AutocompleteApply:
case AutocompleteAction.ApplySelection:
autoComplete.onTab(event);
handled = true;
break;
case KeyAction.AutocompleteCancel:
case AutocompleteAction.Cancel:
autoComplete.onEscape(event);
handled = true;
break;
default:
return; // don't preventDefault on anything else
}
} else if (autocompleteAction === KeyAction.AutocompleteApply) {
} else if (autocompleteAction === AutocompleteAction.ApplySelection) {
this.tabCompleteName(event);
handled = true;
} else if (event.key === Key.BACKSPACE || event.key === Key.DELETE) {

View file

@ -32,7 +32,7 @@ import BasicMessageComposer from "./BasicMessageComposer";
import MatrixClientContext from "../../../contexts/MatrixClientContext";
import {Action} from "../../../dispatcher/actions";
import CountlyAnalytics from "../../../CountlyAnalytics";
import {getKeyBindingsManager, KeyAction, KeyBindingContext} from '../../../KeyBindingsManager';
import {getKeyBindingsManager, MessageComposerAction} from '../../../KeyBindingsManager';
function _isReply(mxEvent) {
const relatesTo = mxEvent.getContent()["m.relates_to"];
@ -133,16 +133,16 @@ export default class EditMessageComposer extends React.Component {
if (this._editorRef.isComposing(event)) {
return;
}
const action = getKeyBindingsManager().getAction(KeyBindingContext.MessageComposer, event);
const action = getKeyBindingsManager().getMessageComposerAction(event);
switch (action) {
case KeyAction.Send:
case MessageComposerAction.Send:
this._sendEdit();
event.preventDefault();
break;
case KeyAction.CancelEditing:
case MessageComposerAction.CancelEditing:
this._cancelEdit();
break;
case KeyAction.EditPrevMessage: {
case MessageComposerAction.EditPrevMessage: {
if (this._editorRef.isModified() || !this._editorRef.isCaretAtStart()) {
return;
}
@ -154,7 +154,7 @@ export default class EditMessageComposer extends React.Component {
}
break;
}
case KeyAction.EditNextMessage: {
case MessageComposerAction.EditNextMessage: {
if (this._editorRef.isModified() || !this._editorRef.isCaretAtEnd()) {
return;
}

View file

@ -51,7 +51,7 @@ import { objectExcluding, objectHasDiff } from "../../../utils/objects";
import TemporaryTile from "./TemporaryTile";
import { ListNotificationState } from "../../../stores/notifications/ListNotificationState";
import IconizedContextMenu from "../context_menus/IconizedContextMenu";
import { getKeyBindingsManager, KeyAction, KeyBindingContext } from "../../../KeyBindingsManager";
import { getKeyBindingsManager, RoomListAction } from "../../../KeyBindingsManager";
const SHOW_N_BUTTON_HEIGHT = 28; // As defined by CSS
const RESIZE_HANDLE_HEIGHT = 4; // As defined by CSS
@ -471,16 +471,16 @@ export default class RoomSublist extends React.Component<IProps, IState> {
};
private onHeaderKeyDown = (ev: React.KeyboardEvent) => {
const action = getKeyBindingsManager().getAction(KeyBindingContext.RoomList, ev);
const action = getKeyBindingsManager().getRoomListAction(ev);
switch (action) {
case KeyAction.RoomListCollapseSection:
case RoomListAction.CollapseSection:
ev.stopPropagation();
if (this.state.isExpanded) {
// Collapse the room sublist if it isn't already
this.toggleCollapsed();
}
break;
case KeyAction.RoomListExpandSection: {
case RoomListAction.ExpandSection: {
ev.stopPropagation();
if (!this.state.isExpanded) {
// Expand the room sublist if it isn't already

View file

@ -46,7 +46,7 @@ import {CHAT_EFFECTS} from '../../../effects';
import CountlyAnalytics from "../../../CountlyAnalytics";
import {MatrixClientPeg} from "../../../MatrixClientPeg";
import EMOJI_REGEX from 'emojibase-regex';
import {getKeyBindingsManager, KeyAction, KeyBindingContext} from '../../../KeyBindingsManager';
import {getKeyBindingsManager, MessageComposerAction} from '../../../KeyBindingsManager';
function addReplyToMessageContent(content, repliedToEvent, permalinkCreator) {
const replyContent = ReplyThread.makeReplyMixIn(repliedToEvent);
@ -143,23 +143,23 @@ export default class SendMessageComposer extends React.Component {
if (this._editorRef.isComposing(event)) {
return;
}
const action = getKeyBindingsManager().getAction(KeyBindingContext.MessageComposer, event);
const action = getKeyBindingsManager().getMessageComposerAction(event);
switch (action) {
case KeyAction.Send:
case MessageComposerAction.Send:
this._sendMessage();
event.preventDefault();
break;
case KeyAction.SelectPrevSendHistory:
case KeyAction.SelectNextSendHistory: {
case MessageComposerAction.SelectPrevSendHistory:
case MessageComposerAction.SelectNextSendHistory: {
// Try select composer history
const selected = this.selectSendHistory(action === KeyAction.SelectPrevSendHistory);
const selected = this.selectSendHistory(action === MessageComposerAction.SelectPrevSendHistory);
if (selected) {
// We're selecting history, so prevent the key event from doing anything else
event.preventDefault();
}
break;
}
case KeyAction.EditPrevMessage:
case MessageComposerAction.EditPrevMessage:
// selection must be collapsed and caret at start
if (this._editorRef.isSelectionCollapsed() && this._editorRef.isCaretAtStart()) {
const editEvent = findEditableEvent(this.props.room, false);
@ -173,7 +173,7 @@ export default class SendMessageComposer extends React.Component {
}
}
break;
case KeyAction.CancelEditing:
case MessageComposerAction.CancelEditing:
dis.dispatch({
action: 'reply_to_event',
event: null,