optimize timezone dropdown with virtualization and memoization #9896
+273
−28
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,46 @@ | ||
| import { memoize } from 'lodash'; | ||
| import { getTimezoneOffset } from 'date-fns-tz'; | ||
| import { IANA_TIME_ZONES } from '@/localization/constants/IanaTimeZones'; | ||
| import { formatTimeZoneLabel } from '@/localization/utils/formatTimeZoneLabel'; | ||
| import { SelectOption } from '@/ui/input/components/Select'; | ||
|
|
||
| type TimezoneSelectOption = SelectOption<string> & { | ||
| offset: number; // Add the offset property | ||
| }; | ||
|
|
||
| export const createTimeZoneOptions = memoize(() => { | ||
| const timeZoneOptionsMap = IANA_TIME_ZONES.reduce<Record<string, TimezoneSelectOption>>( | ||
| (result, ianaTimeZone) => { | ||
| const timeZoneLabel = formatTimeZoneLabel(ianaTimeZone); | ||
| const timeZoneName = timeZoneLabel.slice(11); | ||
|
|
||
|
There was a problem hiding this comment. style: slicing at index 11 is fragile - consider using a regex or split() to extract the timezone name more reliably |
||
| if ( | ||
| timeZoneName.includes('GMT') || | ||
| timeZoneName.includes('UTC') || | ||
| timeZoneName.includes('UCT') || | ||
| timeZoneLabel in result | ||
| ) { | ||
| return result; | ||
| } | ||
|
|
||
| return { | ||
| ...result, | ||
| [timeZoneLabel]: { | ||
| label: timeZoneLabel, | ||
| value: ianaTimeZone, | ||
| // Pre-calculate offset to avoid doing it during sorting | ||
| offset: getTimezoneOffset(ianaTimeZone) | ||
| }, | ||
| }; | ||
| }, | ||
| {} | ||
| ); | ||
|
|
||
| return Object.values(timeZoneOptionsMap).sort((a, b) => { | ||
| const difference = a.offset - b.offset; | ||
| return difference === 0 ? a.label.localeCompare(b.label) : difference; | ||
| }); | ||
|
|
||
| }); | ||
|
|
||
| export const AVAILABLE_TIMEZONE_OPTIONS = createTimeZoneOptions(); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| import { SelectProps, SelectValue } from '@/ui/input/components/Select'; | ||
| import { SelectControl } from '@/ui/input/components/SelectControl'; | ||
| import { SelectHotkeyScope } from '@/ui/input/types/SelectHotkeyScope'; | ||
| import { Dropdown } from '@/ui/layout/dropdown/components/Dropdown'; | ||
| import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer'; | ||
| import { DropdownMenuSearchInput } from '@/ui/layout/dropdown/components/DropdownMenuSearchInput'; | ||
| import { DropdownMenuSeparator } from '@/ui/layout/dropdown/components/DropdownMenuSeparator'; | ||
| import { useDropdown } from '@/ui/layout/dropdown/hooks/useDropdown'; | ||
| import styled from '@emotion/styled'; | ||
| import { useVirtualizer } from '@tanstack/react-virtual'; | ||
| import { useEffect, useMemo, useRef, useState } from 'react'; | ||
| import { isDefined, MenuItem, MenuItemSelect } from 'twenty-ui'; | ||
|
|
||
| interface VirtualizedSelectProps<T extends SelectValue> extends Omit<SelectProps<T>, 'dropdownComponents'> { | ||
| itemHeight: number; | ||
| maxHeight: number; | ||
| } | ||
|
|
||
| const StyledContainer = styled.div<{ fullWidth?: boolean }>` | ||
| width: ${({ fullWidth }) => (fullWidth ? '100%' : 'auto')}; | ||
| `; | ||
|
|
||
| const StyledLabel = styled.span` | ||
| color: ${({ theme }) => theme.font.color.light}; | ||
| display: block; | ||
| font-size: ${({ theme }) => theme.font.size.xs}; | ||
| font-weight: ${({ theme }) => theme.font.weight.semiBold}; | ||
| margin-bottom: ${({ theme }) => theme.spacing(1)}; | ||
| `; | ||
|
|
||
| const StyledScrollContainer = styled.div<{ maxHeight: number }>` | ||
| max-height: ${({ maxHeight }) => maxHeight}px; | ||
| overflow-y: auto; | ||
| `; | ||
|
|
||
| export const VirtualizedSelect = <T extends SelectValue,>({ | ||
| className = '', | ||
| disabled: disabledFromProps, | ||
| fullWidth = false, | ||
| label = '', | ||
| options, | ||
| itemHeight, | ||
| maxHeight, | ||
| value, | ||
| onChange, | ||
| dropdownId, | ||
| dropdownWidth = 176, | ||
| selectSizeVariant, | ||
| needIconCheck, | ||
| onBlur, | ||
| callToActionButton, | ||
| emptyOption, | ||
| withSearchInput, | ||
| dropdownWidthAuto, | ||
| }: VirtualizedSelectProps<T>) => { | ||
| const [searchInputValue, setSearchInputValue] = useState(''); | ||
| const [isOpen, setIsOpen] = useState(false); | ||
| const selectContainerRef = useRef<HTMLDivElement>(null); | ||
| const parentRef = useRef<HTMLDivElement>(null); | ||
| const { closeDropdown } = useDropdown(dropdownId); | ||
|
|
||
| const filteredOptions = useMemo( | ||
| () => | ||
| searchInputValue | ||
| ? options.filter(({ label }) => | ||
| label.toLowerCase().includes(searchInputValue.toLowerCase()), | ||
| ) | ||
| : options, | ||
| [options, searchInputValue], | ||
| ); | ||
|
|
||
| const rowVirtualizer = useVirtualizer({ | ||
| count: filteredOptions.length, | ||
| getScrollElement: () => parentRef.current, | ||
| estimateSize: () => itemHeight, | ||
| overscan: 5, | ||
| }); | ||
|
Comment on lines
+72
to
+77
There was a problem hiding this comment. style: overscan value of 5 may be too low for smooth scrolling with variable height items. Consider increasing to 10-20 for better performance |
||
|
|
||
| useEffect(() => { | ||
| if (isOpen && parentRef.current) { | ||
| parentRef.current.scrollTop = 0; | ||
| } | ||
| }, [isOpen, searchInputValue]); | ||
|
|
||
| const selectedOption = options.find((opt) => opt.value === value) || options[0]; | ||
|
|
||
| const isDisabled = | ||
| disabledFromProps || | ||
| (options.length <= 1 && | ||
| !isDefined(callToActionButton) && | ||
| (!isDefined(emptyOption) || selectedOption !== emptyOption)); | ||
|
|
||
| const dropDownMenuWidth = | ||
| dropdownWidthAuto && selectContainerRef.current?.clientWidth | ||
| ? selectContainerRef.current?.clientWidth | ||
| : dropdownWidth; | ||
|
|
||
| return ( | ||
| <StyledContainer | ||
| className={className} | ||
| fullWidth={fullWidth} | ||
| tabIndex={0} | ||
| onBlur={onBlur} | ||
| ref={selectContainerRef} | ||
| > | ||
| {!!label && <StyledLabel>{label}</StyledLabel>} | ||
| {isDisabled ? ( | ||
| <SelectControl | ||
| selectedOption={selectedOption} | ||
| isDisabled={isDisabled} | ||
| selectSizeVariant={selectSizeVariant} | ||
| /> | ||
| ) : ( | ||
| <Dropdown | ||
| dropdownId={dropdownId} | ||
| dropdownMenuWidth={dropDownMenuWidth} | ||
| dropdownPlacement="bottom-start" | ||
| onOpen={() => setIsOpen(true)} | ||
| onClose={() => { | ||
| setIsOpen(false); | ||
| setSearchInputValue(''); | ||
| }} | ||
| clickableComponent={ | ||
| <SelectControl | ||
| selectedOption={selectedOption} | ||
| isDisabled={isDisabled} | ||
| selectSizeVariant={selectSizeVariant} | ||
| /> | ||
| } | ||
| dropdownComponents={ | ||
| <> | ||
| {withSearchInput && ( | ||
| <> | ||
| <DropdownMenuSearchInput | ||
| autoFocus | ||
| value={searchInputValue} | ||
| onChange={(event) => setSearchInputValue(event.target.value)} | ||
| /> | ||
| <DropdownMenuSeparator /> | ||
| </> | ||
| )} | ||
| <StyledScrollContainer ref={parentRef} maxHeight={maxHeight}> | ||
| <div | ||
| style={{ | ||
| height: `${rowVirtualizer.getTotalSize()}px`, | ||
| width: '100%', | ||
| position: 'relative', | ||
| }} | ||
| > | ||
| {rowVirtualizer.getVirtualItems().map((virtualRow) => { | ||
| const option = filteredOptions[virtualRow.index]; | ||
| return ( | ||
| <div | ||
| key={virtualRow.key} | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| transform: `translateY(${virtualRow.start}px)`, | ||
| }} | ||
| > | ||
| <MenuItemSelect | ||
| LeftIcon={option.Icon} | ||
| text={option.label} | ||
| selected={selectedOption.value === option.value} | ||
| needIconCheck={needIconCheck} | ||
| onClick={() => { | ||
| onChange?.(option.value); | ||
| onBlur?.(); | ||
| closeDropdown(); | ||
| }} | ||
| /> | ||
| </div> | ||
| ); | ||
| })} | ||
| </div> | ||
| </StyledScrollContainer> | ||
| {callToActionButton && filteredOptions.length > 0 && ( | ||
| <> | ||
| <DropdownMenuSeparator /> | ||
| <DropdownMenuItemsContainer hasMaxHeight={false} scrollable={false}> | ||
| <MenuItem | ||
| onClick={callToActionButton.onClick} | ||
| LeftIcon={callToActionButton.Icon} | ||
| text={callToActionButton.text} | ||
| /> | ||
| </DropdownMenuItemsContainer> | ||
| </> | ||
| )} | ||
| </> | ||
| } | ||
| dropdownHotkeyScope={{ scope: SelectHotkeyScope.Select }} | ||
| /> | ||
| )} | ||
| </StyledContainer> | ||
| ); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: memoizing this function won't help with performance since it's only called once at module initialization - the AVAILABLE_TIMEZONE_OPTIONS constant already serves as a cache