/* Copyright (c) Microsoft Corporation. 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 * as React from 'react'; import './listView.css'; export type ListViewProps = { name: string, items: T[], id?: (item: T, index: number) => string, render: (item: T, index: number) => React.ReactNode, icon?: (item: T, index: number) => string | undefined, indent?: (item: T, index: number) => number | undefined, isError?: (item: T, index: number) => boolean, isWarning?: (item: T, index: number) => boolean, isInfo?: (item: T, index: number) => boolean, selectedItem?: T, onAccepted?: (item: T, index: number) => void, onSelected?: (item: T, index: number) => void, onLeftArrow?: (item: T, index: number) => void, onRightArrow?: (item: T, index: number) => void, onHighlighted?: (item: T | undefined) => void, onIconClicked?: (item: T, index: number) => void, noItemsMessage?: string, dataTestId?: string, noHighlightOnHover?: boolean, }; const scrollPositions = new Map(); export function ListView({ name, items = [], id, render, icon, isError, isWarning, isInfo, indent, selectedItem, onAccepted, onSelected, onLeftArrow, onRightArrow, onHighlighted, onIconClicked, noItemsMessage, dataTestId, noHighlightOnHover, }: ListViewProps) { const itemListRef = React.useRef(null); const [highlightedItem, setHighlightedItem] = React.useState(); React.useEffect(() => { onHighlighted?.(highlightedItem); }, [onHighlighted, highlightedItem]); React.useEffect(() => { const listElem = itemListRef.current; if (!listElem) return; const saveScrollPosition = () => { scrollPositions.set(name, listElem.scrollTop); }; listElem.addEventListener('scroll', saveScrollPosition, { passive: true }); return () => listElem.removeEventListener('scroll', saveScrollPosition); }, [name]); React.useEffect(() => { if (itemListRef.current) itemListRef.current.scrollTop = scrollPositions.get(name) || 0; }, [name]); return
0 ? 'list' : undefined} data-testid={dataTestId || (name + '-list')}>
selectedItem && onAccepted?.(selectedItem, items.indexOf(selectedItem))} onKeyDown={event => { if (selectedItem && event.key === 'Enter') { onAccepted?.(selectedItem, items.indexOf(selectedItem)); return; } if (event.key !== 'ArrowDown' && event.key !== 'ArrowUp' && event.key !== 'ArrowLeft' && event.key !== 'ArrowRight') return; event.stopPropagation(); event.preventDefault(); if (selectedItem && event.key === 'ArrowLeft') { onLeftArrow?.(selectedItem, items.indexOf(selectedItem)); return; } if (selectedItem && event.key === 'ArrowRight') { onRightArrow?.(selectedItem, items.indexOf(selectedItem)); return; } const index = selectedItem ? items.indexOf(selectedItem) : -1; let newIndex = index; if (event.key === 'ArrowDown') { if (index === -1) newIndex = 0; else newIndex = Math.min(index + 1, items.length - 1); } if (event.key === 'ArrowUp') { if (index === -1) newIndex = items.length - 1; else newIndex = Math.max(index - 1, 0); } const element = itemListRef.current?.children.item(newIndex); scrollIntoViewIfNeeded(element || undefined); onHighlighted?.(undefined); onSelected?.(items[newIndex], newIndex); }} ref={itemListRef} > {noItemsMessage && items.length === 0 &&
{noItemsMessage}
} {items.map((item, index) => { const selectedSuffix = selectedItem === item ? ' selected' : ''; const highlightedSuffix = !noHighlightOnHover && highlightedItem === item ? ' highlighted' : ''; const errorSuffix = isError?.(item, index) ? ' error' : ''; const warningSuffix = isWarning?.(item, index) ? ' warning' : ''; const infoSuffix = isInfo?.(item, index) ? ' info' : ''; const indentation = indent?.(item, index) || 0; const rendered = render(item, index); return
onSelected?.(item, index)} onMouseEnter={() => setHighlightedItem(item)} onMouseLeave={() => setHighlightedItem(undefined)} > {indentation ? new Array(indentation).fill(0).map(() =>
) : undefined} {icon &&
{ e.preventDefault(); e.stopPropagation(); }} onClick={e => { e.stopPropagation(); e.preventDefault(); onIconClicked?.(item, index); }} >
} {typeof rendered === 'string' ?
{rendered}
: rendered}
; })}
; } function scrollIntoViewIfNeeded(element: Element | undefined) { if (!element) return; if ((element as any)?.scrollIntoViewIfNeeded) (element as any).scrollIntoViewIfNeeded(false); else element?.scrollIntoView(); }