/* Copyright 2017 Travis Ralston Copyright 2019 New Vector Ltd Copyright 2019, 2020, 2024 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 { _t, TranslationKey } from "../../languageHandler"; import AutoHideScrollbar from "./AutoHideScrollbar"; import { PosthogScreenTracker, ScreenName } from "../../PosthogTrackers"; import { NonEmptyArray } from "../../@types/common"; import { RovingAccessibleButton, RovingTabIndexProvider } from "../../accessibility/RovingTabIndex"; import { useWindowWidth } from "../../hooks/useWindowWidth"; /** * 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: T, public readonly label: TranslationKey, public readonly icon: string | null, public readonly body: React.ReactNode, public readonly screenName?: ScreenName, ) {} } export function useActiveTabWithDefault( tabs: NonEmptyArray>, defaultTabID: T, initialTabID?: T, ): [T, (tabId: T) => void] { const [activeTabId, setActiveTabId] = React.useState( initialTabID && tabs.some((t) => t.id === initialTabID) ? initialTabID : defaultTabID, ); return [activeTabId, setActiveTabId]; } export enum TabLocation { LEFT = "left", TOP = "top", } interface ITabPanelProps { tab: Tab; } function domIDForTabID(tabId: string): string { return `mx_tabpanel_${tabId}`; } function TabPanel({ tab }: ITabPanelProps): JSX.Element { return (
{tab.body}
); } interface ITabLabelProps { tab: Tab; isActive: boolean; showToolip: boolean; onClick: () => void; } function TabLabel({ tab, isActive, showToolip, onClick }: ITabLabelProps): JSX.Element { const classes = classNames("mx_TabbedView_tabLabel", { mx_TabbedView_tabLabel_active: isActive, }); let tabIcon: JSX.Element | undefined; if (tab.icon) { tabIcon = ; } const id = domIDForTabID(tab.id); const label = _t(tab.label); return ( {tabIcon} {label} ); } interface IProps { // An array of objects representign tabs that the tabbed view will display. tabs: NonEmptyArray>; // The ID of the tab to show activeTabId: T; // The location of the tabs, dictating the layout of the TabbedView. tabLocation?: TabLocation; // A callback that is called when the active tab should change onChange: (tabId: T) => void; // The screen name to report to Posthog. screenName?: ScreenName; /** * If true, the layout of the tabbed view will be responsive to the viewport size (eg, just showing icons * instead of names of tabs). * Only applies if `tabLocation === TabLocation.LEFT`. * Default: false. */ responsive?: boolean; } /** * A tabbed view component. Given objects representing content with titles, displays * them in a tabbed view where the user can select which one of the items to view at once. */ export default function TabbedView(props: IProps): JSX.Element { const tabLocation = props.tabLocation ?? TabLocation.LEFT; const getTabById = (id: T): Tab | undefined => { return props.tabs.find((tab) => tab.id === id); }; const windowWidth = useWindowWidth(); const labels = props.tabs.map((tab) => ( props.onChange(tab.id)} // This should be the same as the the CSS breakpoint at which the tab labels are hidden showToolip={windowWidth < 1024 && tabLocation == TabLocation.LEFT} /> )); const tab = getTabById(props.activeTabId); const panel = tab ? : null; const tabbedViewClasses = classNames({ mx_TabbedView: true, mx_TabbedView_tabsOnLeft: tabLocation == TabLocation.LEFT, mx_TabbedView_tabsOnTop: tabLocation == TabLocation.TOP, mx_TabbedView_responsive: props.responsive, }); const screenName = tab?.screenName ?? props.screenName; return (
{screenName && } {({ onKeyDownHandler }) => (
    {labels}
)}
{panel}
); }