mirror of
https://github.com/element-hq/element-web.git
synced 2024-12-16 04:21:32 +03:00
b5014282a4
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
427 lines
17 KiB
TypeScript
427 lines
17 KiB
TypeScript
/*
|
|
Copyright 2015, 2016 OpenMarket Ltd
|
|
Copyright 2017 New Vector Ltd
|
|
Copyright 2018 Michael Telatynski <7t3chguy@gmail.com>
|
|
Copyright 2019, 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.
|
|
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, { createRef } from "react";
|
|
import { Room } from "matrix-js-sdk/src/models/room";
|
|
import classNames from "classnames";
|
|
import { RovingTabIndexWrapper } from "../../../accessibility/RovingTabIndex";
|
|
import AccessibleButton, { ButtonEvent } from "../../views/elements/AccessibleButton";
|
|
import RoomAvatar from "../../views/avatars/RoomAvatar";
|
|
import dis from '../../../dispatcher/dispatcher';
|
|
import { Key } from "../../../Keyboard";
|
|
import ActiveRoomObserver from "../../../ActiveRoomObserver";
|
|
import NotificationBadge, {
|
|
INotificationState,
|
|
NotificationColor,
|
|
TagSpecificNotificationState
|
|
} from "./NotificationBadge";
|
|
import { _t } from "../../../languageHandler";
|
|
import { ContextMenu, ContextMenuButton, MenuItemRadio } from "../../structures/ContextMenu";
|
|
import { DefaultTagID, TagID } from "../../../stores/room-list/models";
|
|
import { MessagePreviewStore } from "../../../stores/room-list/MessagePreviewStore";
|
|
import RoomTileIcon from "./RoomTileIcon";
|
|
import { getRoomNotifsState, ALL_MESSAGES, ALL_MESSAGES_LOUD, MENTIONS_ONLY, MUTE } from "../../../RoomNotifs";
|
|
import { MatrixClientPeg } from "../../../MatrixClientPeg";
|
|
import { setRoomNotifsState } from "../../../RoomNotifs";
|
|
|
|
// TODO: Remove banner on launch: https://github.com/vector-im/riot-web/issues/14231
|
|
// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
|
|
|
|
/*******************************************************************
|
|
* CAUTION *
|
|
*******************************************************************
|
|
* This is a work in progress implementation and isn't complete or *
|
|
* even useful as a component. Please avoid using it until this *
|
|
* warning disappears. *
|
|
*******************************************************************/
|
|
|
|
interface IProps {
|
|
room: Room;
|
|
showMessagePreview: boolean;
|
|
isMinimized: boolean;
|
|
tag: TagID;
|
|
|
|
// TODO: Incoming call boxes: https://github.com/vector-im/riot-web/issues/14177
|
|
}
|
|
|
|
interface IState {
|
|
hover: boolean;
|
|
notificationState: INotificationState;
|
|
selected: boolean;
|
|
notificationsMenuDisplayed: boolean;
|
|
generalMenuDisplayed: boolean;
|
|
}
|
|
|
|
const contextMenuBelow = (elementRect) => {
|
|
const left = elementRect.left + window.pageXOffset - 6;
|
|
let top = elementRect.bottom + window.pageYOffset + 17;
|
|
const chevronFace = "none";
|
|
return {left, top, chevronFace};
|
|
};
|
|
|
|
interface INotifOptionProps {
|
|
active: boolean;
|
|
iconClassName: string;
|
|
label: string;
|
|
onClick(ev: ButtonEvent);
|
|
}
|
|
|
|
const NotifOption: React.FC<INotifOptionProps> = ({active, onClick, iconClassName, label}) => {
|
|
const classes = classNames({
|
|
mx_RoomTile2_contextMenu_activeRow: active,
|
|
});
|
|
|
|
let activeIcon;
|
|
if (active) {
|
|
activeIcon = <span className="mx_IconizedContextMenu_icon mx_RoomTile2_iconCheck" />;
|
|
}
|
|
|
|
return (
|
|
<MenuItemRadio className={classes} onClick={onClick} active={active} label={label}>
|
|
<span className={classNames("mx_IconizedContextMenu_icon", iconClassName)} />
|
|
<span className="mx_IconizedContextMenu_label">{ label }</span>
|
|
{ activeIcon }
|
|
</MenuItemRadio>
|
|
);
|
|
};
|
|
|
|
export default class RoomTile2 extends React.Component<IProps, IState> {
|
|
private notificationsMenuButtonRef: React.RefObject<HTMLButtonElement> = createRef();
|
|
private generalMenuButtonRef: React.RefObject<HTMLButtonElement> = createRef();
|
|
|
|
// TODO: a11y: https://github.com/vector-im/riot-web/issues/14180
|
|
|
|
constructor(props: IProps) {
|
|
super(props);
|
|
|
|
this.state = {
|
|
hover: false,
|
|
notificationState: new TagSpecificNotificationState(this.props.room, this.props.tag),
|
|
selected: ActiveRoomObserver.activeRoomId === this.props.room.roomId,
|
|
notificationsMenuDisplayed: false,
|
|
generalMenuDisplayed: false,
|
|
};
|
|
|
|
ActiveRoomObserver.addListener(this.props.room.roomId, this.onActiveRoomUpdate);
|
|
}
|
|
|
|
public componentWillUnmount() {
|
|
if (this.props.room) {
|
|
ActiveRoomObserver.removeListener(this.props.room.roomId, this.onActiveRoomUpdate);
|
|
}
|
|
}
|
|
|
|
private onTileMouseEnter = () => {
|
|
this.setState({hover: true});
|
|
};
|
|
|
|
private onTileMouseLeave = () => {
|
|
this.setState({hover: false});
|
|
};
|
|
|
|
private onTileClick = (ev: React.KeyboardEvent) => {
|
|
dis.dispatch({
|
|
action: 'view_room',
|
|
// TODO: Support show_room_tile in new room list: https://github.com/vector-im/riot-web/issues/14233
|
|
show_room_tile: true, // make sure the room is visible in the list
|
|
room_id: this.props.room.roomId,
|
|
clear_search: (ev && (ev.key === Key.ENTER || ev.key === Key.SPACE)),
|
|
});
|
|
};
|
|
|
|
private onActiveRoomUpdate = (isActive: boolean) => {
|
|
this.setState({selected: isActive});
|
|
};
|
|
|
|
private onNotificationsMenuOpenClick = (ev: InputEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
this.setState({notificationsMenuDisplayed: true});
|
|
};
|
|
|
|
private onCloseNotificationsMenu = (ev: InputEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
this.setState({notificationsMenuDisplayed: false});
|
|
};
|
|
|
|
private onGeneralMenuOpenClick = (ev: InputEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
this.setState({generalMenuDisplayed: true});
|
|
};
|
|
|
|
private onCloseGeneralMenu = (ev: InputEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
this.setState({generalMenuDisplayed: false});
|
|
};
|
|
|
|
private onTagRoom = (ev: ButtonEvent, tagId: TagID) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
|
|
// TODO: Support tagging: https://github.com/vector-im/riot-web/issues/14211
|
|
// TODO: XOR favourites and low priority: https://github.com/vector-im/riot-web/issues/14210
|
|
};
|
|
|
|
private onLeaveRoomClick = (ev: ButtonEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
|
|
dis.dispatch({
|
|
action: 'leave_room',
|
|
room_id: this.props.room.roomId,
|
|
});
|
|
this.setState({generalMenuDisplayed: false}); // hide the menu
|
|
};
|
|
|
|
private onOpenRoomSettings = (ev: ButtonEvent) => {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
|
|
dis.dispatch({
|
|
action: 'open_room_settings',
|
|
room_id: this.props.room.roomId,
|
|
});
|
|
this.setState({generalMenuDisplayed: false}); // hide the menu
|
|
};
|
|
|
|
private async saveNotifState(ev: ButtonEvent, newState: ALL_MESSAGES_LOUD | ALL_MESSAGES | MENTIONS_ONLY | MUTE) {
|
|
ev.preventDefault();
|
|
ev.stopPropagation();
|
|
if (MatrixClientPeg.get().isGuest()) return;
|
|
|
|
try {
|
|
// TODO add local echo - https://github.com/vector-im/riot-web/issues/14280
|
|
await setRoomNotifsState(this.props.room.roomId, newState);
|
|
} catch (error) {
|
|
// TODO: some form of error notification to the user to inform them that their state change failed.
|
|
// https://github.com/vector-im/riot-web/issues/14281
|
|
console.error(error);
|
|
}
|
|
|
|
// Close the context menu
|
|
this.setState({
|
|
notificationsMenuDisplayed: false,
|
|
});
|
|
}
|
|
|
|
private onClickAllNotifs = ev => this.saveNotifState(ev, ALL_MESSAGES);
|
|
private onClickAlertMe = ev => this.saveNotifState(ev, ALL_MESSAGES_LOUD);
|
|
private onClickMentions = ev => this.saveNotifState(ev, MENTIONS_ONLY);
|
|
private onClickMute = ev => this.saveNotifState(ev, MUTE);
|
|
|
|
private renderNotificationsMenu(): React.ReactElement {
|
|
if (this.props.isMinimized || MatrixClientPeg.get().isGuest()) return null; // no menu when minimized or guest
|
|
|
|
const state = getRoomNotifsState(this.props.room.roomId);
|
|
|
|
let contextMenu = null;
|
|
if (this.state.notificationsMenuDisplayed) {
|
|
const elementRect = this.notificationsMenuButtonRef.current.getBoundingClientRect();
|
|
contextMenu = (
|
|
<ContextMenu {...contextMenuBelow(elementRect)} onFinished={this.onCloseNotificationsMenu}>
|
|
<div className="mx_IconizedContextMenu mx_IconizedContextMenu_compact mx_RoomTile2_contextMenu">
|
|
<div className="mx_IconizedContextMenu_optionList">
|
|
<NotifOption
|
|
label={_t("Use default")}
|
|
active={state === ALL_MESSAGES}
|
|
iconClassName="mx_RoomTile2_iconBell"
|
|
onClick={this.onClickAllNotifs}
|
|
/>
|
|
<NotifOption
|
|
label={_t("All messages")}
|
|
active={state === ALL_MESSAGES_LOUD}
|
|
iconClassName="mx_RoomTile2_iconBellDot"
|
|
onClick={this.onClickAlertMe}
|
|
/>
|
|
<NotifOption
|
|
label={_t("Mentions & Keywords")}
|
|
active={state === MENTIONS_ONLY}
|
|
iconClassName="mx_RoomTile2_iconBellMentions"
|
|
onClick={this.onClickMentions}
|
|
/>
|
|
<NotifOption
|
|
label={_t("None")}
|
|
active={state === MUTE}
|
|
iconClassName="mx_RoomTile2_iconBellCrossed"
|
|
onClick={this.onClickMute}
|
|
/>
|
|
</div>
|
|
</div>
|
|
</ContextMenu>
|
|
);
|
|
}
|
|
|
|
const classes = classNames("mx_RoomTile2_notificationsButton", {
|
|
// Show bell icon for the default case too.
|
|
mx_RoomTile2_iconBell: state === ALL_MESSAGES_LOUD || state === ALL_MESSAGES,
|
|
mx_RoomTile2_iconBellDot: state === MENTIONS_ONLY,
|
|
mx_RoomTile2_iconBellCrossed: state === MUTE,
|
|
// XXX: RoomNotifs assumes ALL_MESSAGES is default, this is wrong,
|
|
// but cannot be fixed until FTUE Notifications lands.
|
|
mx_RoomTile2_notificationsButton_show: state !== ALL_MESSAGES,
|
|
});
|
|
|
|
return (
|
|
<React.Fragment>
|
|
<ContextMenuButton
|
|
className={classes}
|
|
onClick={this.onNotificationsMenuOpenClick}
|
|
inputRef={this.notificationsMenuButtonRef}
|
|
label={_t("Notification options")}
|
|
isExpanded={this.state.notificationsMenuDisplayed}
|
|
/>
|
|
{contextMenu}
|
|
</React.Fragment>
|
|
);
|
|
}
|
|
|
|
private renderGeneralMenu(): React.ReactElement {
|
|
if (this.props.isMinimized) return null; // no menu when minimized
|
|
|
|
let contextMenu = null;
|
|
if (this.state.generalMenuDisplayed) {
|
|
const elementRect = this.generalMenuButtonRef.current.getBoundingClientRect();
|
|
contextMenu = (
|
|
<ContextMenu {...contextMenuBelow(elementRect)} onFinished={this.onCloseGeneralMenu}>
|
|
<div className="mx_IconizedContextMenu mx_IconizedContextMenu_compact mx_RoomTile2_contextMenu">
|
|
<div className="mx_IconizedContextMenu_optionList">
|
|
<AccessibleButton onClick={(e) => this.onTagRoom(e, DefaultTagID.Favourite)}>
|
|
<span className="mx_IconizedContextMenu_icon mx_RoomTile2_iconStar" />
|
|
<span className="mx_IconizedContextMenu_label">{_t("Favourite")}</span>
|
|
</AccessibleButton>
|
|
<AccessibleButton onClick={this.onOpenRoomSettings}>
|
|
<span className="mx_IconizedContextMenu_icon mx_RoomTile2_iconSettings" />
|
|
<span className="mx_IconizedContextMenu_label">{_t("Settings")}</span>
|
|
</AccessibleButton>
|
|
</div>
|
|
<div className="mx_IconizedContextMenu_optionList mx_RoomTile2_contextMenu_redRow">
|
|
<AccessibleButton onClick={this.onLeaveRoomClick}>
|
|
<span className="mx_IconizedContextMenu_icon mx_RoomTile2_iconSignOut" />
|
|
<span className="mx_IconizedContextMenu_label">{_t("Leave Room")}</span>
|
|
</AccessibleButton>
|
|
</div>
|
|
</div>
|
|
</ContextMenu>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<React.Fragment>
|
|
<ContextMenuButton
|
|
className="mx_RoomTile2_menuButton"
|
|
onClick={this.onGeneralMenuOpenClick}
|
|
inputRef={this.generalMenuButtonRef}
|
|
label={_t("Room options")}
|
|
isExpanded={this.state.generalMenuDisplayed}
|
|
/>
|
|
{contextMenu}
|
|
</React.Fragment>
|
|
);
|
|
}
|
|
|
|
public render(): React.ReactElement {
|
|
// TODO: Invites: https://github.com/vector-im/riot-web/issues/14198
|
|
// TODO: a11y proper: https://github.com/vector-im/riot-web/issues/14180
|
|
|
|
const classes = classNames({
|
|
'mx_RoomTile2': true,
|
|
'mx_RoomTile2_selected': this.state.selected,
|
|
'mx_RoomTile2_hasMenuOpen': this.state.generalMenuDisplayed || this.state.notificationsMenuDisplayed,
|
|
'mx_RoomTile2_minimized': this.props.isMinimized,
|
|
});
|
|
|
|
const badge = (
|
|
<NotificationBadge
|
|
notification={this.state.notificationState}
|
|
forceCount={false}
|
|
roomId={this.props.room.roomId}
|
|
/>
|
|
);
|
|
|
|
// TODO: the original RoomTile uses state for the room name. Do we need to?
|
|
let name = this.props.room.name;
|
|
if (typeof name !== 'string') name = '';
|
|
name = name.replace(":", ":\u200b"); // add a zero-width space to allow linewrapping after the colon
|
|
|
|
let messagePreview = null;
|
|
if (this.props.showMessagePreview && !this.props.isMinimized) {
|
|
// The preview store heavily caches this info, so should be safe to hammer.
|
|
const text = MessagePreviewStore.instance.getPreviewForRoom(this.props.room, this.props.tag);
|
|
|
|
// Only show the preview if there is one to show.
|
|
if (text) {
|
|
messagePreview = (
|
|
<div className="mx_RoomTile2_messagePreview">
|
|
{text}
|
|
</div>
|
|
);
|
|
}
|
|
}
|
|
|
|
const nameClasses = classNames({
|
|
"mx_RoomTile2_name": true,
|
|
"mx_RoomTile2_nameWithPreview": !!messagePreview,
|
|
"mx_RoomTile2_nameHasUnreadEvents": this.state.notificationState.color >= NotificationColor.Bold,
|
|
});
|
|
|
|
let nameContainer = (
|
|
<div className="mx_RoomTile2_nameContainer">
|
|
<div title={name} className={nameClasses} tabIndex={-1} dir="auto">
|
|
{name}
|
|
</div>
|
|
{messagePreview}
|
|
</div>
|
|
);
|
|
if (this.props.isMinimized) nameContainer = null;
|
|
|
|
const avatarSize = 32;
|
|
return (
|
|
<React.Fragment>
|
|
<RovingTabIndexWrapper>
|
|
{({onFocus, isActive, ref}) =>
|
|
<AccessibleButton
|
|
onFocus={onFocus}
|
|
tabIndex={isActive ? 0 : -1}
|
|
inputRef={ref}
|
|
className={classes}
|
|
onMouseEnter={this.onTileMouseEnter}
|
|
onMouseLeave={this.onTileMouseLeave}
|
|
onClick={this.onTileClick}
|
|
role="treeitem"
|
|
>
|
|
<div className="mx_RoomTile2_avatarContainer">
|
|
<RoomAvatar room={this.props.room} width={avatarSize} height={avatarSize} />
|
|
<RoomTileIcon room={this.props.room} tag={this.props.tag} />
|
|
</div>
|
|
{nameContainer}
|
|
<div className="mx_RoomTile2_badgeContainer">
|
|
{badge}
|
|
</div>
|
|
{this.renderNotificationsMenu()}
|
|
{this.renderGeneralMenu()}
|
|
</AccessibleButton>
|
|
}
|
|
</RovingTabIndexWrapper>
|
|
</React.Fragment>
|
|
);
|
|
}
|
|
}
|