Skip to content

A self-hosted media server and file management system

feat: add basic frontend for related folders (without editor)

aminnausin84466da9b2ae
diff --git a/resources/js/components/cards/data/relations/RelatedFolderCard.vue b/resources/js/components/cards/data/relations/RelatedFolderCard.vue
new file mode 100644
index 00000000..656b898f
--- /dev/null
+++ b/resources/js/components/cards/data/relations/RelatedFolderCard.vue
@@ -0,0 +1,55 @@
+<script setup lang="ts">
+import type { FolderResource, SeriesRelation } from '@/contracts/media';
+
+import { handleStorageURL } from '@/service/util';
+import { FLAGS } from '@/config/featureFlags';
+import { cn } from '@aminnausin/cedar-ui';
+
+import PlayerOSDBase from '@/components/video/OSD/PlayerOSDBase.vue';
+import BlurhashImage from '@/components/lazy/BlurhashImage.vue';
+import LazyImage from '@/components/lazy/LazyImage.vue';
+
+defineProps<{ folder: FolderResource; relation: SeriesRelation; eagerLoad?: boolean }>();
+
+const scrollIntoView = (e: FocusEvent) => {
+ (e.currentTarget as HTMLElement).scrollIntoView({
+ inline: 'nearest',
+ block: 'nearest',
+ });
+};
+</script>
+<template>
+ <div
+ :class="
+ cn(
+ 'group data-card flex w-30 shrink-0 snap-start flex-col gap-2 rounded-md',
+ 'focus-within:outline-none',
+ 'content-auto [contain-intrinsic-size:160px_280px]',
+ { 'rounded-none bg-transparent shadow-none': FLAGS.USE_TRANSPARENT_HOME_CARDS },
+ $attrs.class,
+ )
+ "
+ @focus="scrollIntoView"
+ >
+ <RouterLink :to="`/${folder.category_id}/${folder.id}/details/relations`" :class="cn('relative rounded-md shadow-sm [clip-path:inset(0_round_0.375rem)]')">
+ <component
+ :is="folder.series?.poster_image?.blur_hash ? BlurhashImage : LazyImage"
+ :src="folder.series?.poster_image?.path ?? handleStorageURL(folder.series?.thumbnail_url) ?? '/storage/thumbnails/default.webp'"
+ :class="'aspect-2-3 w-full object-cover'"
+ :alt="folder.title"
+ :fetch-priority="eagerLoad ? 'high' : 'auto'"
+ :loading="eagerLoad ? 'eager' : 'lazy'"
+ :blurhash="folder.series?.poster_image?.blur_hash"
+ />
+ <slot name="overlay">
+ <PlayerOSDBase class="absolute bottom-0 z-1 w-full rounded-none p-0.5 text-xs">{{ relation.label }}</PlayerOSDBase>
+ </slot>
+ </RouterLink>
+ <RouterLink :class="cn('flex w-full flex-col text-xs', { 'px-2 pb-2': !FLAGS.USE_TRANSPARENT_HOME_CARDS })" :to="`/${folder.category_id}/${folder.id}`">
+ <slot name="title">
+ <p class="truncate group-hover:underline">{{ folder.title }}</p>
+ </slot>
+ <slot />
+ </RouterLink>
+ </div>
+</template>
diff --git a/resources/js/components/folders/FolderOverview.vue b/resources/js/components/folders/FolderOverview.vue
index ce7723d2..6d0be699 100644
--- a/resources/js/components/folders/FolderOverview.vue
+++ b/resources/js/components/folders/FolderOverview.vue
@@ -1,13 +1,19 @@
<script setup lang="ts">
import FolderOverviewSidebar from '@/components/folders/FolderOverviewSidebar.vue';
import FolderDescription from '@/components/folders/FolderDescription.vue';
+import FolderRelations from '@/components/folders/FolderRelations.vue';
import FolderMedia from '@/components/folders/FolderMedia.vue';
</script>
<template>
- <FolderDescription />
- <div class="flex flex-1 flex-col gap-3 @[40rem]:flex-row">
- <FolderOverviewSidebar />
- <FolderMedia />
+ <div class="flex flex-col gap-2">
+ <FolderDescription />
+ <div class="flex flex-1 flex-col gap-2 @[40rem]:flex-row">
+ <FolderOverviewSidebar />
+ <div class="flex flex-1 flex-col gap-2">
+ <FolderRelations :hide-if-empty="true" :show-title="true" />
+ <FolderMedia />
+ </div>
+ </div>
</div>
</template>
diff --git a/resources/js/components/folders/FolderRelations.vue b/resources/js/components/folders/FolderRelations.vue
new file mode 100644
index 00000000..a54940e0
--- /dev/null
+++ b/resources/js/components/folders/FolderRelations.vue
@@ -0,0 +1,59 @@
+<script setup lang="ts">
+import type { SeriesResource } from '@/contracts/media';
+import type { ComputedRef } from 'vue';
+
+import { computed, inject, ref } from 'vue';
+import { ButtonBase } from '@/components/cedar-ui/button';
+import { cn } from '@aminnausin/cedar-ui';
+
+import RelatedFolderCard from '@/components/cards/data/relations/RelatedFolderCard.vue';
+import FolderTab from '@/components/folders/FolderTab.vue';
+
+import LucideWaypoints from '~icons/lucide/waypoints';
+
+declare type RelationType = 'files' | 'folders';
+
+defineProps<{ hideIfEmpty?: boolean; showTitle?: boolean }>();
+
+const data = inject<ComputedRef<SeriesResource>>('series');
+
+const activeFilters = computed<RelationType[]>(() => ['folders']);
+const filteredRelations = computed(() => data?.value.related_series ?? []);
+
+const filteredType = ref<RelationType>(activeFilters.value[0]);
+</script>
+<template>
+ <FolderTab class="flex-1 gap-2" v-if="data.related_series.length > 0 || !hideIfEmpty">
+ <div class="flex w-full flex-wrap justify-between gap-0.5" v-if="showTitle && data.related_series.length > 0">
+ <span class="text-nowrap">Relations</span>
+ <span class="text-foreground-1">
+ {{ filteredRelations.length }}
+ </span>
+ </div>
+ <div v-if="activeFilters.length > 1" class="bg-surface-3/50 dark:bg-surface-3 flex w-fit gap-0.5 rounded-lg p-0.5 text-xs">
+ <ButtonBase
+ v-for="filter in activeFilters"
+ :key="filter"
+ :class="
+ cn('h-7 rounded-md px-3 py-1 capitalize transition-colors', {
+ 'bg-surface-1 dark:bg-surface-4 text-primary-active dark:text-primary-muted shadow-sm': filter === filteredType,
+ 'text-foreground-2 hover:text-foreground-0 hover:bg-surface-1/50': filter !== filteredType,
+ })
+ "
+ @click="filteredType = filter"
+ >
+ Related {{ filter }}
+ </ButtonBase>
+ </div>
+
+ <div class="xms:text-sm @container flex flex-1 flex-col gap-4 text-xs">
+ <div v-if="filteredRelations.length > 0" :class="['grid w-full grid-cols-[repeat(auto-fill,minmax(clamp(6.5rem,8cqw,8rem),1fr))] gap-2']">
+ <RelatedFolderCard v-for="relation in filteredRelations" :key="relation.folder.id" :folder="relation.folder" :relation="relation" class="w-full" />
+ </div>
+ <div v-else class="text-foreground-1 my-auto flex w-full items-center justify-center gap-1 py-8 tracking-widest">
+ <LucideWaypoints class="size-6 *:stroke-[1.4]" />
+ <span> No relations yet </span>
+ </div>
+ </div>
+ </FolderTab>
+</template>
diff --git a/resources/js/components/folders/FolderTabs.ts b/resources/js/components/folders/FolderTabs.ts
index 88d954ea..d219426a 100644
--- a/resources/js/components/folders/FolderTabs.ts
+++ b/resources/js/components/folders/FolderTabs.ts
@@ -27,6 +27,7 @@ export function useFolderTabs(stateFolder: Ref<FolderResource>, isAudio: Compute
description: stateFolder.value.edited_at ? `Edited ${toTimeSpan(stateFolder.value.edited_at, '')}` : 'Never Edited',
},
{ name: 'stats', icon: ProiconsGraph, description: `Total Size ${formatFileSize(stateFolder.value.total_size ?? 0)}` },
+ { name: 'relations', icon: ProiconsGraph, description: `0 Related Items` },
])();
const { activeTab: activeFolderTab, tabs } = storeToRefs(tabsStore);
diff --git a/resources/js/contracts/media.ts b/resources/js/contracts/media.ts
index b6b3a133..dfb756ec 100644
--- a/resources/js/contracts/media.ts
+++ b/resources/js/contracts/media.ts
@@ -67,6 +67,8 @@ export interface SeriesResource {
banner_image?: ImageResource;
primary_banner_id?: number;
images: ImageResource[];
+
+ related_series: SeriesRelation[];
}
//#endregion
@@ -218,3 +220,11 @@ export interface SeriesSizeHistory {
file_count: number;
recorded_at: string;
}
+
+export type SeriesRelationType = 'sequel' | 'prequel' | 'spinoff' | 'side_story' | 'alternative' | 'summary' | 'soundtrack' | 'related' | 'parent';
+
+export interface SeriesRelation {
+ type: SeriesRelationType;
+ label: string;
+ folder: FolderResource;
+}
diff --git a/resources/js/views/FolderView.vue b/resources/js/views/FolderView.vue
index 5d822e8c..3b4b2bfa 100644
--- a/resources/js/views/FolderView.vue
+++ b/resources/js/views/FolderView.vue
@@ -32,7 +32,7 @@ import ProiconsMenu from '~icons/proicons/menu';
import IconShare from '@/components/icons/IconShare.vue';
import IconEdit from '@/components/icons/IconEdit.vue';
-const VALID_TABS = new Set(['overview', 'files', 'images', 'metadata', 'stats']);
+const VALID_TABS = new Set(['overview', 'files', 'images', 'metadata', 'stats', 'relations']);
const appStore = useAppStore();
@@ -47,6 +47,7 @@ const route = useRoute();
const popover = useTemplateRef('popover');
+const FolderRelations = defineAsyncComponent(() => import('@/components/folders/FolderRelations.vue'));
const FolderOverview = defineAsyncComponent(() => import('@/components/folders/FolderOverview.vue'));
const FolderMetadata = defineAsyncComponent(() => import('@/components/folders/FolderMetadata.vue'));
const FolderImages = defineAsyncComponent(() => import('@/components/folders/FolderImages.vue'));
@@ -66,6 +67,8 @@ const activeComponent = computed(() => {
return FolderMetadata;
case 'stats':
return FolderStats;
+ case 'relations':
+ return FolderRelations;
default:
return null;
}
@@ -159,14 +162,7 @@ watch(() => `${route.params.category}/${route.params.folder}`, reload, { immedia
watch(
() => route.params.tab,
- (tab) => {
- let parsedTab = tab as string;
-
- if (!VALID_TABS.has(parsedTab)) {
- parsedTab = 'overview';
- }
- setTab(parsedTab);
- },
+ (tab) => setTab(VALID_TABS.has(tab as string) ? (tab as string) : 'overview'),
{ immediate: true },
);