Files
Psychotoxical-psysonic/src/hooks/useAlbumGridBrowseFilters.ts
T
cucadmuh 4ac373a65b feat(search): scoped live search on browse pages (#938)
* feat(artists): scoped live search badge replaces page filter

Move Artists browse text search into the header Live Search with a page
scope badge (Users icon), field-local undo, and double-click/backspace
to clear scope. Block the live-search dropdown while scoped so results
only filter the Artists grid; mobile overlay follows the same rules.

* fix(artists): plain grid for scoped search fixes broken card layout

Route the browse grid through VirtualCardGrid, switch to non-virtual CSS
grid when live search filters the catalog, reset scroll on filter changes,
and skip content-visibility on plain tiles to avoid blank/black cards.

* fix(search): scope badge double-Backspace and single clear control

Require two Backspaces on an empty scoped field after prior text input;
one Backspace still clears the badge when the field was never filled.
Move live-search clear/advanced controls inside the field pill, drop the
extra outer clear button, and use type=text to avoid native search clears.

* fix(search): drop duplicate outer live-search clear button

Keep the native in-field clear on type=search and the original pill layout;
remove only the extra × control outside the search border. Reset dropdown
state when the query is cleared via the native control.

* refactor(search): generic scoped browse query helper, drop dead code

Rename artistsBrowseSearchQuery to scopedBrowseSearchQuery with an
expectedScope argument; wire Artists via useScopedBrowseSearchQuery.
Remove unused liveSearchScoped dropdown helper (scoped mode blocks it).

* feat(search): ghost scope badge and single-click badge remove

After clearing the artists scope on /artists, show a faded ghost chip to
restore page-only search while keeping the global search placeholder.
Active badge removes on one click; tooltips and styles updated.

* feat(search): scoped live search for All Albums and New Releases

Wire albums and newReleases scope badges with debounced album title search
(local index title-only FTS + filtered search3). Plain grid, scroll reset,
and session query restore on album grid browse pages.

* fix(browse): preserve scroll restore after album/artist detail back

Only reset in-page scroll when filter resetKey changes, not when
isScrollRestorePending clears after session restore.

* feat(search): scoped live search for Tracks browse

Wire /tracks to header live search with wide title/artist/album FTS,
hide hero and discovery rails while search is active, and remove the
inline search field from the browse list.

* fix(search): clear header query when leaving scoped browse pages

Prevent global live search from firing on album/detail routes after a
scoped browse query; browse session stashes still restore on back.

* fix(tracks): restore scroll after back from detail during scoped search

Hold stashed song results across fetchSongPage churn, defer leave-stash
teardown past AppShell scroll reset, restore tracks scroll after the list
is ready, and save scroll snapshot when opening artist from song context menu.

* fix(tracks): hide discovery headings during scoped search

Hide the page subtitle and "Browse all tracks" section title when
tracks search is active, matching hero/rails chrome behavior.

* feat(search): scoped live search for Composers browse

Wire /composers to header live search with composers scope badge,
session stash, scroll restore, and plain grid/list during text filter.
Remove the in-page filter input; add i18n and navigation helpers.

* docs: CHANGELOG and credits for scoped browse live search (PR #938)
2026-06-01 13:04:36 +03:00

123 lines
4.4 KiB
TypeScript

import { useEffect, useRef, useState, type RefObject } from 'react';
import { useLocation, useNavigationType, type NavigationType } from 'react-router-dom';
import type { SubsonicAlbum } from '../api/subsonicTypes';
import {
DEFAULT_ALBUM_BROWSE_RETURN_FILTERS,
type AlbumBrowseReturnFilters,
type AlbumBrowseSurface,
albumBrowseSurfaceForPath,
isAlbumDetailPath,
useAlbumBrowseSessionStore,
} from '../store/albumBrowseSessionStore';
import { shouldRestoreAlbumBrowseSession } from '../utils/navigation/albumDetailNavigation';
import { useLiveSearchScopeStore } from '../store/liveSearchScopeStore';
import {
inpageScrollViewportIdForSurface,
readInpageScrollTop,
} from '../constants/appScroll';
import type { AlbumBrowseScrollSnapshot } from './useAlbumBrowseFilters';
export type AlbumGridBrowseSnapshot = {
albums: SubsonicAlbum[];
hasMore: boolean;
};
function sameGenreSelection(a: string[], b: string[]): boolean {
return a.length === b.length && a.every((value, index) => value === b[index]);
}
function returnStateForNavigation(
serverId: string,
surface: AlbumBrowseSurface,
navigationType: NavigationType,
locationState: unknown,
): AlbumBrowseReturnFilters {
if (!shouldRestoreAlbumBrowseSession(navigationType, locationState) || !serverId) {
return DEFAULT_ALBUM_BROWSE_RETURN_FILTERS;
}
return (
useAlbumBrowseSessionStore.getState().peekReturnStash(serverId, surface)
?? DEFAULT_ALBUM_BROWSE_RETURN_FILTERS
);
}
/** Genre-filter album grid pages (New Releases, Random Albums) — shared leave-restore. */
export function useAlbumGridBrowseFilters(
serverId: string,
surface: AlbumBrowseSurface,
scrollSnapshotRef?: RefObject<AlbumBrowseScrollSnapshot>,
gridSnapshotRef?: RefObject<AlbumGridBrowseSnapshot>,
) {
const navigationType = useNavigationType();
const location = useLocation();
const initialState = returnStateForNavigation(serverId, surface, navigationType, location.state);
const [selectedGenres, setSelectedGenres] = useState<string[]>(() => initialState.selectedGenres);
const restoredFromStashRef = useRef(false);
const filtersRef = useRef({ selectedGenres, searchQuery: '' });
filtersRef.current = {
selectedGenres,
searchQuery: useLiveSearchScopeStore.getState().query,
};
useEffect(() => {
restoredFromStashRef.current = false;
}, [serverId, surface]);
useEffect(() => {
if (!serverId) return;
if (shouldRestoreAlbumBrowseSession(navigationType, location.state)) {
restoredFromStashRef.current = true;
const restored = useAlbumBrowseSessionStore.getState().peekReturnStash(serverId, surface);
if (restored) {
useLiveSearchScopeStore.getState().setQuery(restored.searchQuery ?? '');
if (!sameGenreSelection(restored.selectedGenres, filtersRef.current.selectedGenres)) {
setSelectedGenres(restored.selectedGenres);
}
}
return;
}
if (restoredFromStashRef.current) return;
useAlbumBrowseSessionStore.getState().clearReturnStash(serverId, surface);
useLiveSearchScopeStore.getState().setQuery('');
setSelectedGenres([]);
}, [serverId, surface, navigationType, location.state]);
useEffect(() => {
return () => {
if (!serverId) return;
const path = window.location.pathname;
if (isAlbumDetailPath(path)) {
const scrollSnapshot = scrollSnapshotRef?.current;
const gridSnapshot = gridSnapshotRef?.current;
const viewportId = inpageScrollViewportIdForSurface(surface);
const scrollTop = Math.max(
readInpageScrollTop(viewportId),
scrollSnapshot?.scrollTop ?? 0,
);
useAlbumBrowseSessionStore.getState().stashReturnFilters(serverId, surface, {
...DEFAULT_ALBUM_BROWSE_RETURN_FILTERS,
selectedGenres: filtersRef.current.selectedGenres,
searchQuery: filtersRef.current.searchQuery,
scrollTop,
displayCount: gridSnapshot?.albums.length ?? scrollSnapshot?.displayCount,
albums: gridSnapshot?.albums,
hasMore: gridSnapshot?.hasMore,
});
} else if (albumBrowseSurfaceForPath(path) !== surface) {
useAlbumBrowseSessionStore.getState().clearReturnStash(serverId, surface);
}
};
}, [serverId, surface, scrollSnapshotRef, gridSnapshotRef]);
return {
selectedGenres,
setSelectedGenres,
initialAlbums: initialState.albums ?? null,
initialHasMore: initialState.hasMore,
};
}