feat: virtualize the Tokens list #37589
+198
−53
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -2,7 +2,9 @@ import React, { useContext, useEffect, useMemo } from 'react'; | |
| import { useSelector } from 'react-redux'; | ||
| import { type CaipChainId, type Hex } from '@metamask/utils'; | ||
| import { NON_EVM_TESTNET_IDS } from '@metamask/multichain-network-controller'; | ||
| import { useVirtualizer } from '@tanstack/react-virtual'; | ||
| import TokenCell from '../token-cell'; | ||
| import { ASSET_CELL_HEIGHT } from '../constants'; | ||
| import { | ||
| getEnabledNetworksByNamespace, | ||
| getIsMultichainAccountsState2Enabled, | ||
|
|
@@ -36,6 +38,7 @@ import { SafeChain } from '../../../../pages/settings/networks-tab/networks-form | |
| import { isGlobalNetworkSelectorRemoved } from '../../../../selectors/selectors'; | ||
| import { isEvmChainId } from '../../../../../shared/lib/asset-utils'; | ||
| import { sortAssetsWithPriority } from '../util/sortAssetsWithPriority'; | ||
| import { useScrollContainer } from '../../../../contexts/scroll-container'; | ||
|
|
||
| type TokenListProps = { | ||
| onTokenClick: (chainId: string, address: string) => void; | ||
|
|
@@ -45,6 +48,7 @@ type TokenListProps = { | |
| // TODO: Fix in https://github.com/MetaMask/metamask-extension/issues/31860 | ||
| // eslint-disable-next-line @typescript-eslint/naming-convention | ||
| function TokenList({ onTokenClick, safeChains }: TokenListProps) { | ||
| const scrollContainerRef = useScrollContainer(); | ||
|
Contributor
Author
There was a problem hiding this comment.
|
||
| const isEvm = useSelector(getIsEvmMultichainNetworkSelected); | ||
| const newTokensImported = useSelector(getNewTokensImported); | ||
| const currentNetwork = useSelector(getSelectedMultichainNetworkConfiguration); | ||
|
|
@@ -145,6 +149,13 @@ function TokenList({ onTokenClick, safeChains }: TokenListProps) { | |
| allEnabledNetworksForAllNamespaces, | ||
| ]); | ||
|
|
||
| const virtualizer = useVirtualizer({ | ||
n3ps marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| count: sortedFilteredTokens.length, | ||
| getScrollElement: () => scrollContainerRef?.current || null, | ||
| estimateSize: () => ASSET_CELL_HEIGHT, | ||
|
Contributor
There was a problem hiding this comment. How does this fair with responsive design (increase/decrease window size/font size) |
||
| overscan: 5, | ||
| }); | ||
n3ps marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| useEffect(() => { | ||
| if (sortedFilteredTokens) { | ||
| endTrace({ name: TraceName.AccountOverviewAssetListTab }); | ||
|
|
@@ -179,24 +190,39 @@ function TokenList({ onTokenClick, safeChains }: TokenListProps) { | |
| }); | ||
| }; | ||
|
|
||
| const virtualItems = virtualizer.getVirtualItems(); | ||
|
|
||
| return ( | ||
| <div | ||
|
Contributor
There was a problem hiding this comment. Since we might want to reuse tanstack virtual for other areas, can we create a custom component that abstracts away some of these steps? const VirtualScrollView = (...) => {
// Step 2...
const virtualiser = useVirtualiser({ ... })
// Step 3...
return (
<div ...>
{/* Step 4... */}
virtualItems.map(virtualItem => {
return (
<div ...>
{renderItem({ item, virtualItem })}
</div>
)
})
</div>
)
}
Contributor
There was a problem hiding this comment. Something I did a while ago (never merged)
Contributor
Author
There was a problem hiding this comment. Eventually, we can abstract this once we get to see usage patterns from other tabs, so that the API and props match our needs. |
||
| className="relative w-full" | ||
| style={{ | ||
| height: `${virtualizer.getTotalSize()}px`, | ||
| }} | ||
| > | ||
| {virtualItems.map((virtualItem) => { | ||
| const token = sortedFilteredTokens[virtualItem.index]; | ||
| const isNonEvmTestnet = NON_EVM_TESTNET_IDS.includes( | ||
| token.chainId as CaipChainId, | ||
| ); | ||
|
|
||
| return ( | ||
| <div | ||
|
Contributor
Author
There was a problem hiding this comment.
|
||
| key={`${token.chainId}-${token.symbol}-${token.address}`} | ||
| className="absolute top-0 left-0 w-full" | ||
| style={{ | ||
| transform: `translateY(${virtualItem.start}px)`, | ||
| }} | ||
| > | ||
| <TokenCell | ||
| token={token} | ||
| privacyMode={privacyMode} | ||
| onClick={isNonEvmTestnet ? undefined : handleTokenClick(token)} | ||
| safeChains={safeChains} | ||
| /> | ||
| </div> | ||
| ); | ||
| })} | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or 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,35 @@ | ||
| import React, { createContext, useContext, useRef } from 'react'; | ||
|
|
||
| const ScrollContainerContext = | ||
| createContext<React.RefObject<HTMLDivElement> | null>(null); | ||
|
|
||
| /** | ||
| * Provides a ref to this container element for its child components | ||
| * | ||
| * @param props - HTML div attributes | ||
| * @param props.children - Child components to render inside the container | ||
| * @returns A div element with a ref accessible via useScrollContainer | ||
| */ | ||
| export const ScrollContainer = ({ | ||
| children, | ||
| ...props | ||
| }: React.HTMLAttributes<HTMLDivElement>) => { | ||
| const scrollRef = useRef<HTMLDivElement>(null); | ||
|
|
||
| return ( | ||
| <ScrollContainerContext.Provider value={scrollRef}> | ||
| <div ref={scrollRef} {...props}> | ||
| {children} | ||
| </div> | ||
| </ScrollContainerContext.Provider> | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * Hook to access the scroll container ref from any child component | ||
| * | ||
| * @returns Ref to the scroll container | ||
| */ | ||
| export const useScrollContainer = () => { | ||
| return useContext(ScrollContainerContext); | ||
| }; |
This file contains hidden or 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 hidden or 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.
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.
Adding virtualisation library. To investigate the
documentglobal property usage.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.
From light inspection, seems to be used in the libraries examples. Uses
document.getElementById.https://github.com/search?q=repo%3ATanStack%2Fvirtual%20document.&type=code