|
| 1 | +import React, { |
| 2 | + type ChangeEvent, |
| 3 | + useCallback, |
| 4 | + useEffect, |
| 5 | + useMemo, |
| 6 | + useRef, |
| 7 | + useState, |
| 8 | +} from 'react'; |
| 9 | +import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; |
| 10 | +import { type IconDefinition } from '@fortawesome/fontawesome-svg-core'; |
| 11 | +import { Button } from '../Button'; |
| 12 | +import SearchInput from '../SearchInput'; |
| 13 | +import type { NavTabItem } from './NavTabList'; |
| 14 | +import './DashboardList.scss'; |
| 15 | +import { GLOBAL_SHORTCUTS } from '../shortcuts'; |
| 16 | + |
| 17 | +export interface DashboardListProps { |
| 18 | + onSelect: (tab: NavTabItem) => void; |
| 19 | + tabs?: NavTabItem[]; |
| 20 | +} |
| 21 | + |
| 22 | +/** |
| 23 | + * Display a search field and a list of dashboard tabs |
| 24 | + * @param props The tabs and handlers to use for this list |
| 25 | + * @returns A JSX element for the list of dashboard tabs, along with search |
| 26 | + */ |
| 27 | +export function DashboardList(props: DashboardListProps): JSX.Element { |
| 28 | + const { onSelect, tabs = [] } = props; |
| 29 | + const [searchText, setSearchText] = useState(''); |
| 30 | + const [focusedIndex, setFocusedIndex] = useState(0); |
| 31 | + const searchField = useRef<SearchInput>(null); |
| 32 | + const listRef = useRef<HTMLUListElement>(null); |
| 33 | + const itemRefs = useRef<(HTMLLIElement | null)[]>([]); |
| 34 | + |
| 35 | + useEffect(() => { |
| 36 | + if (searchField.current) { |
| 37 | + searchField.current.focus(); |
| 38 | + } |
| 39 | + }, []); |
| 40 | + |
| 41 | + useEffect(() => { |
| 42 | + setFocusedIndex(0); |
| 43 | + }, [searchText]); |
| 44 | + |
| 45 | + useEffect(() => { |
| 46 | + if (focusedIndex >= 0 && itemRefs.current[focusedIndex]) { |
| 47 | + itemRefs.current[focusedIndex]?.scrollIntoView({ |
| 48 | + behavior: 'smooth', |
| 49 | + block: 'nearest', |
| 50 | + }); |
| 51 | + } |
| 52 | + }, [focusedIndex]); |
| 53 | + |
| 54 | + const handleSearchChange = useCallback((e: ChangeEvent<HTMLInputElement>) => { |
| 55 | + setSearchText(e.target.value); |
| 56 | + }, []); |
| 57 | + |
| 58 | + const handleTabSelect = useCallback( |
| 59 | + (tab: NavTabItem) => { |
| 60 | + onSelect(tab); |
| 61 | + }, |
| 62 | + [onSelect] |
| 63 | + ); |
| 64 | + |
| 65 | + const filteredTabs = useMemo( |
| 66 | + () => |
| 67 | + tabs.filter(tab => |
| 68 | + tab.title.toLowerCase().includes(searchText.toLowerCase()) |
| 69 | + ), |
| 70 | + [searchText, tabs] |
| 71 | + ).sort((a, b) => a.title.localeCompare(b.title) ?? 0); |
| 72 | + |
| 73 | + const handleSearchKeyDown = useCallback( |
| 74 | + (event: React.KeyboardEvent) => { |
| 75 | + if (event.key === 'ArrowDown' && filteredTabs.length > 0) { |
| 76 | + event.preventDefault(); |
| 77 | + setFocusedIndex(prev => |
| 78 | + prev === -1 ? 0 : (prev + 1) % filteredTabs.length |
| 79 | + ); |
| 80 | + } else if (event.key === 'ArrowUp' && filteredTabs.length > 0) { |
| 81 | + event.preventDefault(); |
| 82 | + setFocusedIndex(prev => { |
| 83 | + if (prev === -1) return filteredTabs.length - 1; |
| 84 | + return (prev - 1 + filteredTabs.length) % filteredTabs.length; |
| 85 | + }); |
| 86 | + } else if (event.key === 'Enter' && filteredTabs.length > 0) { |
| 87 | + event.preventDefault(); |
| 88 | + const selectedIndex = focusedIndex >= 0 ? focusedIndex : 0; |
| 89 | + handleTabSelect(filteredTabs[selectedIndex]); |
| 90 | + } else if (event.key === 'Tab') { |
| 91 | + event.preventDefault(); |
| 92 | + } |
| 93 | + }, |
| 94 | + [filteredTabs, focusedIndex, handleTabSelect] |
| 95 | + ); |
| 96 | + |
| 97 | + const tabElements = useMemo( |
| 98 | + () => |
| 99 | + filteredTabs.map((tab, index) => ( |
| 100 | + <li |
| 101 | + key={tab.key} |
| 102 | + ref={(el: HTMLLIElement | null) => { |
| 103 | + itemRefs.current[index] = el; |
| 104 | + }} |
| 105 | + > |
| 106 | + <Button |
| 107 | + kind="ghost" |
| 108 | + data-testid={`dashboard-list-item-${tab.key ?? ''}-button`} |
| 109 | + onClick={() => handleTabSelect(tab)} |
| 110 | + className={focusedIndex === index ? 'focused' : ''} |
| 111 | + > |
| 112 | + {tab.icon ? ( |
| 113 | + <span className="dashboard-list-item-icon"> |
| 114 | + {React.isValidElement(tab.icon) ? ( |
| 115 | + tab.icon |
| 116 | + ) : ( |
| 117 | + <FontAwesomeIcon icon={tab.icon as IconDefinition} /> |
| 118 | + )} |
| 119 | + </span> |
| 120 | + ) : null} |
| 121 | + {tab.title} |
| 122 | + </Button> |
| 123 | + </li> |
| 124 | + )), |
| 125 | + [filteredTabs, handleTabSelect, focusedIndex] |
| 126 | + ); |
| 127 | + |
| 128 | + const errorElement = useMemo( |
| 129 | + () => |
| 130 | + tabElements.length === 0 ? <span>No open dashboard found.</span> : null, |
| 131 | + [tabElements] |
| 132 | + ); |
| 133 | + |
| 134 | + return ( |
| 135 | + <div className="dashboard-list-container d-flex flex-column"> |
| 136 | + <div className="dashboard-list-header"> |
| 137 | + <SearchInput |
| 138 | + value={searchText} |
| 139 | + placeholder="Find open dashboard" |
| 140 | + endPlaceholder={GLOBAL_SHORTCUTS.OPEN_DASHBOARD_SEARCH_MENU.getDisplayText()} |
| 141 | + onChange={handleSearchChange} |
| 142 | + onKeyDown={handleSearchKeyDown} |
| 143 | + ref={searchField} |
| 144 | + /> |
| 145 | + </div> |
| 146 | + <ul className="dashboard-list flex-grow-1" ref={listRef}> |
| 147 | + {errorElement && ( |
| 148 | + <li className="dashboard-list-message">{errorElement}</li> |
| 149 | + )} |
| 150 | + {!errorElement && tabElements} |
| 151 | + </ul> |
| 152 | + </div> |
| 153 | + ); |
| 154 | +} |
| 155 | + |
| 156 | +export default DashboardList; |
0 commit comments