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.

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

Refactor how images are selected to be shown #1087

Merged
merged 1 commit into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/components/BackgroundImagePlaceholderDiv.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type Props = {
children?: React.ReactNode;
className?: string;
contain?: boolean;
image: ImageType | null;
image?: ImageType;
hidePlaceholderOnHover?: boolean;
overlayOnHover?: boolean;
zoomOnHover?: boolean;
Expand Down
22 changes: 11 additions & 11 deletions src/components/Collection/SeriesTopPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,25 @@ const SeriesTag = React.memo(({ text, type }: { text: string, type: 'User' | 'An
});

const SeriesTopPanel = React.memo(({ series }: { series: SeriesType }) => {
const { WebUI_Settings: { collection: { image: { showRandomPoster } } } } = useSettingsQuery().data;
const [poster, setPoster] = useState<ImageType | null>(null);
const { seriesId } = useParams();

const tagsQuery = useSeriesTagsQuery(toNumber(seriesId!), { excludeDescriptions: true, filter: 1 }, !!seriesId);
const imagesQuery = useSeriesImagesQuery(toNumber(seriesId!), !!seriesId);
const tags = useMemo(() => tagsQuery?.data ?? [], [tagsQuery.data]);

const { showRandomPoster } = useSettingsQuery().data.WebUI_Settings.collection.image;
const imagesQuery = useSeriesImagesQuery(toNumber(seriesId!), !!seriesId && showRandomPoster);
const [poster, setPoster] = useState<ImageType>();
useEffect(() => {
if (!imagesQuery.isSuccess) return;
if (!showRandomPoster) {
setPoster(series.Images?.Posters?.[0]);
return;
}

const allPosters: ImageType[] = imagesQuery.data?.Posters ?? [];
const allPosters = imagesQuery.data?.Posters ?? [];
if (allPosters.length === 0) return;

if (showRandomPoster) {
setPoster(allPosters[Math.floor(Math.random() * allPosters.length)]);
return;
}
setPoster(allPosters.find(art => art.Preferred) ?? allPosters[0]);
}, [imagesQuery.data, imagesQuery.isSuccess, showRandomPoster]);
setPoster(allPosters[Math.floor(Math.random() * allPosters.length)]);
}, [imagesQuery.data, series, showRandomPoster]);

// TODO: try to make this a grid for better responsiveness... but we'll have v3 soon so maybe not right now.
return (
Expand Down
2 changes: 1 addition & 1 deletion src/components/SeriesPoster.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type Props = {
children?: React.ReactNode;
title: string;
subtitle?: string;
image: ImageType | null;
image?: ImageType;
shokoId?: number | null;
anidbSeriesId?: number;
anidbEpisodeId?: number;
Expand Down
4 changes: 2 additions & 2 deletions src/hooks/useEpisodeThumbnail.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { EpisodeType } from '@/core/types/api/episode';
function useEpisodeThumbnail(
episode: EpisodeType,
backdrop: ImageType | undefined,
): ImageType | null {
) {
const { useThumbnailFallback } = useSettingsQuery().data.WebUI_Settings.collection.image;
return useMemo(() => {
if (episode.Images.Thumbnails.length) {
Expand All @@ -20,7 +20,7 @@ function useEpisodeThumbnail(
}

if (useThumbnailFallback && backdrop) return backdrop;
return null;
return undefined;
}, [episode, useThumbnailFallback, backdrop]);
}

Expand Down
10 changes: 4 additions & 6 deletions src/hooks/useMainPoster.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import { useMemo } from 'react';

import type { CollectionGroupType } from '@/core/types/api/collection';
import type { ImageType } from '@/core/types/api/common';
import type { SeriesType } from '@/core/types/api/series';

function useMainPoster(target: SeriesType | CollectionGroupType | null | undefined): ImageType | null {
return useMemo(() => {
const posters = target?.Images?.Posters ?? [];
return posters.find(poster => poster.Preferred) ?? posters[0] ?? null;
}, [target]);
function useMainPoster(target: SeriesType | CollectionGroupType | null | undefined) {
// There is only 1 poster in the series/collection and if preferred image exists, it will always be that.
// So checking for preferred image is not needed.
return useMemo(() => target?.Images?.Posters?.[0], [target]);
}

export default useMainPoster;
24 changes: 11 additions & 13 deletions src/pages/collection/Series.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {
} from '@mdi/js';
import { Icon } from '@mdi/react';
import cx from 'classnames';
import { get, toNumber } from 'lodash';
import { toNumber } from 'lodash';

import EditSeriesModal from '@/components/Collection/Series/EditSeriesModal';
import SeriesTopPanel from '@/components/Collection/SeriesTopPanel';
Expand Down Expand Up @@ -54,13 +54,10 @@ const Series = () => {
const navigate = useNavigate();
const { seriesId } = useParams();

const { showRandomBackdrop } = useSettingsQuery().data.WebUI_Settings.collection.image;
const seriesQuery = useSeriesQuery(toNumber(seriesId!), { includeDataFrom: ['AniDB', 'TMDB'] }, !!seriesId);
const series = useMemo(() => seriesQuery?.data ?? {} as SeriesType, [seriesQuery.data]);
const imagesQuery = useSeriesImagesQuery(toNumber(seriesId!), !!seriesId);
const groupQuery = useGroupQuery(series?.IDs?.ParentGroup ?? 0, !!series?.IDs?.ParentGroup);

const [backdrop, setBackdrop] = useState<ImageType>();
const { scrollRef } = useOutletContext<{ scrollRef: React.RefObject<HTMLDivElement> }>();

const dispatch = useDispatch();
Expand All @@ -80,19 +77,20 @@ const Series = () => {
dispatch(setSeriesId(toNumber(seriesId) ?? -1));
});

const { showRandomBackdrop } = useSettingsQuery().data.WebUI_Settings.collection.image;
const imagesQuery = useSeriesImagesQuery(toNumber(seriesId!), !!seriesId && showRandomBackdrop);
const [backdrop, setBackdrop] = useState<ImageType>();
useEffect(() => {
if (!imagesQuery.isSuccess) return;

const allBackdrops: ImageType[] = get(imagesQuery.data, 'Backdrops', []);
if (!Array.isArray(allBackdrops) || allBackdrops.length === 0) return;

if (showRandomBackdrop) {
setBackdrop(allBackdrops[Math.floor(Math.random() * allBackdrops.length)]);
if (!showRandomBackdrop) {
setBackdrop(series.Images?.Backdrops?.[0]);
return;
}

setBackdrop(allBackdrops.find(image => image.Preferred) ?? allBackdrops[0]);
}, [imagesQuery.data, imagesQuery.isSuccess, series, showRandomBackdrop]);
const allBackdrops = imagesQuery.data?.Backdrops ?? [];
if (allBackdrops.length === 0) return;

setBackdrop(allBackdrops[Math.floor(Math.random() * allBackdrops.length)]);
}, [imagesQuery.data, series, showRandomBackdrop]);

const [containerRef, containerBounds] = useMeasure();

Expand Down