@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
856 lines (855 loc) • 25.8 kB
JavaScript
"use client";
import _extends from "@babel/runtime/helpers/esm/extends";
import React from 'react';
import classnames from 'classnames';
import Context from "../../shared/Context.js";
import { warn, slugify, isTrue, makeUniqueId, extendPropsWithContextInClassComponent, validateDOMAttributes, dispatchCustomElementEvent, getClosestParent, filterProps, combineLabelledBy, keycode } from "../../shared/component-helper.js";
import { createSpacingClasses } from "../space/SpacingHelper.js";
import { createSkeletonClass, skeletonDOMAttributes } from "../skeleton/SkeletonHelper.js";
import Button from "../button/Button.js";
import whatInput from 'what-input';
import CustomContent from "./TabsCustomContent.js";
import ContentWrapper from "./TabsContentWrapper.js";
import EventEmitter from "../../shared/helpers/EventEmitter.js";
export default class Tabs extends React.PureComponent {
static contextType = Context;
static defaultProps = {
data: null,
content: null,
content_style: null,
content_spacing: true,
label: null,
tab_element: 'button',
selected_key: null,
align: 'left',
tabs_style: null,
tabs_spacing: null,
no_border: false,
nav_button_edge: false,
onOpenTabNavigationFn: null,
prerender: false,
prevent_rerender: false,
scroll: null,
skeleton: null,
id: null,
className: null,
children: null,
render: null,
on_change: null,
on_mouse_enter: null,
on_click: null,
on_focus: null,
breakout: true
};
static Content = CustomContent;
static ContentWrapper = ContentWrapper;
static getSelectedKeyOrFallback(selected_key, data) {
let useKey = selected_key;
if (!useKey) {
useKey = data.reduce((acc, {
selected,
key
}) => selected ? key : acc, null) || data[0] && data[0].key;
} else {
const keyExists = data.findIndex(({
key
}) => key == selected_key);
if (keyExists === -1) {
useKey = data[0] && data[0].key;
}
}
return useKey;
}
static getDerivedStateFromProps(props, state) {
if (state._listenForPropChanges) {
if (props.data) {
if (state._data !== props.data) {
state._data = props.data;
state.data = Tabs.getData(props);
}
} else if (props.children) {
if (state._data !== props.children) {
state._data = props.children;
state.data = Tabs.getData(props);
}
}
if (props.selected_key && state._selected_key !== props.selected_key) {
state.selected_key = state._selected_key = Tabs.getSelectedKeyOrFallback(props.selected_key, state.data);
}
}
state._listenForPropChanges = true;
return state;
}
static getData(props) {
const addReactElement = (list, reactElem, reactElemIndex) => {
if (reactElem && reactElem.type === CustomContent) {
const dataProps = props.children && Array.isArray(props.children) && props.children[reactElemIndex] || {};
const componentProps = {
...reactElem.props
};
if (componentProps.title === null) {
delete componentProps.title;
}
const {
title,
key: _key,
hash,
...rest
} = {
...dataProps,
...componentProps,
...{
children: null
}
};
list.push({
title,
key: (!_key && hash ? hash : _key) || slugify(title),
content: reactElem,
...rest
});
}
};
let res = [];
const data = !props.data && props.children ? props.children : props.data;
if (Array.isArray(props.children) && props.children.some(element => typeof element === 'function' || React.isValidElement(element))) {
res = props.children.reduce((list, reactElem, i) => {
addReactElement(list, reactElem, i);
return list;
}, []);
}
if (!Array.isArray(props.children) && (typeof props.children === 'function' || React.isValidElement(props.children))) {
addReactElement(res, props.children);
}
if (!(res && res.length > 0)) {
if (props.data && Array.isArray(data)) {
res = data;
} else if (typeof data === 'string') {
res = data[0] === '[' ? JSON.parse(data) : [];
} else if (data && typeof data === 'object') {
res = Object.entries(data).reduce((acc, [key, obj]) => {
if (obj) {
acc.push({
key,
...obj
});
}
return acc;
}, []);
}
}
return res || [];
}
constructor(props) {
super(props);
this._id = props.id || makeUniqueId();
const data = Tabs.getData(props);
const selected_key = Tabs.getSelectedKeyOrFallback(props.selected_key, data);
const lastPosition = this.getLastPosition();
this.state = {
data,
selected_key,
focus_key: selected_key,
atEdge: false,
lastPosition,
hasScrollbar: lastPosition > -1,
_selected_key: selected_key,
_data: props.data || props.children,
_listenForPropChanges: true
};
this._tabsRef = React.createRef();
this._tablistRef = React.createRef();
if (props.id) {
this._eventEmitter = EventEmitter.createInstance(props.id);
this._eventEmitter.set(this.getEventArgs({
selected_key
}));
}
}
componentDidMount() {
this._isMounted = true;
if (document.readyState === 'complete') {
this.init();
} else if (typeof window !== 'undefined') {
window.addEventListener('load', this.init);
}
}
componentWillUnmount() {
this._isMounted = false;
this.resetWhatInput();
if (this._eventEmitter) {
this._eventEmitter.remove();
this._eventEmitter = null;
}
if (typeof window !== 'undefined') {
window.removeEventListener('resize', this.onResizeHandler);
window.removeEventListener('load', this.init);
}
}
init = () => {
if (this._isMounted) {
this.addScrollBehavior();
const hasScrollbar = this.hasScrollbar();
const hasLastPosition = this.hasLastPosition();
this.setScrollbarState({
hasScrollbar
});
if (hasLastPosition) {
this.setLeftPosition(this.state.lastPosition);
}
if (hasScrollbar) {
this.scrollToTab({
type: 'selected',
behavior: hasLastPosition ? 'smooth' : 'auto'
});
}
if (this.hasLastUsedTab() !== null) {
this.setState(null, this.setFocusOnTabButton);
}
}
};
componentDidUpdate(props) {
if (this._eventEmitter && (this.props.selected_key !== props.selected_key || this.props.data !== props.data)) {
this.onResizeHandler();
if (this._eventEmitter) {
const selected_key = this.state.selected_key;
this._eventEmitter.update(this.getEventArgs({
selected_key
}));
}
}
}
hasLastPosition() {
return this.state.lastPosition > -1;
}
getLastPosition() {
if (typeof window !== 'undefined') {
try {
const pos = parseFloat(window.localStorage.getItem(`tabs-pos-${this._id}`));
window.localStorage.removeItem(`tabs-pos-${this._id}`);
return isNaN(pos) ? -1 : pos;
} catch (e) {
warn(e);
}
}
return -1;
}
hasLastUsedTab() {
if (typeof window !== 'undefined') {
try {
const key = window.localStorage.getItem(`tabs-last-${this._id}`) || null;
window.localStorage.removeItem(`tabs-last-${this._id}`);
return key;
} catch (e) {
warn(e);
}
}
return -1;
}
saveLastUsedTab() {
if (typeof window !== 'undefined') {
try {
window.localStorage.setItem(`tabs-last-${this._id}`, this.state.selected_key);
} catch (e) {
warn(e);
}
}
}
saveLastPosition(position = this._tablistRef.current.scrollLeft) {
if (typeof window !== 'undefined') {
try {
window.localStorage.setItem(`tabs-pos-${this._id}`, position);
} catch (e) {
warn(e);
}
}
}
setScrollbarState = ({
hasScrollbar = this.hasScrollbar()
} = {}) => {
if (hasScrollbar !== this.state.hasScrollbar) {
this.setState({
hasScrollbar
});
}
};
onResizeHandler = () => {
const hasScrollbar = this.hasScrollbar();
this.setScrollbarState({
hasScrollbar
});
if (hasScrollbar) {
this.scrollToTab({
type: 'selected'
});
}
};
hasScrollbar() {
return (this._tablistRef.current.scrollWidth - 1 > this._tablistRef.current.offsetWidth
);
}
addScrollBehavior() {
if (typeof window !== 'undefined') {
window.addEventListener('resize', this.onResizeHandler);
}
}
onTablistKeyDownHandler = e => {
switch (keycode(e)) {
case 'up':
case 'page up':
case 'left':
e.preventDefault();
this.focusPrevTab(e);
break;
case 'down':
case 'page down':
case 'right':
e.preventDefault();
this.focusNextTab(e);
break;
case 'home':
e.preventDefault();
this.focusFirstTab(e);
break;
case 'end':
e.preventDefault();
this.focusLastTab(e);
break;
}
};
focusFirstTab = e => {
const key = this.state.data[0].key;
this.focusTab(key, e, 'step');
this.scrollToTab({
type: 'focus'
});
};
focusLastTab = e => {
const key = this.state.data[this.state.data.length - 1].key;
this.focusTab(key, e, 'step');
this.scrollToTab({
type: 'focus'
});
};
focusPrevTab = e => {
this.focusTab(-1, e, 'step');
this.scrollToTab({
type: 'focus'
});
};
focusNextTab = e => {
this.focusTab(+1, e, 'step');
this.scrollToTab({
type: 'focus'
});
};
openPrevTab = e => {
this.openTab(-1, e, 'step');
this.scrollToTab({
type: 'selected'
});
};
openNextTab = e => {
this.openTab(+1, e, 'step');
this.scrollToTab({
type: 'selected'
});
};
handleVerticalScroll = () => {
if (isTrue(this.props.scroll) && this._tablistRef.current && typeof this._tablistRef.current.scrollIntoView === 'function') {
this._tablistRef.current.scrollIntoView({
block: 'start',
behavior: 'smooth'
});
}
};
setLeftPosition(scrollLeft) {
try {
this._tablistRef.current.style.scrollBehavior = 'auto';
this._tablistRef.current.scrollLeft = scrollLeft;
this._tablistRef.current.style.scrollBehavior = 'smooth';
} catch (e) {}
}
scrollToTab({
type,
behavior = 'smooth'
}) {
if (typeof window === 'undefined') {
return;
}
if (window.IS_TEST) {
behavior = 'auto';
}
const delay = () => {
try {
if (this.state.hasScrollbar && this._tablistRef.current) {
const first = this._tablistRef.current.querySelector('.dnb-tabs__button__snap:first-of-type');
const isFirst = first.classList.contains(type);
const last = this._tablistRef.current.querySelector('.dnb-tabs__button__snap:last-of-type');
const isLast = last.classList.contains(type);
const elem = this._tablistRef.current.querySelector(`.dnb-tabs__button.${type}`);
const style = window.getComputedStyle(this._tabsRef.current);
const margin = parseFloat(style.marginLeft);
let padding = margin < 0 ? parseFloat(style.paddingLeft) : 0;
if (!isFirst && !isLast && parseFloat(style.paddingLeft) < 16) {
const navButton = this._tabsRef.current.querySelector('.dnb-tabs__scroll-nav-button:first-of-type');
const additionalSpace = parseFloat(window.getComputedStyle(navButton).width) * 1.5;
padding += additionalSpace;
}
const leftPadding = (margin < 0 ? Math.abs(margin) : 0) + padding + parseFloat(window.getComputedStyle(first).paddingLeft);
const offsetLeft = elem.offsetLeft;
const left = elem && !isFirst ? offsetLeft - leftPadding : 0;
if (behavior === 'auto') {
this._tablistRef.current.style.scrollBehavior = 'auto';
}
this._tablistRef.current.scrollTo({
left,
behavior
});
if (behavior === 'auto') {
this._tablistRef.current.style.scrollBehavior = '';
}
this.setState({
isFirst,
isLast
});
}
} catch (e) {
warn(e);
}
};
window.requestAnimationFrame(delay);
}
onMouseDown = event => {
event.preventDefault();
};
onKeyDownHandler = event => {
switch (keycode(event)) {
case 'enter':
try {
const elem = document.getElementById(`${this._id}-content`);
elem.focus({
preventScroll: true
});
} catch (e) {
this.warnAboutMissingContainer();
}
break;
}
};
onMouseEnterHandler = event => {
const selected_key = this.getCurrentKey(event);
if (selected_key) {
dispatchCustomElementEvent(this, 'on_mouse_enter', this.getEventArgs({
event,
selected_key
}));
}
};
onClickHandler = event => {
const selected_key = this.getCurrentKey(event);
if (selected_key) {
const ret = dispatchCustomElementEvent(this, 'on_click', this.getEventArgs({
event,
selected_key
}));
if (ret !== false) {
this.openTab(selected_key, event);
this.scrollToTab({
type: 'selected'
});
}
}
};
getCurrentKey = event => {
let selected_key;
try {
selected_key = function (elem) {
return getClosestParent('dnb-tabs__button', elem) || {
dataset: {}
};
}(event.target).dataset.tabKey;
} catch (e) {
warn('Tabs Error:', e);
}
return selected_key;
};
getCurrentTitle = (selected_key = this.state.selected_key) => {
const current = this.state.data.filter(({
key
}) => key == selected_key)[0];
return current && current.title || null;
};
getStepKey(useKey, stateKey) {
const currentData = this.state.data.filter(({
disabled
}) => !disabled);
const currentIndex = currentData.reduce((acc, {
key
}, i) => key == stateKey ? i : acc, -1);
let nextIndex = currentIndex + useKey;
if (nextIndex < 0) {
nextIndex = currentData.length - 1;
}
if (nextIndex >= currentData.length) {
nextIndex = 0;
}
return currentData.reduce((acc, {
key
}, i) => i === nextIndex ? key : acc, null);
}
focusTab = (focus_key, event = null, mode = null) => {
if (mode === 'step' && parseFloat(focus_key)) {
focus_key = this.getStepKey(focus_key, this.state.focus_key);
}
this.setState({
focus_key,
_listenForPropChanges: false
}, this.setFocusOnTabButton);
dispatchCustomElementEvent(this, 'on_focus', this.getEventArgs({
event,
focus_key
}));
this.setWhatInput();
};
setWhatInput() {
whatInput.specificKeys([9, 37, 39, 33, 34, 35, 36]);
}
resetWhatInput() {
whatInput.specificKeys([9]);
}
setFocusOnTabButton = () => {
try {
const elem = this._tablistRef.current.querySelector('.dnb-tabs__button.focus');
elem.focus({
preventScroll: true
});
if (!document.getElementById(`${this._id}-content`) && typeof process !== 'undefined' && process.env.NODE_ENV !== 'test') {
this.warnAboutMissingContainer();
}
} catch (e) {
warn(e);
}
};
warnAboutMissingContainer() {
warn(`Could not find the required <Tabs.Content id="${this._id}-content" ... /> that provides role="tabpanel"`);
}
openTab = (selected_key, event = null, mode = null) => {
this.saveLastPosition();
this.saveLastUsedTab();
this.resetWhatInput();
if (mode === 'step' && parseFloat(selected_key)) {
selected_key = this.getStepKey(selected_key, this.state.selected_key);
}
if (typeof selected_key !== 'undefined') {
this.setState({
selected_key,
focus_key: selected_key,
_listenForPropChanges: false
}, this.handleVerticalScroll);
}
dispatchCustomElementEvent(this, 'on_change', this.getEventArgs({
event,
selected_key
}));
if (this.props.onOpenTabNavigationFn && typeof window !== 'undefined') {
try {
this.props.onOpenTabNavigationFn(selected_key);
} catch (e) {
warn('Tabs Error:', e);
}
}
if (this._eventEmitter) {
this._eventEmitter.update(this.getEventArgs({
event,
selected_key
}));
}
};
getEventArgs(args) {
const {
selected_key,
focus_key
} = this.state;
const key = typeof args.selected_key !== 'undefined' ? args.selected_key : selected_key;
return {
key,
selected_key,
focus_key,
title: this.getCurrentTitle(key),
...args
};
}
isFocus(tabKey) {
return this.state.focus_key == tabKey;
}
isSelected(tabKey) {
return this.state.selected_key == tabKey;
}
renderCachedContent() {
const {
selected_key,
data
} = this.state;
const {
prevent_rerender,
prerender
} = this.props;
if (isTrue(prerender)) {
this._cache = Object.entries(data).reduce((acc, [_idx, cur]) => {
acc[cur.key] = {
...cur,
content: this.getContent(cur.key)
};
return acc;
}, {});
} else if (isTrue(prevent_rerender)) {
this._cache = {
...(this._cache || {}),
[selected_key]: {
content: this.getContent(selected_key)
}
};
}
const cachedContent = Object.entries(this._cache).map(([key, {
content
}]) => {
const hide = key !== String(selected_key);
return React.createElement("div", {
key: key,
"aria-hidden": hide ? true : undefined,
className: 'dnb-tabs__cached' + (hide ? " dnb-tabs__cached--hidden" : "")
}, content);
});
return cachedContent;
}
renderContent() {
const {
prevent_rerender,
prerender
} = this.props;
if (isTrue(prevent_rerender) || isTrue(prerender)) {
return this.renderCachedContent();
}
return this.getContent(this.state.selected_key);
}
getContent = selected_key => {
const {
children,
content: _content
} = this.props;
const contentToRender = children || _content;
let content = null;
if (contentToRender) {
if (typeof contentToRender === 'object' && contentToRender[selected_key]) {
content = contentToRender[selected_key];
} else if (typeof contentToRender === 'function') {
content = contentToRender.apply(this, [selected_key]);
} else if (React.isValidElement(contentToRender)) {
content = contentToRender;
}
}
if (!content) {
let items = [];
if (Array.isArray(this.state.data)) {
items = this.state.data;
} else if (Array.isArray(contentToRender)) {
items = contentToRender;
}
if (items) {
content = items.filter(({
key
}) => key && selected_key && key == selected_key).reduce((acc, {
content
}) => content || acc, null);
}
}
if (typeof content === 'function') {
const Component = content;
content = React.createElement(Component, null);
}
return content;
};
TabsWrapperHandler = ({
children,
...rest
}) => {
const {
className,
class: _className
} = this.props;
const {
...attributes
} = filterProps(this.props, Tabs.defaultProps);
const params = {
...attributes,
className: classnames('dnb-tabs', createSpacingClasses(this.props), className, _className)
};
validateDOMAttributes(this.props, params);
return React.createElement("div", _extends({}, params, rest), children);
};
TabsListHandler = ({
children,
className,
...rest
}) => {
const {
align,
tabs_style,
tabs_spacing,
no_border,
nav_button_edge,
breakout
} = this.props;
const {
hasScrollbar
} = this.state;
return React.createElement("div", _extends({
className: classnames('dnb-tabs__tabs', className, align && `dnb-tabs__tabs--${align}`, tabs_style && `dnb-section dnb-section--${tabs_style}`, tabs_spacing && `dnb-section--spacing-${isTrue(tabs_spacing) ? 'large' : tabs_spacing}`, hasScrollbar && 'dnb-tabs--has-scrollbar', nav_button_edge && 'dnb-tabs--at-edge', no_border && 'dnb-tabs__tabs--no-border', breakout && 'dnb-tabs__tabs--breakout'),
ref: this._tabsRef
}, rest), React.createElement(ScrollNavButton, {
onMouseDown: this.openPrevTab,
icon: "chevron_left",
className: classnames(hasScrollbar && (typeof this.state.isFirst !== 'undefined' || this.hasLastPosition()) && 'dnb-tabs__scroll-nav-button--visible', this.state.isFirst && 'dnb-tabs__scroll-nav-button--hide')
}), children, React.createElement(ScrollNavButton, {
onMouseDown: this.openNextTab,
icon: "chevron_right",
className: classnames(hasScrollbar && (typeof this.state.isLast !== 'undefined' || this.hasLastPosition()) && 'dnb-tabs__scroll-nav-button--visible', this.state.isLast && 'dnb-tabs__scroll-nav-button--hide')
}));
};
TabContentHandler = () => {
const {
selected_key
} = this.state;
const content = this.renderContent();
if (!this._eventEmitter && !content) {
warn(`No content was given to the Tabs component!
Tip: Check out other solutions like <Tabs.Content id="unique">Your content, outside of the Tabs component</Tabs.Content>
`);
}
return React.createElement(ContentWrapper, {
id: this._id,
selected_key: selected_key,
content_style: this.props.content_style,
content_spacing: this.props.content_spacing,
animate: this.props.prerender
}, content);
};
TabsHandler = props => {
const {
label,
skeleton,
tab_element
} = {
...this._props,
...props
};
const {
selected_key
} = this.state;
const TabElement = tab_element || 'button';
const tabs = this.state.data.map(({
title,
key,
disabled = false,
to,
href
}) => {
const itemParams = {
to,
href
};
const isFocus = this.isFocus(key);
const isSelected = this.isSelected(key);
if (isSelected) {
itemParams['aria-controls'] = `${this._id}-content`;
}
if (isTrue(disabled)) {
itemParams.disabled = true;
itemParams['aria-disabled'] = true;
}
if (TabElement === 'button') {
itemParams.type = 'button';
}
skeletonDOMAttributes(itemParams, skeleton, this.context);
return React.createElement("div", {
className: classnames('dnb-tabs__button__snap', isFocus && 'focus', isSelected && 'selected'),
key: `tab-${key}`
}, React.createElement(TabElement, _extends({
role: "tab",
tabIndex: "-1",
id: `${this._id}-tab-${key}`,
"aria-selected": isSelected,
className: classnames('dnb-tabs__button', isFocus && 'focus', isSelected && 'selected'),
onMouseEnter: this.onMouseEnterHandler,
onClick: this.onClickHandler,
onKeyUp: this.onKeyDownHandler,
onMouseDown: this.onMouseDown,
"data-tab-key": key
}, itemParams), React.createElement("span", {
className: classnames('dnb-tabs__button__title', createSkeletonClass('font', skeleton, this.context))
}, title), React.createElement(Dummy, null, title)));
});
const params = {};
if (label) {
params['aria-label'] = label;
}
if (selected_key) {
params['aria-labelledby'] = combineLabelledBy(params, `${this._id}-tab-${selected_key}`);
}
return React.createElement("div", _extends({
role: "tablist",
className: "dnb-tabs__tabs__tablist",
tabIndex: "0",
onKeyDown: this.onTablistKeyDownHandler,
ref: this._tablistRef
}, params), tabs);
};
render() {
const props = this._props = extendPropsWithContextInClassComponent(this.props, Tabs.defaultProps, {
skeleton: this.context?.skeleton
});
const {
render: customRenderer
} = props;
const TabItems = this.TabsHandler;
TabItems.displayName = 'Tabs';
const TabsList = this.TabsListHandler;
TabsList.displayName = 'TabsList';
const Wrapper = this.TabsWrapperHandler;
Wrapper.displayName = 'TabsWrapper';
const Content = this.TabContentHandler;
Content.displayName = 'TabContent';
if (typeof customRenderer === 'function') {
return customRenderer({
Wrapper,
Content,
TabsList,
Tabs: TabItems
});
}
return React.createElement(Wrapper, null, React.createElement(TabsList, null, React.createElement(TabItems, null)), React.createElement(Content, null));
}
}
export const Dummy = ({
children
}) => {
return React.createElement("span", {
"aria-hidden": true,
hidden: true,
className: "dnb-dummy"
}, children);
};
const ScrollNavButton = props => {
return React.createElement(Button, _extends({
size: "medium",
variant: "primary",
tabIndex: "-1",
bounding: true,
"aria-hidden": true
}, props, {
className: classnames('dnb-tabs__scroll-nav-button', props.className)
}));
};
Tabs._supportsSpacingProps = true;
//# sourceMappingURL=Tabs.js.map