-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
/
Tabs.js
687 lines (629 loc) · 20.9 KB
/
Tabs.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
import * as React from 'react';
import { isFragment } from 'react-is';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import { refType } from '@material-ui/utils';
import debounce from '../utils/debounce';
import ownerWindow from '../utils/ownerWindow';
import { getNormalizedScrollLeft, detectScrollType } from '../utils/scrollLeft';
import animate from '../internal/animate';
import ScrollbarSize from './ScrollbarSize';
import withStyles from '../styles/withStyles';
import TabIndicator from './TabIndicator';
import TabScrollButton from '../TabScrollButton';
import useEventCallback from '../utils/useEventCallback';
import useTheme from '../styles/useTheme';
export const styles = (theme) => ({
/* Styles applied to the root element. */
root: {
overflow: 'hidden',
minHeight: 48,
WebkitOverflowScrolling: 'touch', // Add iOS momentum scrolling.
display: 'flex',
},
/* Styles applied to the root element if `orientation="vertical"`. */
vertical: {
flexDirection: 'column',
},
/* Styles applied to the flex container element. */
flexContainer: {
display: 'flex',
},
/* Styles applied to the flex container element if `orientation="vertical"`. */
flexContainerVertical: {
flexDirection: 'column',
},
/* Styles applied to the flex container element if `centered={true}` & `!variant="scrollable"`. */
centered: {
justifyContent: 'center',
},
/* Styles applied to the tablist element. */
scroller: {
position: 'relative',
display: 'inline-block',
flex: '1 1 auto',
whiteSpace: 'nowrap',
},
/* Styles applied to the tablist element if `!variant="scrollable"`. */
fixed: {
overflowX: 'hidden',
width: '100%',
},
/* Styles applied to the tablist element if `variant="scrollable"` and `orientation="horizontal"`. */
scrollableX: {
overflowX: 'auto',
overflowY: 'hidden',
},
/* Styles applied to the tablist element if `variant="scrollable"` and `orientation="vertical"`. */
scrollableY: {
overflowY: 'auto',
overflowX: 'hidden',
},
/* Styles applied to the tablist element if `variant="scrollable"` and `visibleScrollbar={false}`. */
hideScrollbar: {
// Hide dimensionless scrollbar on MacOS
scrollbarWidth: 'none', // Firefox
'&::-webkit-scrollbar': {
display: 'none', // Safari + Chrome
},
},
/* Styles applied to the ScrollButtonComponent component. */
scrollButtons: {},
/* Styles applied to the ScrollButtonComponent component if `allowScrollButtonsMobile={true}`. */
scrollButtonsHideMobile: {
[theme.breakpoints.down('sm')]: {
display: 'none',
},
},
/* Styles applied to the TabIndicator component. */
indicator: {},
});
const defaultIndicatorStyle = {};
const Tabs = React.forwardRef(function Tabs(props, ref) {
const {
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
action,
centered = false,
children: childrenProp,
classes,
className,
component: Component = 'div',
allowScrollButtonsMobile = false,
indicatorColor = 'primary',
onChange,
orientation = 'horizontal',
ScrollButtonComponent = TabScrollButton,
scrollButtons = 'auto',
selectionFollowsFocus,
TabIndicatorProps = {},
TabScrollButtonProps,
textColor = 'primary',
value,
variant = 'standard',
visibleScrollbar = false,
...other
} = props;
const theme = useTheme();
const scrollable = variant === 'scrollable';
const isRtl = theme.direction === 'rtl';
const vertical = orientation === 'vertical';
const scrollStart = vertical ? 'scrollTop' : 'scrollLeft';
const start = vertical ? 'top' : 'left';
const end = vertical ? 'bottom' : 'right';
const clientSize = vertical ? 'clientHeight' : 'clientWidth';
const size = vertical ? 'height' : 'width';
if (process.env.NODE_ENV !== 'production') {
if (centered && scrollable) {
console.error(
'Material-UI: You can not use the `centered={true}` and `variant="scrollable"` properties ' +
'at the same time on a `Tabs` component.',
);
}
}
const [mounted, setMounted] = React.useState(false);
const [indicatorStyle, setIndicatorStyle] = React.useState(defaultIndicatorStyle);
const [displayScroll, setDisplayScroll] = React.useState({
start: false,
end: false,
});
const [scrollerStyle, setScrollerStyle] = React.useState({
overflow: 'hidden',
scrollbarWidth: 0,
});
const valueToIndex = new Map();
const tabsRef = React.useRef(null);
const tabListRef = React.useRef(null);
const getTabsMeta = () => {
const tabsNode = tabsRef.current;
let tabsMeta;
if (tabsNode) {
const rect = tabsNode.getBoundingClientRect();
// create a new object with ClientRect class props + scrollLeft
tabsMeta = {
clientWidth: tabsNode.clientWidth,
scrollLeft: tabsNode.scrollLeft,
scrollTop: tabsNode.scrollTop,
scrollLeftNormalized: getNormalizedScrollLeft(tabsNode, theme.direction),
scrollWidth: tabsNode.scrollWidth,
top: rect.top,
bottom: rect.bottom,
left: rect.left,
right: rect.right,
};
}
let tabMeta;
if (tabsNode && value !== false) {
const children = tabListRef.current.children;
if (children.length > 0) {
const tab = children[valueToIndex.get(value)];
if (process.env.NODE_ENV !== 'production') {
if (!tab) {
console.error(
[
`Material-UI: The value provided to the Tabs component is invalid.`,
`None of the Tabs' children match with \`${value}\`.`,
valueToIndex.keys
? `You can provide one of the following values: ${Array.from(
valueToIndex.keys(),
).join(', ')}.`
: null,
].join('\n'),
);
}
}
tabMeta = tab ? tab.getBoundingClientRect() : null;
}
}
return { tabsMeta, tabMeta };
};
const updateIndicatorState = useEventCallback(() => {
const { tabsMeta, tabMeta } = getTabsMeta();
let startValue = 0;
if (tabMeta && tabsMeta) {
if (vertical) {
startValue = tabMeta.top - tabsMeta.top + tabsMeta.scrollTop;
} else {
const correction = isRtl
? tabsMeta.scrollLeftNormalized + tabsMeta.clientWidth - tabsMeta.scrollWidth
: tabsMeta.scrollLeft;
startValue = tabMeta.left - tabsMeta.left + correction;
}
}
const newIndicatorStyle = {
[start]: startValue,
// May be wrong until the font is loaded.
[size]: tabMeta ? tabMeta[size] : 0,
};
// IE11 support, replace with Number.isNaN
// eslint-disable-next-line no-restricted-globals
if (isNaN(indicatorStyle[start]) || isNaN(indicatorStyle[size])) {
setIndicatorStyle(newIndicatorStyle);
} else {
const dStart = Math.abs(indicatorStyle[start] - newIndicatorStyle[start]);
const dSize = Math.abs(indicatorStyle[size] - newIndicatorStyle[size]);
if (dStart >= 1 || dSize >= 1) {
setIndicatorStyle(newIndicatorStyle);
}
}
});
const scroll = (scrollValue, { animation = true } = {}) => {
if (animation) {
animate(scrollStart, tabsRef.current, scrollValue);
} else {
tabsRef.current[scrollStart] = scrollValue;
}
};
const moveTabsScroll = (delta) => {
let scrollValue = tabsRef.current[scrollStart];
if (vertical) {
scrollValue += delta;
} else {
scrollValue += delta * (isRtl ? -1 : 1);
// Fix for Edge
scrollValue *= isRtl && detectScrollType() === 'reverse' ? -1 : 1;
}
scroll(scrollValue);
};
const getScrollSize = () => {
const containerSize = tabsRef.current[clientSize];
let totalSize = 0;
const children = Array.from(tabListRef.current.children);
for (let i = 0; i < children.length; i += 1) {
const tab = children[i];
if (totalSize + tab[clientSize] > containerSize) {
break;
}
totalSize += tab[clientSize];
}
return totalSize;
};
const handleStartScrollClick = () => {
moveTabsScroll(-1 * getScrollSize());
};
const handleEndScrollClick = () => {
moveTabsScroll(getScrollSize());
};
// TODO Remove <ScrollbarSize /> as browser support for hidding the scrollbar
// with CSS improves.
const handleScrollbarSizeChange = React.useCallback((scrollbarWidth) => {
setScrollerStyle({
overflow: null,
scrollbarWidth,
});
}, []);
const getConditionalElements = () => {
const conditionalElements = {};
conditionalElements.scrollbarSizeListener = scrollable ? (
<ScrollbarSize
onChange={handleScrollbarSizeChange}
className={clsx(classes.scrollableX, classes.hideScrollbar)}
/>
) : null;
const scrollButtonsActive = displayScroll.start || displayScroll.end;
const showScrollButtons =
scrollable && ((scrollButtons === 'auto' && scrollButtonsActive) || scrollButtons === true);
conditionalElements.scrollButtonStart = showScrollButtons ? (
<ScrollButtonComponent
orientation={orientation}
direction={isRtl ? 'right' : 'left'}
onClick={handleStartScrollClick}
disabled={!displayScroll.start}
className={clsx(classes.scrollButtons, {
[classes.scrollButtonsHideMobile]: !allowScrollButtonsMobile,
})}
{...TabScrollButtonProps}
/>
) : null;
conditionalElements.scrollButtonEnd = showScrollButtons ? (
<ScrollButtonComponent
orientation={orientation}
direction={isRtl ? 'left' : 'right'}
onClick={handleEndScrollClick}
disabled={!displayScroll.end}
className={clsx(classes.scrollButtons, {
[classes.scrollButtonsHideMobile]: !allowScrollButtonsMobile,
})}
{...TabScrollButtonProps}
/>
) : null;
return conditionalElements;
};
const scrollSelectedIntoView = useEventCallback((animation) => {
const { tabsMeta, tabMeta } = getTabsMeta();
if (!tabMeta || !tabsMeta) {
return;
}
if (tabMeta[start] < tabsMeta[start]) {
// left side of button is out of view
const nextScrollStart = tabsMeta[scrollStart] + (tabMeta[start] - tabsMeta[start]);
scroll(nextScrollStart, { animation });
} else if (tabMeta[end] > tabsMeta[end]) {
// right side of button is out of view
const nextScrollStart = tabsMeta[scrollStart] + (tabMeta[end] - tabsMeta[end]);
scroll(nextScrollStart, { animation });
}
});
const updateScrollButtonState = useEventCallback(() => {
if (scrollable && scrollButtons !== false) {
const { scrollTop, scrollHeight, clientHeight, scrollWidth, clientWidth } = tabsRef.current;
let showStartScroll;
let showEndScroll;
if (vertical) {
showStartScroll = scrollTop > 1;
showEndScroll = scrollTop < scrollHeight - clientHeight - 1;
} else {
const scrollLeft = getNormalizedScrollLeft(tabsRef.current, theme.direction);
// use 1 for the potential rounding error with browser zooms.
showStartScroll = isRtl ? scrollLeft < scrollWidth - clientWidth - 1 : scrollLeft > 1;
showEndScroll = !isRtl ? scrollLeft < scrollWidth - clientWidth - 1 : scrollLeft > 1;
}
if (showStartScroll !== displayScroll.start || showEndScroll !== displayScroll.end) {
setDisplayScroll({ start: showStartScroll, end: showEndScroll });
}
}
});
React.useEffect(() => {
const handleResize = debounce(() => {
updateIndicatorState();
updateScrollButtonState();
});
const win = ownerWindow(tabsRef.current);
win.addEventListener('resize', handleResize);
return () => {
handleResize.clear();
win.removeEventListener('resize', handleResize);
};
}, [updateIndicatorState, updateScrollButtonState]);
const handleTabsScroll = React.useMemo(
() =>
debounce(() => {
updateScrollButtonState();
}),
[updateScrollButtonState],
);
React.useEffect(() => {
return () => {
handleTabsScroll.clear();
};
}, [handleTabsScroll]);
React.useEffect(() => {
setMounted(true);
}, []);
React.useEffect(() => {
updateIndicatorState();
updateScrollButtonState();
});
React.useEffect(() => {
// Don't animate on the first render.
scrollSelectedIntoView(defaultIndicatorStyle !== indicatorStyle);
}, [scrollSelectedIntoView, indicatorStyle]);
React.useImperativeHandle(
action,
() => ({
updateIndicator: updateIndicatorState,
updateScrollButtons: updateScrollButtonState,
}),
[updateIndicatorState, updateScrollButtonState],
);
const indicator = (
<TabIndicator
className={classes.indicator}
orientation={orientation}
color={indicatorColor}
{...TabIndicatorProps}
style={{
...indicatorStyle,
...TabIndicatorProps.style,
}}
/>
);
let childIndex = 0;
const children = React.Children.map(childrenProp, (child) => {
if (!React.isValidElement(child)) {
return null;
}
if (process.env.NODE_ENV !== 'production') {
if (isFragment(child)) {
console.error(
[
"Material-UI: The Tabs component doesn't accept a Fragment as a child.",
'Consider providing an array instead.',
].join('\n'),
);
}
}
const childValue = child.props.value === undefined ? childIndex : child.props.value;
valueToIndex.set(childValue, childIndex);
const selected = childValue === value;
childIndex += 1;
return React.cloneElement(child, {
fullWidth: variant === 'fullWidth',
indicator: selected && !mounted && indicator,
selected,
selectionFollowsFocus,
onChange,
textColor,
value: childValue,
...(childIndex === 1 && value === false && !child.props.tabIndex ? { tabIndex: 0 } : {}),
});
});
const handleKeyDown = (event) => {
const { target } = event;
// Keyboard navigation assumes that [role="tab"] are siblings
// though we might warn in the future about nested, interactive elements
// as a a11y violation
const role = target.getAttribute('role');
if (role !== 'tab') {
return;
}
let newFocusTarget = null;
let previousItemKey = orientation === 'horizontal' ? 'ArrowLeft' : 'ArrowUp';
let nextItemKey = orientation === 'horizontal' ? 'ArrowRight' : 'ArrowDown';
if (orientation === 'horizontal' && theme.direction === 'rtl') {
// swap previousItemKey with nextItemKey
previousItemKey = 'ArrowRight';
nextItemKey = 'ArrowLeft';
}
switch (event.key) {
case previousItemKey:
newFocusTarget = target.previousElementSibling || tabListRef.current.lastChild;
break;
case nextItemKey:
newFocusTarget = target.nextElementSibling || tabListRef.current.firstChild;
break;
case 'Home':
newFocusTarget = tabListRef.current.firstChild;
break;
case 'End':
newFocusTarget = tabListRef.current.lastChild;
break;
default:
break;
}
if (newFocusTarget !== null) {
newFocusTarget.focus();
event.preventDefault();
}
};
const conditionalElements = getConditionalElements();
return (
<Component
className={clsx(
classes.root,
{
[classes.vertical]: vertical,
},
className,
)}
ref={ref}
{...other}
>
{conditionalElements.scrollButtonStart}
{conditionalElements.scrollbarSizeListener}
<div
className={clsx(classes.scroller, {
[classes.fixed]: !scrollable,
[classes.hideScrollbar]: scrollable && !visibleScrollbar,
[classes.scrollableX]: scrollable && !vertical,
[classes.scrollableY]: scrollable && vertical,
})}
style={{
overflow: scrollerStyle.overflow,
[vertical ? `margin${isRtl ? 'Left' : 'Right'}` : 'marginBottom']: visibleScrollbar
? undefined
: -scrollerStyle.scrollbarWidth,
}}
ref={tabsRef}
onScroll={handleTabsScroll}
>
{/* The tablist isn't interactive but the tabs are */}
{/* eslint-disable-next-line jsx-a11y/interactive-supports-focus */}
<div
aria-label={ariaLabel}
aria-labelledby={ariaLabelledBy}
aria-orientation={orientation === 'vertical' ? 'vertical' : null}
className={clsx(classes.flexContainer, {
[classes.flexContainerVertical]: vertical,
[classes.centered]: centered && !scrollable,
})}
onKeyDown={handleKeyDown}
ref={tabListRef}
role="tablist"
>
{children}
</div>
{mounted && indicator}
</div>
{conditionalElements.scrollButtonEnd}
</Component>
);
});
Tabs.propTypes /* remove-proptypes */ = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the d.ts file and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* Callback fired when the component mounts.
* This is useful when you want to trigger an action programmatically.
* It supports two actions: `updateIndicator()` and `updateScrollButtons()`
*
* @param {object} actions This object contains all possible actions
* that can be triggered programmatically.
*/
action: refType,
/**
* If `true`, the scroll buttons aren't forced hidden on mobile.
* By default the scroll buttons are hidden on mobile and takes precedence over `scrollButtons`.
* @default false
*/
allowScrollButtonsMobile: PropTypes.bool,
/**
* The label for the Tabs as a string.
*/
'aria-label': PropTypes.string,
/**
* An id or list of ids separated by a space that label the Tabs.
*/
'aria-labelledby': PropTypes.string,
/**
* If `true`, the tabs are centered.
* This prop is intended for large views.
* @default false
*/
centered: PropTypes.bool,
/**
* The content of the component.
*/
children: PropTypes.node,
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
/**
* @ignore
*/
className: PropTypes.string,
/**
* The component used for the root node.
* Either a string to use a HTML element or a component.
*/
component: PropTypes.elementType,
/**
* Determines the color of the indicator.
* @default 'primary'
*/
indicatorColor: PropTypes.oneOf(['primary', 'secondary']),
/**
* Callback fired when the value changes.
*
* @param {object} event The event source of the callback. **Warning**: This is a generic event not a change event.
* @param {any} value We default to the index of the child (number)
*/
onChange: PropTypes.func,
/**
* The component orientation (layout flow direction).
* @default 'horizontal'
*/
orientation: PropTypes.oneOf(['horizontal', 'vertical']),
/**
* The component used to render the scroll buttons.
* @default TabScrollButton
*/
ScrollButtonComponent: PropTypes.elementType,
/**
* Determine behavior of scroll buttons when tabs are set to scroll:
*
* - `auto` will only present them when not all the items are visible.
* - `true` will always present them.
* - `false` will never present them.
*
* By default the scroll buttons are hidden on mobile.
* This behavior can be disabled with `allowScrollButtonsMobile`.
* @default 'auto'
*/
scrollButtons: PropTypes /* @typescript-to-proptypes-ignore */.oneOf(['auto', false, true]),
/**
* If `true` the selected tab changes on focus. Otherwise it only
* changes on activation.
*/
selectionFollowsFocus: PropTypes.bool,
/**
* Props applied to the tab indicator element.
* @default {}
*/
TabIndicatorProps: PropTypes.object,
/**
* Props applied to the [`TabScrollButton`](/api/tab-scroll-button/) element.
*/
TabScrollButtonProps: PropTypes.object,
/**
* Determines the color of the `Tab`.
* @default 'primary'
*/
textColor: PropTypes.oneOf(['inherit', 'primary', 'secondary']),
/**
* The value of the currently selected `Tab`.
* If you don't want any selected `Tab`, you can set this prop to `false`.
*/
value: PropTypes.any,
/**
* Determines additional display behavior of the tabs:
*
* - `scrollable` will invoke scrolling properties and allow for horizontally
* scrolling (or swiping) of the tab bar.
* -`fullWidth` will make the tabs grow to use all the available space,
* which should be used for small views, like on mobile.
* - `standard` will render the default state.
* @default 'standard'
*/
variant: PropTypes.oneOf(['fullWidth', 'scrollable', 'standard']),
/**
* If `true`, the scrollbar is visible. It can be useful when displaying
* a long vertical list of tabs.
* @default false
*/
visibleScrollbar: PropTypes.bool,
};
export default withStyles(styles, { name: 'MuiTabs' })(Tabs);