msyavuz commented on code in PR #34585: URL: https://github.com/apache/superset/pull/34585#discussion_r2259718909
########## superset-frontend/packages/superset-ui-core/src/components/DropdownContainer/DropdownContainer.tsx: ########## @@ -0,0 +1,395 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 { + cloneElement, + forwardRef, + RefObject, + useEffect, + useImperativeHandle, + useLayoutEffect, + useMemo, + useState, + useRef, + useCallback, +} from 'react'; + +import { Global } from '@emotion/react'; +import { css, t, useTheme, usePrevious } from '@superset-ui/core'; +import { useResizeDetector } from 'react-resize-detector'; +import { Badge, Icons, Button, Tooltip, Popover } from '..'; +import { DropdownContainerProps, DropdownItem, DropdownRef } from './types'; + +const MAX_HEIGHT = 500; + +export const DropdownContainer = forwardRef( + ( + { + items, + onOverflowingStateChange, + dropdownContent, + dropdownRef, + dropdownStyle = {}, + dropdownTriggerCount, + dropdownTriggerIcon, + dropdownTriggerText = t('More'), + dropdownTriggerTooltip = null, + forceRender, + style, + }: DropdownContainerProps, + outerRef: RefObject<DropdownRef>, + ) => { + const theme = useTheme(); + const { ref, width = 0 } = useResizeDetector<HTMLDivElement>(); + const previousWidth = usePrevious(width) || 0; + const { current } = ref; + const [itemsWidth, setItemsWidth] = useState<number[]>([]); + const [popoverVisible, setPopoverVisible] = useState(false); + // We use React.useState to be able to mock the state in Jest + const [overflowingIndex, setOverflowingIndex] = useState<number>(-1); + + let targetRef = useRef<HTMLDivElement>(null); + if (dropdownRef) { + targetRef = dropdownRef; + } + + const [showOverflow, setShowOverflow] = useState(false); + + // callback to update item widths so that the useLayoutEffect runs whenever + // width of any of the child changes + const recalculateItemWidths = useCallback(() => { + const mainItemsContainerNode = current?.children.item(0); + if (mainItemsContainerNode) { + const visibleChildrenElements = Array.from( + mainItemsContainerNode.children, + ); + setItemsWidth(prevGlobalWidths => { + if (prevGlobalWidths.length !== items.length) { + return prevGlobalWidths; + } + + const newGlobalWidths = [...prevGlobalWidths]; + let changed = false; + visibleChildrenElements.forEach((child, indexInVisible) => { + const originalItemIndex = indexInVisible; + if (originalItemIndex < newGlobalWidths.length) { + const newWidth = child.getBoundingClientRect().width; + if (newGlobalWidths[originalItemIndex] !== newWidth) { + newGlobalWidths[originalItemIndex] = newWidth; + changed = true; + } + } + }); + + return changed ? newGlobalWidths : prevGlobalWidths; + }); + } + }, [current?.children, items.length]); + + const reduceItems = (items: DropdownItem[]): [DropdownItem[], string[]] => + items.reduce( + ([items, ids], item) => { + items.push({ + id: item.id, + element: cloneElement(item.element, { key: item.id }), + }); + ids.push(item.id); + return [items, ids]; + }, + [[], []] as [DropdownItem[], string[]], + ); + + const [notOverflowedItems, notOverflowedIds] = useMemo( + () => + reduceItems( + items.slice( + 0, + overflowingIndex !== -1 ? overflowingIndex : items.length, + ), + ), + [items, overflowingIndex], + ); + + const [overflowedItems, overflowedIds] = useMemo( + () => + overflowingIndex !== -1 + ? reduceItems(items.slice(overflowingIndex)) + : [[], []], + [items, overflowingIndex], + ); + + useEffect(() => { + const container = current?.children.item(0); + if (!container) return; + + const childrenArray = Array.from(container.children); + + const resizeObserver = new ResizeObserver(() => { + recalculateItemWidths(); + }); + + childrenArray.map(child => resizeObserver.observe(child)); + + // eslint-disable-next-line consistent-return + return () => { + childrenArray.map(child => resizeObserver.unobserve(child)); + resizeObserver.disconnect(); + }; + }, [items.length, current, recalculateItemWidths]); + + useLayoutEffect(() => { + if (popoverVisible) { + return; + } + const container = current?.children.item(0); + if (container) { + const { children } = container; + const childrenArray = Array.from(children); + // If items length change, add all items to the container + // and recalculate the widths + if (itemsWidth.length !== items.length) { + if (childrenArray.length === items.length) { + setItemsWidth( + childrenArray.map(child => child.getBoundingClientRect().width), + ); + } else { + setOverflowingIndex(-1); + return; + } + } + + // Calculates the index of the first overflowed element + // +1 is to give at least one pixel of difference and avoid flakiness + const index = childrenArray.findIndex( + child => + child.getBoundingClientRect().right > + container.getBoundingClientRect().right + 1, + ); + + // If elements fit (-1) and there's overflowed items + // then preserve the overflow index. We can't use overflowIndex + // directly because the items may have been modified + let newOverflowingIndex = + index === -1 && overflowedItems.length > 0 + ? items.length - overflowedItems.length + : index; + + if (width > previousWidth) { + // Calculates remaining space in the container + const button = current?.children.item(1); + const buttonRight = button?.getBoundingClientRect().right || 0; + const containerRight = current?.getBoundingClientRect().right || 0; + const remainingSpace = containerRight - buttonRight; + + // Checks if some elements in the dropdown fits in the remaining space + let sum = 0; + for (let i = childrenArray.length; i < items.length; i += 1) { + sum += itemsWidth[i]; + if (sum <= remainingSpace) { + newOverflowingIndex = i + 1; + } else { + break; + } + } + } + + setOverflowingIndex(newOverflowingIndex); + } + }, [ + current, + items.length, + itemsWidth, + overflowedItems.length, + previousWidth, + width, + popoverVisible, + ]); + + useEffect(() => { + if (onOverflowingStateChange) { + onOverflowingStateChange({ + notOverflowed: notOverflowedIds, + overflowed: overflowedIds, + }); + } + }, [notOverflowedIds, onOverflowingStateChange, overflowedIds]); + + const overflowingCount = + overflowingIndex !== -1 ? items.length - overflowingIndex : 0; + + const popoverContent = useMemo( + () => + dropdownContent || overflowingCount ? ( + <div + css={css` + display: flex; + flex-direction: column; + gap: ${theme.sizeUnit * 4}px; + `} + data-test="dropdown-content" + style={dropdownStyle} + ref={targetRef} + > + {dropdownContent + ? dropdownContent(overflowedItems) + : overflowedItems.map(item => item.element)} + </div> + ) : null, + [ + dropdownContent, + overflowingCount, + theme.sizeUnit, + dropdownStyle, + overflowedItems, + ], + ); + + useLayoutEffect(() => { + if (popoverVisible) { + // Measures scroll height after rendering the elements + setTimeout(() => { + if (targetRef.current) { + // We only set overflow when there's enough space to display + // Select's popovers because they are restrained by the overflow property. + setShowOverflow(targetRef.current.scrollHeight > MAX_HEIGHT); + } + }, 100); + } + }, [popoverVisible]); + + useImperativeHandle( + outerRef, + () => ({ + ...(ref.current as HTMLDivElement), + open: () => setPopoverVisible(true), + }), + [ref], + ); + + // Closes the popover when scrolling on the document + useEffect(() => { + document.onscroll = popoverVisible + ? () => setPopoverVisible(false) + : null; + return () => { + document.onscroll = null; + }; + }, [popoverVisible]); + + return ( + <div + ref={ref} + css={css` + display: flex; + align-items: center; + `} + > + <div + css={css` + display: flex; + align-items: center; + gap: ${theme.sizeUnit * 4}px; + margin-right: ${theme.sizeUnit * 4}px; + min-width: 0px; + `} + data-test="container" + style={style} + > + {notOverflowedItems.map(item => item.element)} + </div> + {popoverContent && ( + <> + <Global + styles={css` + .ant-popover-inner { + // Some OS versions only show the scroll when hovering. + // These settings will make the scroll always visible. + ::-webkit-scrollbar { + -webkit-appearance: none; + width: 14px; + } + ::-webkit-scrollbar-thumb { + border-radius: 9px; + background-color: ${theme.colors.grayscale.light1}; + border: 3px solid transparent; + background-clip: content-box; + } + ::-webkit-scrollbar-track { + background-color: ${theme.colors.grayscale.light4}; + border-left: 1px solid ${theme.colors.grayscale.light2}; + } + } + `} + /> + + <Popover + styles={{ + body: { + maxHeight: `${MAX_HEIGHT}px`, + overflow: showOverflow ? 'auto' : 'visible', + }, + }} + content={popoverContent} + trigger="click" + open={popoverVisible} + onOpenChange={visible => setPopoverVisible(visible)} + placement="bottom" + forceRender={forceRender} + > + <Tooltip title={dropdownTriggerTooltip}> + <Button + buttonStyle="secondary" + data-test="dropdown-container-btn" + icon={dropdownTriggerIcon} + css={css` + padding-left: ${theme.paddingXS}px; + padding-right: ${theme.paddingXXS}px; + gap: ${theme.sizeXXS}px; + `} + > + {dropdownTriggerText} + <Badge + count={dropdownTriggerCount ?? overflowingCount} + color={ + (dropdownTriggerCount ?? overflowingCount) > 0 + ? theme.colorPrimary + : theme.colors.grayscale.light1 + } + showZero + css={css` + margin-left: ${theme.sizeUnit * 2}px; + `} + /> + <Icons.DownOutlined + iconSize="m" + iconColor={theme.colors.grayscale.light1} + css={css` + .anticon { + display: flex; + } + `} + /> + </Button> + </Tooltip> + </Popover> + </> + )} + </div> + ); + }, +); Review Comment: This change is for webpack build errors importing and exporting dropdown container types -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
