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

Default Filter for Links & Details #4036

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ad4f11d
Default Filter Links & Details // Initial Commit
yoshnopa Aug 16, 2023
4b165dc
Merge branch 'develop' into defaultDetails
yoshnopa Aug 25, 2023
c13e595
Merge branch 'develop' into defaultDetails
yoshnopa Sep 1, 2023
65f9d23
Default Filter Links & Details // Frontend & link filter save logic
yoshnopa Sep 26, 2023
225b638
Merge branch 'develop' into defaultDetails
yoshnopa Sep 26, 2023
852680a
Default Filter Links & Details // Little cleaning, apply to subpages
yoshnopa Sep 26, 2023
d66ae96
Default Filter Links & Details // Make links work, universalise access
yoshnopa Sep 26, 2023
7540591
Default Filter Links & Details // Fix bug of camelcases, streamline t…
yoshnopa Sep 26, 2023
1d39a39
Default Filter Links & Details // Fix Errors on subpages with undefin…
yoshnopa Sep 26, 2023
a20c933
Default Filter Links & Details // Fix Movies & Markers taking default…
yoshnopa Sep 27, 2023
c34fb57
Default Filter Links & Details // Marker Bugfix made it not load Link…
yoshnopa Sep 27, 2023
dcb0094
Revert link changes
WithoutPants Oct 13, 2023
d37c5cc
WIP - useEffect loop
WithoutPants Oct 13, 2023
e10d6e0
Viper workaround
WithoutPants Oct 13, 2023
01e6d20
defaultDetails // Remove subview Filter on default save by URL Check
yoshnopa Oct 26, 2023
f0106a1
defaultDetails // Use filterHooks from ItemLists for subview filter
yoshnopa Oct 26, 2023
0799769
defaultDetails // More universal hook support (exclude, multiple valu…
yoshnopa Oct 26, 2023
f2bf66f
defaultDetails // Add missing default Filter Views
yoshnopa Oct 26, 2023
ff627c1
Merge branch 'stashapp:develop' into defaultDetails
yoshnopa Dec 6, 2023
367d72f
Merge branch 'develop' into defaultDetails
yoshnopa Dec 28, 2023
1bf0846
defaultLink // Use default Filter Link by default
yoshnopa Oct 26, 2023
52fc946
defaultLink // Fix duplicate Filters, use parameter for default Link
yoshnopa Oct 28, 2023
cb9a335
defaultLink // Correct Parameter reading (History Bug)
yoshnopa Nov 4, 2023
01cc74b
defaultLink // Linting
yoshnopa Jan 4, 2024
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
4 changes: 2 additions & 2 deletions ui/v2.5/src/components/Galleries/Galleries.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ import React from "react";
import { Route, Switch } from "react-router-dom";
import { Helmet } from "react-helmet";
import { useTitleProps } from "src/hooks/title";
import { PersistanceLevel } from "../List/ItemList";
import Gallery from "./GalleryDetails/Gallery";
import GalleryCreate from "./GalleryDetails/GalleryCreate";
import { GalleryList } from "./GalleryList";
import { useScrollToTopOnMount } from "src/hooks/scrollToTop";
import { View } from "../List/views";

const Galleries: React.FC = () => {
useScrollToTopOnMount();

return <GalleryList persistState={PersistanceLevel.ALL} />;
return <GalleryList view={View.Galleries} />;
};

const GalleryRoutes: React.FC = () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ import { GalleriesCriterion } from "src/models/list-filter/criteria/galleries";
import { ListFilterModel } from "src/models/list-filter/filter";
import { ImageList } from "src/components/Images/ImageList";
import { mutateRemoveGalleryImages } from "src/core/StashService";
import {
showWhenSelected,
PersistanceLevel,
} from "src/components/List/ItemList";
import { showWhenSelected } from "src/components/List/ItemList";
import { useToast } from "src/hooks/Toast";
import { useIntl } from "react-intl";
import { faMinus } from "@fortawesome/free-solid-svg-icons";
import { galleryTitle } from "src/core/galleries";
import { View } from "src/components/List/views";

interface IGalleryDetailsProps {
active: boolean;
Expand Down Expand Up @@ -102,8 +100,7 @@ export const GalleryImagesPanel: React.FC<IGalleryDetailsProps> = ({
filterHook={filterHook}
alterQuery={active}
extraOperations={otherOperations}
persistState={PersistanceLevel.VIEW}
persistanceKey="galleryimages"
view={View.GalleryImages}
chapters={gallery.chapters}
/>
);
Expand Down
13 changes: 5 additions & 8 deletions ui/v2.5/src/components/Galleries/GalleryList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ import { Table } from "react-bootstrap";
import { Link, useHistory } from "react-router-dom";
import Mousetrap from "mousetrap";
import * as GQL from "src/core/generated-graphql";
import {
makeItemList,
PersistanceLevel,
showWhenSelected,
} from "../List/ItemList";
import { makeItemList, showWhenSelected } from "../List/ItemList";
import { ListFilterModel } from "src/models/list-filter/filter";
import { DisplayMode } from "src/models/list-filter/types";
import { queryFindGalleries, useFindGalleries } from "src/core/StashService";
Expand All @@ -19,6 +15,7 @@ import { EditGalleriesDialog } from "./EditGalleriesDialog";
import { DeleteGalleriesDialog } from "./DeleteGalleriesDialog";
import { ExportDialog } from "../Shared/ExportDialog";
import { galleryTitle } from "src/core/galleries";
import { View } from "../List/views";

const GalleryItemList = makeItemList({
filterMode: GQL.FilterMode.Galleries,
Expand All @@ -33,13 +30,13 @@ const GalleryItemList = makeItemList({

interface IGalleryList {
filterHook?: (filter: ListFilterModel) => ListFilterModel;
persistState?: PersistanceLevel;
view?: View;
alterQuery?: boolean;
}

export const GalleryList: React.FC<IGalleryList> = ({
filterHook,
persistState,
view,
alterQuery,
}) => {
const intl = useIntl();
Expand Down Expand Up @@ -230,7 +227,7 @@ export const GalleryList: React.FC<IGalleryList> = ({
zoomable
selectable
filterHook={filterHook}
persistState={persistState}
view={view}
alterQuery={alterQuery}
otherOperations={otherOperations}
addKeybinds={addKeybinds}
Expand Down
11 changes: 4 additions & 7 deletions ui/v2.5/src/components/Images/ImageList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import { queryFindImages, useFindImages } from "src/core/StashService";
import {
makeItemList,
IItemListOperation,
PersistanceLevel,
showWhenSelected,
} from "../List/ItemList";
import { useLightbox } from "src/hooks/Lightbox/hooks";
Expand All @@ -32,6 +31,7 @@ import { objectTitle } from "src/core/files";
import TextUtils from "src/utils/text";
import { ConfigurationContext } from "src/hooks/Config";
import { IUIConfig } from "src/core/config";
import { View } from "../List/views";

interface IImageWallProps {
images: GQL.SlimImageDataFragment[];
Expand Down Expand Up @@ -291,17 +291,15 @@ const ImageItemList = makeItemList({

interface IImageList {
filterHook?: (filter: ListFilterModel) => ListFilterModel;
persistState?: PersistanceLevel;
persistanceKey?: string;
view?: View;
alterQuery?: boolean;
extraOperations?: IItemListOperation<GQL.FindImagesQueryResult>[];
chapters?: GQL.GalleryChapterDataFragment[];
}

export const ImageList: React.FC<IImageList> = ({
filterHook,
persistState,
persistanceKey,
view,
alterQuery,
extraOperations,
chapters = [],
Expand Down Expand Up @@ -442,8 +440,7 @@ export const ImageList: React.FC<IImageList> = ({
zoomable
selectable
filterHook={filterHook}
persistState={persistState}
persistanceKey={persistanceKey}
view={view}
alterQuery={alterQuery}
otherOperations={otherOperations}
addKeybinds={addKeybinds}
Expand Down
4 changes: 2 additions & 2 deletions ui/v2.5/src/components/Images/Images.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ import React from "react";
import { Route, Switch } from "react-router-dom";
import { Helmet } from "react-helmet";
import { useTitleProps } from "src/hooks/title";
import { PersistanceLevel } from "../List/ItemList";
import Image from "./ImageDetails/Image";
import { ImageList } from "./ImageList";
import { useScrollToTopOnMount } from "src/hooks/scrollToTop";
import { View } from "../List/views";

const Images: React.FC = () => {
useScrollToTopOnMount();

return <ImageList persistState={PersistanceLevel.ALL} />;
return <ImageList view={View.Images} />;
};

const ImageRoutes: React.FC = () => {
Expand Down
102 changes: 23 additions & 79 deletions ui/v2.5/src/components/List/ItemList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ import {
Criterion,
CriterionValue,
} from "src/models/list-filter/criteria/criterion";
import { ListFilterModel } from "src/models/list-filter/filter";
import {
ListFilterModel,
useDefaultFilter,
} from "src/models/list-filter/filter";
import { IconDefinition } from "@fortawesome/fontawesome-svg-core";
import { useInterfaceLocalForage } from "src/hooks/LocalForage";
import { useHistory, useLocation } from "react-router-dom";
import { ConfigurationContext } from "src/hooks/Config";
import { getFilterOptions } from "src/models/list-filter/factory";
import { useFindDefaultFilter } from "src/core/StashService";
import { Pagination, PaginationIndex } from "./Pagination";
import { EditFilterDialog } from "src/components/List/EditFilterDialog";
import { ListFilter } from "./ListFilter";
Expand All @@ -33,15 +34,7 @@ import { ListOperationButtons } from "./ListOperationButtons";
import { LoadingIndicator } from "../Shared/LoadingIndicator";
import { DisplayMode } from "src/models/list-filter/types";
import { ButtonToolbar } from "react-bootstrap";

export enum PersistanceLevel {
// do not load default query or persist display mode
NONE,
// load default query, don't load or persist display mode
ALL,
// load and persist display mode only
VIEW,
}
import { View } from "./views";

interface IDataItem {
id: string;
Expand Down Expand Up @@ -79,8 +72,7 @@ interface IRenderListProps {
}

interface IItemListProps<T extends QueryResult, E extends IDataItem> {
persistState?: PersistanceLevel;
persistanceKey?: string;
view?: View;
defaultSort?: string;
filterHook?: (filter: ListFilterModel) => ListFilterModel;
filterDialog?: (
Expand Down Expand Up @@ -139,14 +131,15 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
filter,
onChangePage: _onChangePage,
updateFilter,
persistState,
view,
zoomable,
selectable,
otherOperations,
renderContent,
renderEditDialog,
renderDeleteDialog,
addKeybinds,
filterHook,
}) => {
const [isEditDialogOpen, setIsEditDialogOpen] = useState(false);
const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false);
Expand Down Expand Up @@ -471,7 +464,8 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
filter={filter}
filterOptions={filterOptions}
openFilterDialog={() => setShowEditFilter(true)}
persistState={persistState}
view={view}
filterHook={filterHook}
/>
<ListOperationButtons
onSelectAll={selectable ? onSelectAll : undefined}
Expand Down Expand Up @@ -522,8 +516,7 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({

const ItemList: React.FC<IItemListProps<T, E>> = (props) => {
const {
persistState,
persistanceKey = filterMode,
view,
defaultSort = filterOptions.defaultSortBy,
filterHook,
defaultZoomIndex,
Expand All @@ -532,7 +525,6 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({

const history = useHistory();
const location = useLocation();
const [interfaceState, setInterfaceState] = useInterfaceLocalForage();
const [filterInitialised, setFilterInitialised] = useState(false);
const { configuration: config } = useContext(ConfigurationContext);

Expand All @@ -542,40 +534,16 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
() => new ListFilterModel(filterMode)
);

const updateSavedFilter = useCallback(
(updatedFilter: ListFilterModel) => {
setInterfaceState((prevState) => {
if (!prevState.queryConfig) {
prevState.queryConfig = {};
}

const oldFilter = prevState.queryConfig[persistanceKey]?.filter ?? "";
const newFilter = new URLSearchParams(oldFilter);
newFilter.set("disp", String(updatedFilter.displayMode));

return {
...prevState,
queryConfig: {
...prevState.queryConfig,
[persistanceKey]: {
...prevState.queryConfig[persistanceKey],
filter: newFilter.toString(),
},
},
};
});
},
[persistanceKey, setInterfaceState]
const { defaultFilter, loading: defaultFilterLoading } = useDefaultFilter(
filterMode,
view
);

const { data: defaultFilter, loading: defaultFilterLoading } =
useFindDefaultFilter(filterMode);

const updateQueryParams = useCallback(
(newFilter: ListFilterModel) => {
if (!alterQuery) return;

const newParams = newFilter.makeQueryParameters();
const newParams = newFilter.makeQueryParameters(false);
history.replace({ ...history.location, search: newParams });
},
[alterQuery, history]
Expand All @@ -585,11 +553,8 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
(newFilter: ListFilterModel) => {
setFilter(newFilter);
updateQueryParams(newFilter);
if (persistState === PersistanceLevel.VIEW) {
updateSavedFilter(newFilter);
}
},
[persistState, updateSavedFilter, updateQueryParams]
[updateQueryParams]
);

// 'Startup' hook, initialises the filters
Expand All @@ -607,43 +572,24 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
let loadDefault = true;
if (alterQuery && location.search) {
loadDefault = false;
newFilter.configureFromQueryString(location.search);
newFilter.configureFromQueryString(location.search, defaultFilter);
}

if (persistState === PersistanceLevel.ALL) {
if (view) {
// only set default filter if uninitialised
if (loadDefault) {
// wait until default filter is loaded
if (defaultFilterLoading) return;

if (defaultFilter?.findDefaultFilter) {
newFilter.currentPage = 1;
try {
newFilter.configureFromSavedFilter(
defaultFilter.findDefaultFilter
);
} catch (err) {
console.log(err);
// ignore
}
if (defaultFilter) {
newFilter = defaultFilter.clone();

// #1507 - reset random seed when loaded
newFilter.randomSeed = -1;
}
}
} else if (persistState === PersistanceLevel.VIEW) {
// wait until forage is initialised
if (interfaceState.loading) return;

const storedQuery = interfaceState.data?.queryConfig?.[persistanceKey];
if (persistState === PersistanceLevel.VIEW && storedQuery) {
const displayMode = new URLSearchParams(storedQuery.filter).get(
"disp"
);
if (displayMode) {
newFilter.displayMode = Number.parseInt(displayMode, 10);
}
}
}

setFilter(newFilter);
updateQueryParams(newFilter);

Expand All @@ -656,12 +602,10 @@ export function makeItemList<T extends QueryResult, E extends IDataItem>({
defaultDisplayMode,
defaultZoomIndex,
alterQuery,
persistState,
view,
updateQueryParams,
defaultFilter,
defaultFilterLoading,
interfaceState,
persistanceKey,
]);

// This hook runs on every page location change (ie navigation),
Expand Down
Loading
Loading