Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix tracks separator by migrating to Tanstack's virtual #708

Closed
wants to merge 1 commit into from
Closed

Fix tracks separator by migrating to Tanstack's virtual #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"@electron/remote": "^2.0.10",
"@radix-ui/react-popover": "^1.0.6",
"@radix-ui/react-slider": "^1.1.2",
"@tanstack/react-virtual": "3.0.0-beta.54",
"chardet": "^1.6.0",
"classnames": "^2.3.2",
"electron-store": "^8.1.0",
Expand All @@ -64,7 +65,6 @@
"react-fontawesome": "^1.7.1",
"react-keybinding-component": "^2.0.2",
"react-router-dom": "6.14.2",
"react-virtuoso": "^4.4.1",
"semver": "^7.5.4",
"svg-inline-react": "^3.2.1",
"zustand": "^4.3.9"
Expand Down
2 changes: 2 additions & 0 deletions src/renderer/components/TrackRow/TrackRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ type Props = {
onDragOver?: (trackId: string, position: 'above' | 'below') => void;
onDragEnd?: () => void;
onDrop?: (targetTrackId: string, position: 'above' | 'below') => void;
style?: React.CSSProperties;
};

export default function TrackRow(props: Props) {
Expand Down Expand Up @@ -122,6 +123,7 @@ export default function TrackRow(props: Props) {
onDragLeave={(draggable && onDragLeave) || undefined}
onDrop={(draggable && onDrop) || undefined}
onDragEnd={(draggable && props.onDragEnd) || undefined}
style={props.style}
{...(props.isPlaying ? { 'data-is-playing': true } : {})}
>
<div className={`${styles.cell} ${cellStyles.cellTrackPlaying}`}>
Expand Down
8 changes: 7 additions & 1 deletion src/renderer/components/TracksList/TracksList.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@
display: flex;
flex-direction: column;
flex: 1 1 auto;
height: 100%;
user-select: none;
}

.tracksListBody {
.tracksListScroller {
overflow: auto;
flex: 1 1 auto;
}

.tracksListRows {
width: 100%;
position: relative;
}

.tiles {
position: relative;
}
Expand Down
108 changes: 65 additions & 43 deletions src/renderer/components/TracksList/TracksList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { MenuItemConstructorOptions } from 'electron';
import React, { useCallback, useEffect, useRef, useState } from 'react';
import Keybinding from 'react-keybinding-component';
import { useNavigate } from 'react-router-dom';
import { Virtuoso, VirtuosoHandle } from 'react-virtuoso';
import { useVirtualizer } from '@tanstack/react-virtual';

import TrackRow from '../TrackRow/TrackRow';
import TracksListHeader from '../TracksListHeader/TracksListHeader';
Expand Down Expand Up @@ -55,32 +55,41 @@ export default function TracksList(props: Props) {

const [selected, setSelected] = useState<string[]>([]);
const [reordered, setReordered] = useState<string[] | null>([]);
const virtuosoRef = useRef<VirtuosoHandle>(null);
const navigate = useNavigate();

// The scrollable element for your list
const scrollableRef = useRef<HTMLDivElement>(null);

// The virtualizer
const virtualizer = useVirtualizer({
count: tracks.length,
overscan: 10,
getScrollElement: () => scrollableRef.current,
estimateSize: () => ROW_HEIGHT,
getItemKey: (index) => tracks[index]._id,
});

const playerAPI = usePlayerAPI();
const libraryAPI = useLibraryAPI();
const highlight = useLibraryStore((state) => state.highlightPlayingTrack);

// Highlight playing track and scroll to it
// Super-mega-hacky to use Redux for that
useEffect(() => {
if (highlight === true && trackPlayingId && virtuosoRef.current) {
if (highlight === true && trackPlayingId) {
setSelected([trackPlayingId]);

const playingTrackIndex = tracks.findIndex(
(track) => track._id === trackPlayingId,
);

if (playingTrackIndex >= 0) {
virtuosoRef.current.scrollToIndex({
index: playingTrackIndex,
});
virtualizer.scrollToIndex(playingTrackIndex, { behavior: 'smooth' });
}

libraryAPI.highlightPlayingTrack(false);
}
}, [highlight, trackPlayingId, tracks, libraryAPI]);
}, [highlight, trackPlayingId, tracks, libraryAPI, virtualizer]);

/**
* Helpers
Expand Down Expand Up @@ -117,12 +126,9 @@ export default function TracksList(props: Props) {
else newSelected = [tracks[addedIndex]._id];

setSelected(newSelected);

if (virtuosoRef.current) {
virtuosoRef.current.scrollIntoView({ index: addedIndex });
}
virtualizer.scrollToIndex(addedIndex);
},
[selected],
[selected, virtualizer],
);

const onDown = useCallback(
Expand All @@ -135,12 +141,9 @@ export default function TracksList(props: Props) {
else newSelected = [tracks[addedIndex]._id];

setSelected(newSelected);

if (virtuosoRef.current) {
virtuosoRef.current.scrollIntoView({ index: addedIndex });
}
virtualizer.scrollToIndex(addedIndex);
},
[selected],
[selected, virtualizer],
);

const onKey = useCallback(
Expand Down Expand Up @@ -485,32 +488,51 @@ export default function TracksList(props: Props) {
<div className={styles.tracksList}>
<Keybinding onKey={onKey} preventInputConflict />
<TracksListHeader enableSort={type === 'library'} />
<Virtuoso
ref={virtuosoRef}
data={tracks}
totalCount={tracks.length}
fixedItemHeight={ROW_HEIGHT}
className={styles.tracksListBody}
itemContent={(index, track) => {
return (
<TrackRow
selected={selected.includes(track._id)}
track={tracks[index]}
isPlaying={trackPlayingId === track._id}
index={index}
onMouseDown={selectTrack}
onClick={selectTrackClick}
onContextMenu={showContextMenu}
onDoubleClick={startPlayback}
draggable={reorderable}
reordered={(reordered && reordered.includes(track._id)) || false}
onDragStart={onReorderStart}
onDragEnd={onReorderEnd}
onDrop={onDrop}
/>
);
}}
/>
{/* Scrollable element */}
<div ref={scrollableRef} className={styles.tracksListScroller}>
{/* The large inner element to hold all of the items */}
<div
className={styles.tracksListRows}
style={{
height: `${virtualizer.getTotalSize()}px`,
width: '100%',
position: 'relative',
}}
>
{/* Only the visible items in the virtualizer, manually positioned to be in view */}
{virtualizer.getVirtualItems().map((virtualItem) => {
const track = tracks[virtualItem.index];
return (
<TrackRow
key={virtualItem.key}
selected={selected.includes(track._id)}
track={track}
isPlaying={trackPlayingId === track._id}
index={virtualItem.index}
onMouseDown={selectTrack}
onClick={selectTrackClick}
onContextMenu={showContextMenu}
onDoubleClick={startPlayback}
draggable={reorderable}
reordered={
(reordered && reordered.includes(track._id)) || false
}
onDragStart={onReorderStart}
onDragEnd={onReorderEnd}
onDrop={onDrop}
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: `${virtualItem.size}px`,
transform: `translateY(${virtualItem.start}px)`,
}}
/>
);
})}
</div>
</div>
</div>
);
}
17 changes: 12 additions & 5 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1252,6 +1252,18 @@
dependencies:
defer-to-connect "^2.0.0"

"@tanstack/react-virtual@3.0.0-beta.54":
version "3.0.0-beta.54"
resolved "https://registry.yarnpkg.com/@tanstack/react-virtual/-/react-virtual-3.0.0-beta.54.tgz#755979455adf13f2584937204a3f38703e446037"
integrity sha512-D1mDMf4UPbrtHRZZriCly5bXTBMhylslm4dhcHqTtDJ6brQcgGmk8YD9JdWBGWfGSWPKoh2x1H3e7eh+hgPXtQ==
dependencies:
"@tanstack/virtual-core" "3.0.0-beta.54"

"@tanstack/virtual-core@3.0.0-beta.54":
version "3.0.0-beta.54"
resolved "https://registry.yarnpkg.com/@tanstack/virtual-core/-/virtual-core-3.0.0-beta.54.tgz#12259d007911ad9fce1388385c54a9141f4ecdc4"
integrity sha512-jtkwqdP2rY2iCCDVAFuaNBH3fiEi29aTn2RhtIoky8DTTiCdc48plpHHreLwmv1PICJ4AJUUESaq3xa8fZH8+g==

"@tokenizer/token@^0.3.0":
version "0.3.0"
resolved "https://registry.yarnpkg.com/@tokenizer/token/-/token-0.3.0.tgz#fe98a93fe789247e998c75e74e9c7c63217aa276"
Expand Down Expand Up @@ -6262,11 +6274,6 @@ react-style-singleton@^2.2.1:
invariant "^2.2.4"
tslib "^2.0.0"

react-virtuoso@^4.4.1:
version "4.4.1"
resolved "https://registry.yarnpkg.com/react-virtuoso/-/react-virtuoso-4.4.1.tgz#43d7ac35346c4eba947b40858b375d5844b5ae9f"
integrity sha512-QrZ0JLnZFH8ltMw6q+S7U1+V2vUcSHzoIfLRzQKSv4nMJhEdjiZ+e9PqWCI7xJiy2AmSCAgo7g1V5osuurJo2Q==

react@^18.2.0:
version "18.2.0"
resolved "https://registry.yarnpkg.com/react/-/react-18.2.0.tgz#555bd98592883255fa00de14f1151a917b5d77d5"
Expand Down