/*
* Copyright 2015 Palantir Technologies, Inc. All rights reserved.
*
* 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 classNames from "classnames";
import * as React from "react";
import { polyfill } from "react-lifecycles-compat";
import { AbstractPureComponent2, Classes, Keys } from "../../common";
import { DISPLAYNAME_PREFIX, IProps } from "../../common/props";
import * as Utils from "../../common/utils";
import { ITabProps, Tab, TabId } from "./tab";
import { generateTabPanelId, generateTabTitleId, TabTitle } from "./tabTitle";
export const Expander: React.SFC<{}> = () =>
;
type TabElement = React.ReactElement;
const TAB_SELECTOR = `.${Classes.TAB}`;
export interface ITabsProps extends IProps {
/**
* Whether the selected tab indicator should animate its movement.
* @default true
*/
animate?: boolean;
/**
* Initial selected tab `id`, for uncontrolled usage.
* Note that this prop refers only to `` children; other types of elements are ignored.
* @default first tab
*/
defaultSelectedTabId?: TabId;
/**
* Unique identifier for this `Tabs` container. This will be combined with the `id` of each
* `Tab` child to generate ARIA accessibility attributes. IDs are required and should be
* unique on the page to support server-side rendering.
*/
id: TabId;
/**
* If set to `true`, the tab titles will display with larger styling.
* This will apply large styles only to the tabs at this level, not to nested tabs.
* @default false
*/
large?: boolean;
/**
* Whether inactive tab panels should be removed from the DOM and unmounted in React.
* This can be a performance enhancement when rendering many complex panels, but requires
* careful support for unmounting and remounting.
* @default false
*/
renderActiveTabPanelOnly?: boolean;
/**
* Selected tab `id`, for controlled usage.
* Providing this prop will put the component in controlled mode.
* Unknown ids will result in empty selection (no errors).
*/
selectedTabId?: TabId;
/**
* Whether to show tabs stacked vertically on the left side.
* @default false
*/
vertical?: boolean;
/**
* A callback function that is invoked when a tab in the tab list is clicked.
*/
onChange?(newTabId: TabId, prevTabId: TabId, event: React.MouseEvent): void;
}
export interface ITabsState {
indicatorWrapperStyle?: React.CSSProperties;
selectedTabId?: TabId;
}
@polyfill
export class Tabs extends AbstractPureComponent2 {
/** Insert a `Tabs.Expander` between any two children to right-align all subsequent children. */
public static Expander = Expander;
public static Tab = Tab;
public static defaultProps: Partial = {
animate: true,
large: false,
renderActiveTabPanelOnly: false,
vertical: false,
};
public static displayName = `${DISPLAYNAME_PREFIX}.Tabs`;
public static getDerivedStateFromProps({ selectedTabId }: ITabsProps) {
if (selectedTabId !== undefined) {
// keep state in sync with controlled prop, so state is canonical source of truth
return { selectedTabId };
}
return null;
}
private tablistElement: HTMLDivElement;
private refHandlers = {
tablist: (tabElement: HTMLDivElement) => (this.tablistElement = tabElement),
};
constructor(props?: ITabsProps) {
super(props);
const selectedTabId = this.getInitialSelectedTabId();
this.state = { selectedTabId };
}
public render() {
const { indicatorWrapperStyle, selectedTabId } = this.state;
const tabTitles = React.Children.map(this.props.children, this.renderTabTitle);
const tabPanels = this.getTabChildren()
.filter(this.props.renderActiveTabPanelOnly ? tab => tab.props.id === selectedTabId : () => true)
.map(this.renderTabPanel);
const tabIndicator = this.props.animate ? (
) : null;
const classes = classNames(Classes.TABS, { [Classes.VERTICAL]: this.props.vertical }, this.props.className);
const tabListClasses = classNames(Classes.TAB_LIST, {
[Classes.LARGE]: this.props.large,
});
return (
{tabIndicator}
{tabTitles}
{tabPanels}
);
}
public componentDidMount() {
this.moveSelectionIndicator();
}
public componentDidUpdate(prevProps: ITabsProps, prevState: ITabsState) {
if (this.state.selectedTabId !== prevState.selectedTabId) {
this.moveSelectionIndicator();
} else if (prevState.selectedTabId != null) {
// comparing React nodes is difficult to do with simple logic, so
// shallowly compare just their props as a workaround.
const didChildrenChange = !Utils.arraysEqual(
this.getTabChildrenProps(prevProps),
this.getTabChildrenProps(),
Utils.shallowCompareKeys,
);
if (didChildrenChange) {
this.moveSelectionIndicator();
}
}
}
private getInitialSelectedTabId() {
// NOTE: providing an unknown ID will hide the selection
const { defaultSelectedTabId, selectedTabId } = this.props;
if (selectedTabId !== undefined) {
return selectedTabId;
} else if (defaultSelectedTabId !== undefined) {
return defaultSelectedTabId;
} else {
// select first tab in absence of user input
const tabs = this.getTabChildren();
return tabs.length === 0 ? undefined : tabs[0].props.id;
}
}
private getKeyCodeDirection(e: React.KeyboardEvent) {
if (isEventKeyCode(e, Keys.ARROW_LEFT, Keys.ARROW_UP)) {
return -1;
} else if (isEventKeyCode(e, Keys.ARROW_RIGHT, Keys.ARROW_DOWN)) {
return 1;
}
return undefined;
}
private getTabChildrenProps(props: ITabsProps & { children?: React.ReactNode } = this.props) {
return this.getTabChildren(props).map(child => child.props);
}
/** Filters children to only ``s */
private getTabChildren(props: ITabsProps & { children?: React.ReactNode } = this.props) {
return React.Children.toArray(props.children).filter(isTabElement);
}
/** Queries root HTML element for all tabs with optional filter selector */
private getTabElements(subselector = "") {
if (this.tablistElement == null) {
return [];
}
return Array.from(this.tablistElement.querySelectorAll(TAB_SELECTOR + subselector));
}
private handleKeyDown = (e: React.KeyboardEvent) => {
const focusedElement = document.activeElement.closest(TAB_SELECTOR);
// rest of this is potentially expensive and futile, so bail if no tab is focused
if (focusedElement == null) {
return;
}
// must rely on DOM state because we have no way of mapping `focusedElement` to a JSX.Element
const enabledTabElements = this.getTabElements().filter(el => el.getAttribute("aria-disabled") === "false");
const focusedIndex = enabledTabElements.indexOf(focusedElement);
const direction = this.getKeyCodeDirection(e);
if (focusedIndex >= 0 && direction !== undefined) {
e.preventDefault();
const { length } = enabledTabElements;
// auto-wrapping at 0 and `length`
const nextFocusedIndex = (focusedIndex + direction + length) % length;
(enabledTabElements[nextFocusedIndex] as HTMLElement).focus();
}
};
private handleKeyPress = (e: React.KeyboardEvent) => {
const targetTabElement = (e.target as HTMLElement).closest(TAB_SELECTOR) as HTMLElement;
if (targetTabElement != null && Keys.isKeyboardClick(e.which)) {
e.preventDefault();
targetTabElement.click();
}
};
private handleTabClick = (newTabId: TabId, event: React.MouseEvent) => {
Utils.safeInvoke(this.props.onChange, newTabId, this.state.selectedTabId, event);
if (this.props.selectedTabId === undefined) {
this.setState({ selectedTabId: newTabId });
}
};
/**
* Calculate the new height, width, and position of the tab indicator.
* Store the CSS values so the transition animation can start.
*/
private moveSelectionIndicator() {
if (this.tablistElement == null || !this.props.animate) {
return;
}
const tabIdSelector = `${TAB_SELECTOR}[data-tab-id="${this.state.selectedTabId}"]`;
const selectedTabElement = this.tablistElement.querySelector(tabIdSelector) as HTMLElement;
let indicatorWrapperStyle: React.CSSProperties = { display: "none" };
if (selectedTabElement != null) {
const { clientHeight, clientWidth, offsetLeft, offsetTop } = selectedTabElement;
indicatorWrapperStyle = {
height: clientHeight,
transform: `translateX(${Math.floor(offsetLeft)}px) translateY(${Math.floor(offsetTop)}px)`,
width: clientWidth,
};
}
this.setState({ indicatorWrapperStyle });
}
private renderTabPanel = (tab: TabElement) => {
const { className, panel, id, panelClassName } = tab.props;
if (panel === undefined) {
return undefined;
}
return (
{panel}
);
};
private renderTabTitle = (child: React.ReactChild) => {
if (isTabElement(child)) {
const { id } = child.props;
return (
);
}
return child;
};
}
function isEventKeyCode(e: React.KeyboardEvent, ...codes: number[]) {
return codes.indexOf(e.which) >= 0;
}
function isTabElement(child: any): child is TabElement {
return Utils.isElementOfType(child, Tab);
}