TabbedView.tsx

/*
Copyright 2017 Travis Ralston
Copyright 2019 New Vector Ltd
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 * as React from "react";
import classNames from "classnames";
import { logger } from "matrix-js-sdk/src/logger";

import { _t } from "../../languageHandler";
import AutoHideScrollbar from "./AutoHideScrollbar";
import { PosthogScreenTracker, ScreenName } from "../../PosthogTrackers";
import { NonEmptyArray } from "../../@types/common";
import { RovingAccessibleButton, RovingTabIndexProvider } from "../../accessibility/RovingTabIndex";

/**
 * Represents a tab for the TabbedView.
 */
export class Tab {
    /**
     * Creates a new tab.
     * @param {string} id The tab's ID.
     * @param {string} label The untranslated tab label.
     * @param {string} icon The class for the tab icon. This should be a simple mask.
     * @param {React.ReactNode} body The JSX for the tab container.
     * @param {string} screenName The screen name to report to Posthog.
     */
    public constructor(
        public readonly id: string,
        public readonly label: string,
        public readonly icon: string | null,
        public readonly body: React.ReactNode,
        public readonly screenName?: ScreenName,
    ) {}
}

export enum TabLocation {
    LEFT = "left",
    TOP = "top",
}

interface IProps {
    tabs: NonEmptyArray<Tab>;
    initialTabId?: string;
    tabLocation: TabLocation;
    onChange?: (tabId: string) => void;
    screenName?: ScreenName;
}

interface IState {
    activeTabId: string;
}

export default class TabbedView extends React.Component<IProps, IState> {
    public constructor(props: IProps) {
        super(props);

        const initialTabIdIsValid = props.tabs.find((tab) => tab.id === props.initialTabId);
        this.state = {
            activeTabId: initialTabIdIsValid ? props.initialTabId! : props.tabs[0].id,
        };
    }

    public static defaultProps = {
        tabLocation: TabLocation.LEFT,
    };

    private getTabById(id: string): Tab | undefined {
        return this.props.tabs.find((tab) => tab.id === id);
    }

    /**
     * Shows the given tab
     * @param {Tab} tab the tab to show
     * @private
     */
    private setActiveTab(tab: Tab): void {
        // make sure this tab is still in available tabs
        if (!!this.getTabById(tab.id)) {
            if (this.props.onChange) this.props.onChange(tab.id);
            this.setState({ activeTabId: tab.id });
        } else {
            logger.error("Could not find tab " + tab.label + " in tabs");
        }
    }

    private renderTabLabel(tab: Tab): JSX.Element {
        const isActive = this.state.activeTabId === tab.id;
        const classes = classNames("mx_TabbedView_tabLabel", {
            mx_TabbedView_tabLabel_active: isActive,
        });

        let tabIcon: JSX.Element | undefined;
        if (tab.icon) {
            tabIcon = <span className={`mx_TabbedView_maskedIcon ${tab.icon}`} />;
        }

        const onClickHandler = (): void => this.setActiveTab(tab);
        const id = this.getTabId(tab);

        const label = _t(tab.label);
        return (
            <RovingAccessibleButton
                className={classes}
                key={"tab_label_" + tab.label}
                onClick={onClickHandler}
                data-testid={`settings-tab-${tab.id}`}
                role="tab"
                aria-selected={isActive}
                aria-controls={id}
            >
                {tabIcon}
                <span className="mx_TabbedView_tabLabel_text" id={`${id}_label`}>
                    {label}
                </span>
            </RovingAccessibleButton>
        );
    }

    private getTabId(tab: Tab): string {
        return `mx_tabpanel_${tab.id}`;
    }

    private renderTabPanel(tab: Tab): React.ReactNode {
        const id = this.getTabId(tab);
        return (
            <div className="mx_TabbedView_tabPanel" key={id} id={id} aria-labelledby={`${id}_label`}>
                <AutoHideScrollbar className="mx_TabbedView_tabPanelContent">{tab.body}</AutoHideScrollbar>
            </div>
        );
    }

    public render(): React.ReactNode {
        const labels = this.props.tabs.map((tab) => this.renderTabLabel(tab));
        const tab = this.getTabById(this.state.activeTabId);
        const panel = tab ? this.renderTabPanel(tab) : null;

        const tabbedViewClasses = classNames({
            mx_TabbedView: true,
            mx_TabbedView_tabsOnLeft: this.props.tabLocation == TabLocation.LEFT,
            mx_TabbedView_tabsOnTop: this.props.tabLocation == TabLocation.TOP,
        });

        const screenName = tab?.screenName ?? this.props.screenName;

        return (
            <div className={tabbedViewClasses}>
                {screenName && <PosthogScreenTracker screenName={screenName} />}
                <RovingTabIndexProvider
                    handleLoop
                    handleHomeEnd
                    handleLeftRight={this.props.tabLocation == TabLocation.TOP}
                    handleUpDown={this.props.tabLocation == TabLocation.LEFT}
                >
                    {({ onKeyDownHandler }) => (
                        <div
                            className="mx_TabbedView_tabLabels"
                            role="tablist"
                            aria-orientation={this.props.tabLocation == TabLocation.LEFT ? "vertical" : "horizontal"}
                            onKeyDown={onKeyDownHandler}
                        >
                            {labels}
                        </div>
                    )}
                </RovingTabIndexProvider>
                {panel}
            </div>
        );
    }
}