|
| 1 | +import React, { ReactNode, useEffect } from 'react'; |
| 2 | +import * as Tabs from '@radix-ui/react-tabs'; |
| 3 | +import { throttle } from 'es-toolkit/compat'; |
| 4 | +import cn from 'src/utilities/cn'; |
| 5 | + |
| 6 | +type TabTriggerContent = string | { label: string; disabled?: boolean } | ReactNode; |
| 7 | + |
| 8 | +/** |
| 9 | + * Props for the TabMenu component. |
| 10 | + */ |
| 11 | + |
| 12 | +export type TabMenuProps = { |
| 13 | + /** |
| 14 | + * An array of tabs, which can be either a string or an object with a label and an optional disabled state. |
| 15 | + */ |
| 16 | + tabs: TabTriggerContent[]; |
| 17 | + |
| 18 | + /** |
| 19 | + * An optional array of React nodes representing the content for each tab. |
| 20 | + */ |
| 21 | + contents?: ReactNode[]; |
| 22 | + |
| 23 | + /** |
| 24 | + * An optional callback function that is called when a tab is clicked, receiving the index of the clicked tab. |
| 25 | + */ |
| 26 | + tabOnClick?: (index: number) => void; |
| 27 | + |
| 28 | + /** |
| 29 | + * An optional class name to apply to each tab. |
| 30 | + */ |
| 31 | + tabClassName?: string; |
| 32 | + |
| 33 | + /** |
| 34 | + * An optional class name to apply to the Tabs.Root element. |
| 35 | + */ |
| 36 | + rootClassName?: string; |
| 37 | + |
| 38 | + /** |
| 39 | + * An optional class name to apply to the Tabs.Content element. |
| 40 | + */ |
| 41 | + contentClassName?: string; |
| 42 | + |
| 43 | + /** |
| 44 | + * Optional configuration options for the TabMenu. |
| 45 | + */ |
| 46 | + options?: { |
| 47 | + /** |
| 48 | + * The index of the tab that should be selected by default. |
| 49 | + */ |
| 50 | + defaultTabIndex?: number; |
| 51 | + |
| 52 | + /** |
| 53 | + * Whether to show an underline below the selected tab. |
| 54 | + */ |
| 55 | + underline?: boolean; |
| 56 | + |
| 57 | + /** |
| 58 | + * Whether to animate the transition between tabs. |
| 59 | + */ |
| 60 | + animated?: boolean; |
| 61 | + |
| 62 | + /** |
| 63 | + * Whether the tab width should be flexible. |
| 64 | + */ |
| 65 | + flexibleTabWidth?: boolean; |
| 66 | + |
| 67 | + /** |
| 68 | + * Whether the tab height should be flexible. |
| 69 | + */ |
| 70 | + flexibleTabHeight?: boolean; |
| 71 | + }; |
| 72 | +}; |
| 73 | + |
| 74 | +const DEFAULT_TAILWIND_ANIMATION_DURATION = 150; |
| 75 | + |
| 76 | +const TabMenu: React.FC<TabMenuProps> = ({ |
| 77 | + tabs = [], |
| 78 | + contents = [], |
| 79 | + tabOnClick, |
| 80 | + tabClassName, |
| 81 | + rootClassName, |
| 82 | + contentClassName, |
| 83 | + options, |
| 84 | +}) => { |
| 85 | + const { |
| 86 | + defaultTabIndex = 0, |
| 87 | + underline = true, |
| 88 | + animated: animatedOption = true, |
| 89 | + flexibleTabWidth = false, |
| 90 | + flexibleTabHeight = false, |
| 91 | + } = options ?? {}; |
| 92 | + |
| 93 | + const listRef = React.useRef<HTMLDivElement>(null); |
| 94 | + const [animated, setAnimated] = React.useState(false); |
| 95 | + const [highlight, setHighlight] = React.useState({ offset: 0, width: 0 }); |
| 96 | + |
| 97 | + useEffect(() => { |
| 98 | + if (animatedOption && highlight.width > 0) { |
| 99 | + setTimeout(() => { |
| 100 | + setAnimated(true); |
| 101 | + }, DEFAULT_TAILWIND_ANIMATION_DURATION); |
| 102 | + } |
| 103 | + }, [animatedOption, highlight.width]); |
| 104 | + |
| 105 | + const updateHighlightDimensions = (element: HTMLButtonElement) => { |
| 106 | + const { left: parentLeft } = listRef.current?.getBoundingClientRect() ?? {}; |
| 107 | + const { left, width } = element.getBoundingClientRect() ?? {}; |
| 108 | + |
| 109 | + setHighlight({ |
| 110 | + offset: (left ?? 0) - (parentLeft ?? 0), |
| 111 | + width: width ?? 0, |
| 112 | + }); |
| 113 | + }; |
| 114 | + |
| 115 | + useEffect(() => { |
| 116 | + const handleResize = throttle(() => { |
| 117 | + const activeTabElement = listRef.current?.querySelector<HTMLButtonElement>(`[data-state="active"]`); |
| 118 | + |
| 119 | + if (activeTabElement) { |
| 120 | + updateHighlightDimensions(activeTabElement); |
| 121 | + } |
| 122 | + }, 100); |
| 123 | + |
| 124 | + handleResize(); |
| 125 | + |
| 126 | + window.addEventListener('resize', handleResize); |
| 127 | + |
| 128 | + return () => { |
| 129 | + window.removeEventListener('resize', handleResize); |
| 130 | + }; |
| 131 | + }, []); |
| 132 | + |
| 133 | + const handleTabClick = (event: React.MouseEvent<HTMLButtonElement>, index: number) => { |
| 134 | + tabOnClick?.(index); |
| 135 | + updateHighlightDimensions(event.currentTarget as HTMLButtonElement); |
| 136 | + }; |
| 137 | + |
| 138 | + const tabTriggerContent = (tab: TabTriggerContent) => { |
| 139 | + if (!tab) { |
| 140 | + return null; |
| 141 | + } |
| 142 | + |
| 143 | + if (React.isValidElement(tab) || typeof tab === 'string') { |
| 144 | + return tab; |
| 145 | + } |
| 146 | + |
| 147 | + if (typeof tab === 'object' && 'label' in tab) { |
| 148 | + return tab.label; |
| 149 | + } |
| 150 | + |
| 151 | + return null; |
| 152 | + }; |
| 153 | + |
| 154 | + return ( |
| 155 | + <Tabs.Root defaultValue={`tab-${defaultTabIndex}`} className={cn({ 'h-full': flexibleTabHeight }, rootClassName)}> |
| 156 | + <Tabs.List |
| 157 | + ref={listRef} |
| 158 | + className={cn( |
| 159 | + 'relative', |
| 160 | + { |
| 161 | + 'flex border-b border-neutral-300 dark:border-neutral-1000': underline, |
| 162 | + }, |
| 163 | + { 'h-full': flexibleTabHeight }, |
| 164 | + )} |
| 165 | + > |
| 166 | + {tabs.map( |
| 167 | + (tab, index) => |
| 168 | + tab && ( |
| 169 | + <Tabs.Trigger |
| 170 | + key={`tab-${index}`} |
| 171 | + className={cn( |
| 172 | + 'lg:px-6 md:px-5 px-4 py-4 ui-text-label1 font-bold data-[state=active]:text-neutral-1300 text-neutral-1000 dark:data-[state=active]:text-neutral-000 dark:text-neutral-300 focus:outline-none focus-visible:outline-gui-focus transition-colors hover:text-neutral-1300 dark:hover:text-neutral-000 active:text-neutral-900 dark:active:text-neutral-400 disabled:text-gui-disabled-light dark:disabled:text-gui-disabled-dark disabled:cursor-not-allowed', |
| 173 | + { 'flex-1': flexibleTabWidth }, |
| 174 | + { 'h-full': flexibleTabHeight }, |
| 175 | + tabClassName, |
| 176 | + )} |
| 177 | + value={`tab-${index}`} |
| 178 | + onClick={(event) => handleTabClick(event, index)} |
| 179 | + disabled={typeof tab === 'object' && 'disabled' in tab ? tab.disabled : false} |
| 180 | + > |
| 181 | + {tabTriggerContent(tab)} |
| 182 | + </Tabs.Trigger> |
| 183 | + ), |
| 184 | + )} |
| 185 | + <div |
| 186 | + className={cn('absolute bottom-0 bg-neutral-1300 dark:bg-neutral-000 h-[0.1875rem] w-6', { |
| 187 | + 'transition-[transform,width]': animated, |
| 188 | + })} |
| 189 | + style={{ |
| 190 | + transform: `translateX(${highlight.offset}px)`, |
| 191 | + width: `${highlight.width}px`, |
| 192 | + }} |
| 193 | + ></div> |
| 194 | + </Tabs.List> |
| 195 | + {contents.map((content, index) => ( |
| 196 | + <Tabs.Content key={`tab-${index}`} value={`tab-${index}`} className={contentClassName}> |
| 197 | + {content} |
| 198 | + </Tabs.Content> |
| 199 | + ))} |
| 200 | + </Tabs.Root> |
| 201 | + ); |
| 202 | +}; |
| 203 | + |
| 204 | +export default TabMenu; |
0 commit comments