/* Copyright 2015, 2016 OpenMarket Ltd Copyright 2017, 2018 Vector Creations 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. 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 * as React from "react"; import { createRef } from "react"; import { Room } from "matrix-js-sdk/src/models/room"; import classNames from 'classnames'; import {RovingAccessibleButton, RovingTabIndexWrapper} from "../../../accessibility/RovingTabIndex"; import { _t } from "../../../languageHandler"; import AccessibleButton from "../../views/elements/AccessibleButton"; import RoomTile2 from "./RoomTile2"; import { ListLayout } from "../../../stores/room-list/ListLayout"; import { ChevronFace, ContextMenu, ContextMenuButton, StyledMenuItemCheckbox, StyledMenuItemRadio, } from "../../structures/ContextMenu"; import RoomListStore from "../../../stores/room-list/RoomListStore2"; import { ListAlgorithm, SortAlgorithm } from "../../../stores/room-list/algorithms/models"; import { DefaultTagID, TagID } from "../../../stores/room-list/models"; import dis from "../../../dispatcher/dispatcher"; import NotificationBadge from "./NotificationBadge"; import { ListNotificationState } from "../../../stores/notifications/ListNotificationState"; import AccessibleTooltipButton from "../elements/AccessibleTooltipButton"; import { Key } from "../../../Keyboard"; import defaultDispatcher from "../../../dispatcher/dispatcher"; import {ActionPayload} from "../../../dispatcher/payloads"; import { Enable, Resizable } from "re-resizable"; import { Direction } from "re-resizable/lib/resizer"; import { polyfillTouchEvent } from "../../../@types/polyfill"; import { RoomNotificationStateStore } from "../../../stores/notifications/RoomNotificationStateStore"; import RoomListLayoutStore from "../../../stores/room-list/RoomListLayoutStore"; // 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. * *******************************************************************/ const SHOW_N_BUTTON_HEIGHT = 28; // As defined by CSS const RESIZE_HANDLE_HEIGHT = 4; // As defined by CSS export const HEADER_HEIGHT = 32; // As defined by CSS const MAX_PADDING_HEIGHT = SHOW_N_BUTTON_HEIGHT + RESIZE_HANDLE_HEIGHT; // HACK: We really shouldn't have to do this. polyfillTouchEvent(); interface IProps { forRooms: boolean; rooms?: Room[]; startAsHidden: boolean; label: string; onAddRoom?: () => void; addRoomLabel: string; isMinimized: boolean; tagId: TagID; onResize: () => void; // TODO: Don't use this. It's for community invites, and community invites shouldn't be here. // You should feel bad if you use this. extraBadTilesThatShouldntExist?: React.ReactElement[]; // TODO: Account for https://github.com/vector-im/riot-web/issues/14179 } // TODO: Use re-resizer's NumberSize when it is exposed as the type interface ResizeDelta { width: number, height: number, } type PartialDOMRect = Pick; interface IState { notificationState: ListNotificationState; contextMenuPosition: PartialDOMRect; isResizing: boolean; } export default class RoomSublist2 extends React.Component { private headerButton = createRef(); private sublistRef = createRef(); private dispatcherRef: string; private layout: ListLayout; constructor(props: IProps) { super(props); this.layout = RoomListLayoutStore.instance.getLayoutFor(this.props.tagId); this.heightAtStart = 0; const height = this.calculateInitialHeight(); this.state = { notificationState: RoomNotificationStateStore.instance.getListState(this.props.tagId), contextMenuPosition: null, isResizing: false, height, }; this.state.notificationState.setRooms(this.props.rooms); this.dispatcherRef = defaultDispatcher.register(this.onAction); } private calculateInitialHeight() { const requestedVisibleTiles = Math.max(Math.floor(this.layout.visibleTiles), this.layout.minVisibleTiles); const tileCount = Math.min(this.numTiles, requestedVisibleTiles); const height = this.layout.tilesToPixelsWithPadding(tileCount, this.padding); return height; } private get padding() { let padding = RESIZE_HANDLE_HEIGHT; // this is used for calculating the max height of the whole container, // and takes into account whether there should be room reserved for the show less button // when fully expanded. Note that the show more button might still be shown when not fully expanded, // but in this case it will take the space of a tile and we don't need to reserve space for it. if (this.numTiles > this.layout.defaultVisibleTiles) { padding += SHOW_N_BUTTON_HEIGHT; } return padding; } private get numTiles(): number { return RoomSublist2.calcNumTiles(this.props); } private static calcNumTiles(props) { return (props.rooms || []).length + (props.extraBadTilesThatShouldntExist || []).length; } private get numVisibleTiles(): number { const nVisible = Math.ceil(this.layout.visibleTiles); return Math.min(nVisible, this.numTiles); } public componentDidUpdate(prevProps) { this.state.notificationState.setRooms(this.props.rooms); // as the rooms can come in one by one we need to reevaluate // the amount of available rooms to cap the amount of requested visible rooms by the layout if (RoomSublist2.calcNumTiles(prevProps) !== this.numTiles) { this.setState({height: this.calculateInitialHeight()}); } } public componentWillUnmount() { this.state.notificationState.destroy(); defaultDispatcher.unregister(this.dispatcherRef); } private onAction = (payload: ActionPayload) => { if (payload.action === "view_room" && payload.show_room_tile && this.props.rooms) { // XXX: we have to do this a tick later because we have incorrect intermediate props during a room change // where we lose the room we are changing from temporarily and then it comes back in an update right after. setImmediate(() => { const isCollapsed = this.layout.isCollapsed; const roomIndex = this.props.rooms.findIndex((r) => r.roomId === payload.room_id); if (isCollapsed && roomIndex > -1) { this.toggleCollapsed(); } // extend the visible section to include the room if it is entirely invisible if (roomIndex >= this.numVisibleTiles) { this.layout.visibleTiles = this.layout.tilesWithPadding(roomIndex + 1, MAX_PADDING_HEIGHT); this.forceUpdate(); // because the layout doesn't trigger a re-render } }); } }; private onAddRoom = (e) => { e.stopPropagation(); if (this.props.onAddRoom) this.props.onAddRoom(); }; private applyHeightChange(newHeight: number) { const heightInTiles = Math.ceil(this.layout.pixelsToTiles(newHeight - this.padding)); this.layout.visibleTiles = Math.min(this.numTiles, heightInTiles); } private onResize = ( e: MouseEvent | TouchEvent, travelDirection: Direction, refToElement: HTMLDivElement, delta: ResizeDelta, ) => { const newHeight = this.heightAtStart + delta.height; this.applyHeightChange(newHeight); this.setState({height: newHeight}); }; private onResizeStart = () => { this.heightAtStart = this.state.height; this.setState({isResizing: true}); }; private onResizeStop = (e, direction, ref, d) => { const newHeight = this.heightAtStart + d.height; this.applyHeightChange(newHeight); this.setState({isResizing: false, height: newHeight}); }; private onShowAllClick = () => { const newHeight = this.layout.tilesToPixelsWithPadding(this.numTiles, this.padding); this.applyHeightChange(newHeight); this.setState({height: newHeight}, () => { this.focusRoomTile(this.numTiles - 1); }); }; private onShowLessClick = () => { const newHeight = this.layout.tilesToPixelsWithPadding(this.layout.defaultVisibleTiles, this.padding); this.applyHeightChange(newHeight); this.setState({height: newHeight}); }; private focusRoomTile = (index: number) => { if (!this.sublistRef.current) return; const elements = this.sublistRef.current.querySelectorAll(".mx_RoomTile2"); const element = elements && elements[index]; if (element) { element.focus(); } }; private onOpenMenuClick = (ev: React.MouseEvent) => { ev.preventDefault(); ev.stopPropagation(); const target = ev.target as HTMLButtonElement; this.setState({contextMenuPosition: target.getBoundingClientRect()}); }; private onContextMenu = (ev: React.MouseEvent) => { ev.preventDefault(); ev.stopPropagation(); this.setState({ contextMenuPosition: { left: ev.clientX, top: ev.clientY, height: 0, }, }); }; private onCloseMenu = () => { this.setState({contextMenuPosition: null}); }; private onUnreadFirstChanged = async () => { const isUnreadFirst = RoomListStore.instance.getListOrder(this.props.tagId) === ListAlgorithm.Importance; const newAlgorithm = isUnreadFirst ? ListAlgorithm.Natural : ListAlgorithm.Importance; await RoomListStore.instance.setListOrder(this.props.tagId, newAlgorithm); }; private onTagSortChanged = async (sort: SortAlgorithm) => { await RoomListStore.instance.setTagSorting(this.props.tagId, sort); }; private onMessagePreviewChanged = () => { this.layout.showPreviews = !this.layout.showPreviews; this.forceUpdate(); // because the layout doesn't trigger a re-render }; private onBadgeClick = (ev: React.MouseEvent) => { ev.preventDefault(); ev.stopPropagation(); let room; if (this.props.tagId === DefaultTagID.Invite) { // switch to first room as that'll be the top of the list for the user room = this.props.rooms && this.props.rooms[0]; } else { // find the first room with a count of the same colour as the badge count room = this.props.rooms.find((r: Room) => { const notifState = this.state.notificationState.getForRoom(r); return notifState.count > 0 && notifState.color === this.state.notificationState.color; }); } if (room) { dis.dispatch({ action: 'view_room', room_id: room.roomId, show_room_tile: true, // to make sure the room gets scrolled into view }); } }; private onHeaderClick = (ev: React.MouseEvent) => { let target = ev.target as HTMLDivElement; if (!target.classList.contains('mx_RoomSublist2_headerText')) { // If we don't have the headerText class, the user clicked the span in the headerText. target = target.parentElement as HTMLDivElement; } const possibleSticky = target.parentElement; const sublist = possibleSticky.parentElement.parentElement; const list = sublist.parentElement.parentElement; // the scrollTop is capped at the height of the header in LeftPanel2 const isAtTop = list.scrollTop <= HEADER_HEIGHT; const isSticky = possibleSticky.classList.contains('mx_RoomSublist2_headerContainer_sticky'); if (isSticky && !isAtTop) { // is sticky - jump to list sublist.scrollIntoView({behavior: 'smooth'}); } else { // on screen - toggle collapse this.toggleCollapsed(); } }; private toggleCollapsed = () => { this.layout.isCollapsed = !this.layout.isCollapsed; this.forceUpdate(); // because the layout doesn't trigger an update setImmediate(() => this.props.onResize()); // needs to happen when the DOM is updated }; private onHeaderKeyDown = (ev: React.KeyboardEvent) => { const isCollapsed = this.layout && this.layout.isCollapsed; switch (ev.key) { case Key.ARROW_LEFT: ev.stopPropagation(); if (!isCollapsed) { // On ARROW_LEFT collapse the room sublist if it isn't already this.toggleCollapsed(); } break; case Key.ARROW_RIGHT: { ev.stopPropagation(); if (isCollapsed) { // On ARROW_RIGHT expand the room sublist if it isn't already this.toggleCollapsed(); } else if (this.sublistRef.current) { // otherwise focus the first room const element = this.sublistRef.current.querySelector(".mx_RoomTile2") as HTMLDivElement; if (element) { element.focus(); } } break; } } }; private onKeyDown = (ev: React.KeyboardEvent) => { switch (ev.key) { // On ARROW_LEFT go to the sublist header case Key.ARROW_LEFT: ev.stopPropagation(); this.headerButton.current.focus(); break; // Consume ARROW_RIGHT so it doesn't cause focus to get sent to composer case Key.ARROW_RIGHT: ev.stopPropagation(); } }; private renderVisibleTiles(): React.ReactElement[] { if (this.layout && this.layout.isCollapsed) { // don't waste time on rendering return []; } const tiles: React.ReactElement[] = []; if (this.props.rooms) { const visibleRooms = this.props.rooms.slice(0, this.numVisibleTiles); for (const room of visibleRooms) { tiles.push( ); } } if (this.props.extraBadTilesThatShouldntExist) { tiles.push(...this.props.extraBadTilesThatShouldntExist); } // We only have to do this because of the extra tiles. We do it conditionally // to avoid spending cycles on slicing. It's generally fine to do this though // as users are unlikely to have more than a handful of tiles when the extra // tiles are used. if (tiles.length > this.numVisibleTiles) { return tiles.slice(0, this.numVisibleTiles); } return tiles; } private renderMenu(): React.ReactElement { let contextMenu = null; if (this.state.contextMenuPosition) { const isAlphabetical = RoomListStore.instance.getTagSorting(this.props.tagId) === SortAlgorithm.Alphabetic; const isUnreadFirst = RoomListStore.instance.getListOrder(this.props.tagId) === ListAlgorithm.Importance; // Invites don't get some nonsense options, so only add them if we have to. let otherSections = null; if (this.props.tagId !== DefaultTagID.Invite) { otherSections = (
{_t("Unread rooms")}
{_t("Always show first")}

{_t("Show")}
{_t("Message preview")}
); } contextMenu = (
{_t("Sort by")}
this.onTagSortChanged(SortAlgorithm.Recent)} checked={!isAlphabetical} name={`mx_${this.props.tagId}_sortBy`} > {_t("Activity")} this.onTagSortChanged(SortAlgorithm.Alphabetic)} checked={isAlphabetical} name={`mx_${this.props.tagId}_sortBy`} > {_t("A-Z")}
{otherSections}
); } return ( {contextMenu} ); } private renderHeader(): React.ReactElement { return ( {({onFocus, isActive, ref}) => { const tabIndex = isActive ? 0 : -1; let ariaLabel = _t("Jump to first unread room."); if (this.props.tagId === DefaultTagID.Invite) { ariaLabel = _t("Jump to first invite."); } const badge = ( ); let addRoomButton = null; if (!!this.props.onAddRoom) { addRoomButton = ( ); } const collapseClasses = classNames({ 'mx_RoomSublist2_collapseBtn': true, 'mx_RoomSublist2_collapseBtn_collapsed': this.layout && this.layout.isCollapsed, }); const classes = classNames({ 'mx_RoomSublist2_headerContainer': true, 'mx_RoomSublist2_headerContainer_withAux': !!addRoomButton, }); const badgeContainer = (
{badge}
); // Note: the addRoomButton conditionally gets moved around // the DOM depending on whether or not the list is minimized. // If we're minimized, we want it below the header so it // doesn't become sticky. // The same applies to the notification badge. return (
{this.props.label} {this.renderMenu()} {this.props.isMinimized ? null : badgeContainer} {this.props.isMinimized ? null : addRoomButton}
{this.props.isMinimized ? badgeContainer : null} {this.props.isMinimized ? addRoomButton : null}
); }}
); } public render(): React.ReactElement { // TODO: Error boundary: https://github.com/vector-im/riot-web/issues/14185 const visibleTiles = this.renderVisibleTiles(); const classes = classNames({ 'mx_RoomSublist2': true, 'mx_RoomSublist2_hasMenuOpen': !!this.state.contextMenuPosition, 'mx_RoomSublist2_minimized': this.props.isMinimized, }); let content = null; if (visibleTiles.length > 0) { const layout = this.layout; // to shorten calls const minTiles = Math.min(layout.minVisibleTiles, this.numTiles); const showMoreAtMinHeight = minTiles < this.numTiles; const minHeightPadding = RESIZE_HANDLE_HEIGHT + (showMoreAtMinHeight ? SHOW_N_BUTTON_HEIGHT : 0); const minTilesPx = layout.tilesToPixelsWithPadding(minTiles, minHeightPadding); const maxTilesPx = layout.tilesToPixelsWithPadding(this.numTiles, this.padding); const showMoreBtnClasses = classNames({ 'mx_RoomSublist2_showNButton': true, }); // If we're hiding rooms, show a 'show more' button to the user. This button // floats above the resize handle, if we have one present. If the user has all // tiles visible, it becomes 'show less'. let showNButton = null; if (maxTilesPx > this.state.height) { const nonPaddedHeight = this.state.height - RESIZE_HANDLE_HEIGHT - SHOW_N_BUTTON_HEIGHT; const amountFullyShown = Math.floor(nonPaddedHeight / this.layout.tileHeight); const numMissing = this.numTiles - amountFullyShown; let showMoreText = ( {_t("Show %(count)s more", {count: numMissing})} ); if (this.props.isMinimized) showMoreText = null; showNButton = ( {/* set by CSS masking */} {showMoreText} ); } else if (this.numTiles > this.layout.defaultVisibleTiles) { // we have all tiles visible - add a button to show less let showLessText = ( {_t("Show less")} ); if (this.props.isMinimized) showLessText = null; showNButton = ( {/* set by CSS masking */} {showLessText} ); } // Figure out if we need a handle const handles: Enable = { bottom: true, // the only one we need, but the others must be explicitly false bottomLeft: false, bottomRight: false, left: false, right: false, top: false, topLeft: false, topRight: false, }; if (layout.visibleTiles >= this.numTiles && this.numTiles <= layout.minVisibleTiles) { // we're at a minimum, don't have a bottom handle handles.bottom = false; } // We have to account for padding so we can accommodate a 'show more' button and // the resize handle, which are pinned to the bottom of the container. This is the // easiest way to have a resize handle below the button as otherwise we're writing // our own resize handling and that doesn't sound fun. // // The layout class has some helpers for dealing with padding, as we don't want to // apply it in all cases. If we apply it in all cases, the resizing feels like it // goes backwards and can become wildly incorrect (visibleTiles says 18 when there's // only mathematically 7 possible). const handleWrapperClasses = classNames({ 'mx_RoomSublist2_resizerHandles': true, 'mx_RoomSublist2_resizerHandles_showNButton': !!showNButton, }); content = (
{visibleTiles}
{showNButton}
); } return (
{this.renderHeader()} {content}
); } }