mirror of
https://github.com/immich-app/immich
synced 2025-11-14 17:36:12 +00:00
* 15712: Added keyboard shortcuts for opening add to album modal and highlighting/selecting an album to add to. * 15712: Re-factored logic from template code into script. Extracted new album button into separate cmponent. * 15712: Document new keyboard shortucts now that they work everywhere. * 15712: Extract some constants/helper functions. * 15712: Missing comma. * 15712: Pulled logic out into separate unit testable class. * 15712: Added a unit test. * 15712: Move the modal back up to keep the github PR happy. * 15712: PR feedback - renamed typescript files and switch to class bind directive. * 15712:Move selection modal into correct package. * 15712: Better naming of module and files. * 15712: Add asset highlight using arrow keys. * 15172: Add escape behaviour everywhere. * 15712: Don't allow highlighting past start or end. * 15712: Clear the highlight on changes to the component state. * 15712: Use focus to track highlighted element. * 15712: Rename highlight -> focussed. * 15712: Better naming. * 15712: Cleanup. * 15712: Cleanup & simplify. * 15712: bugfix for clicking on button. * 15712: Cleanup. * 15712: Rollback unnecessary changes. * 15712: Add unit test. * 15712: Add thumbnail unit test. * 15712: Prettier. * 15712: Fix merge issue. * 15712: Add shortcut info. * 15712: Fix linter.
250 lines
10 KiB
Svelte
250 lines
10 KiB
Svelte
<script lang="ts">
|
|
import { intersectionObserver } from '$lib/actions/intersection-observer';
|
|
import Icon from '$lib/components/elements/icon.svelte';
|
|
import Skeleton from '$lib/components/photos-page/skeleton.svelte';
|
|
import { AssetBucket, type AssetStore, type Viewport } from '$lib/stores/assets-store.svelte';
|
|
import { navigate } from '$lib/utils/navigation';
|
|
import {
|
|
findTotalOffset,
|
|
type DateGroup,
|
|
type ScrollTargetListener,
|
|
getDateLocaleString,
|
|
} from '$lib/utils/timeline-util';
|
|
import type { AssetResponseDto } from '@immich/sdk';
|
|
import { mdiCheckCircle, mdiCircleOutline } from '@mdi/js';
|
|
import { onDestroy } from 'svelte';
|
|
import { fly } from 'svelte/transition';
|
|
import Thumbnail from '../assets/thumbnail/thumbnail.svelte';
|
|
import { TUNABLES } from '$lib/utils/tunables';
|
|
import { generateId } from '$lib/utils/generate-id';
|
|
import type { AssetInteraction } from '$lib/stores/asset-interaction.svelte';
|
|
|
|
export let element: HTMLElement | undefined = undefined;
|
|
export let isSelectionMode = false;
|
|
export let viewport: Viewport;
|
|
export let singleSelect = false;
|
|
export let withStacked = false;
|
|
export let showArchiveIcon = false;
|
|
export let assetGridElement: HTMLElement | undefined = undefined;
|
|
export let renderThumbsAtBottomMargin: string | undefined = undefined;
|
|
export let renderThumbsAtTopMargin: string | undefined = undefined;
|
|
export let assetStore: AssetStore;
|
|
export let bucket: AssetBucket;
|
|
export let assetInteraction: AssetInteraction;
|
|
|
|
export let onScrollTarget: ScrollTargetListener | undefined = undefined;
|
|
export let onAssetInGrid: ((asset: AssetResponseDto) => void) | undefined = undefined;
|
|
export let onSelect: ({ title, assets }: { title: string; assets: AssetResponseDto[] }) => void;
|
|
export let onSelectAssets: (asset: AssetResponseDto) => void;
|
|
export let onSelectAssetCandidates: (asset: AssetResponseDto | null) => void;
|
|
|
|
const componentId = generateId();
|
|
$: bucketDate = bucket.bucketDate;
|
|
$: dateGroups = bucket.dateGroups;
|
|
|
|
const {
|
|
DATEGROUP: { INTERSECTION_ROOT_TOP, INTERSECTION_ROOT_BOTTOM },
|
|
} = TUNABLES;
|
|
/* TODO figure out a way to calculate this*/
|
|
const TITLE_HEIGHT = 51;
|
|
|
|
let isMouseOverGroup = false;
|
|
let hoveredDateGroup = '';
|
|
|
|
const onClick = (assets: AssetResponseDto[], groupTitle: string, asset: AssetResponseDto) => {
|
|
if (isSelectionMode || assetInteraction.selectionActive) {
|
|
assetSelectHandler(asset, assets, groupTitle);
|
|
return;
|
|
}
|
|
void navigate({ targetRoute: 'current', assetId: asset.id });
|
|
};
|
|
|
|
const onRetrieveElement = (dateGroup: DateGroup, asset: AssetResponseDto, element: HTMLElement) => {
|
|
if (assetGridElement && onScrollTarget) {
|
|
const offset = findTotalOffset(element, assetGridElement) - TITLE_HEIGHT;
|
|
onScrollTarget({ bucket, dateGroup, asset, offset });
|
|
}
|
|
};
|
|
|
|
const handleSelectGroup = (title: string, assets: AssetResponseDto[]) => onSelect({ title, assets });
|
|
|
|
const assetSelectHandler = (asset: AssetResponseDto, assetsInDateGroup: AssetResponseDto[], groupTitle: string) => {
|
|
onSelectAssets(asset);
|
|
|
|
// Check if all assets are selected in a group to toggle the group selection's icon
|
|
let selectedAssetsInGroupCount = assetsInDateGroup.filter((asset) =>
|
|
assetInteraction.selectedAssets.has(asset),
|
|
).length;
|
|
|
|
// if all assets are selected in a group, add the group to selected group
|
|
if (selectedAssetsInGroupCount == assetsInDateGroup.length) {
|
|
assetInteraction.addGroupToMultiselectGroup(groupTitle);
|
|
} else {
|
|
assetInteraction.removeGroupFromMultiselectGroup(groupTitle);
|
|
}
|
|
};
|
|
|
|
const assetMouseEventHandler = (groupTitle: string, asset: AssetResponseDto | null) => {
|
|
// Show multi select icon on hover on date group
|
|
hoveredDateGroup = groupTitle;
|
|
|
|
if (assetInteraction.selectionActive) {
|
|
onSelectAssetCandidates(asset);
|
|
}
|
|
};
|
|
|
|
const assetOnFocusHandler = (asset: AssetResponseDto) => {
|
|
assetInteraction.focussedAssetId = asset.id;
|
|
};
|
|
|
|
onDestroy(() => {
|
|
assetStore.taskManager.removeAllTasksForComponent(componentId);
|
|
});
|
|
</script>
|
|
|
|
<section id="asset-group-by-date" class="flex flex-wrap gap-x-12" data-bucket-date={bucketDate} bind:this={element}>
|
|
{#each dateGroups as dateGroup, groupIndex (dateGroup.date)}
|
|
{@const display =
|
|
dateGroup.intersecting || !!dateGroup.assets.some((asset) => asset.id === assetStore.pendingScrollAssetId)}
|
|
{@const geometry = dateGroup.geometry!}
|
|
|
|
<div
|
|
id="date-group"
|
|
use:intersectionObserver={{
|
|
onIntersect: () => {
|
|
assetStore.taskManager.intersectedDateGroup(componentId, dateGroup, () =>
|
|
assetStore.updateBucketDateGroup(bucket, dateGroup, { intersecting: true }),
|
|
);
|
|
},
|
|
onSeparate: () => {
|
|
assetStore.taskManager.separatedDateGroup(componentId, dateGroup, () =>
|
|
assetStore.updateBucketDateGroup(bucket, dateGroup, { intersecting: false }),
|
|
);
|
|
},
|
|
top: INTERSECTION_ROOT_TOP,
|
|
bottom: INTERSECTION_ROOT_BOTTOM,
|
|
root: assetGridElement,
|
|
}}
|
|
data-display={display}
|
|
data-date-group={dateGroup.date}
|
|
style:height={dateGroup.height + 'px'}
|
|
style:width={geometry.containerWidth + 'px'}
|
|
style:overflow="clip"
|
|
>
|
|
{#if !display}
|
|
<Skeleton height={dateGroup.height + 'px'} title={dateGroup.groupTitle} />
|
|
{/if}
|
|
{#if display}
|
|
<!-- Asset Group By Date -->
|
|
<!-- svelte-ignore a11y-no-static-element-interactions -->
|
|
<div
|
|
on:mouseenter={() =>
|
|
assetStore.taskManager.queueScrollSensitiveTask({
|
|
componentId,
|
|
task: () => {
|
|
isMouseOverGroup = true;
|
|
assetMouseEventHandler(dateGroup.groupTitle, null);
|
|
},
|
|
})}
|
|
on:mouseleave={() => {
|
|
assetStore.taskManager.queueScrollSensitiveTask({
|
|
componentId,
|
|
task: () => {
|
|
isMouseOverGroup = false;
|
|
assetMouseEventHandler(dateGroup.groupTitle, null);
|
|
},
|
|
});
|
|
}}
|
|
>
|
|
<!-- Date group title -->
|
|
<div
|
|
class="flex z-[100] sticky top-[-1px] pt-[calc(1.75rem+1px)] pb-5 h-6 place-items-center text-xs font-medium text-immich-fg bg-immich-bg dark:bg-immich-dark-bg dark:text-immich-dark-fg md:text-sm"
|
|
style:width={geometry.containerWidth + 'px'}
|
|
>
|
|
{#if !singleSelect && ((hoveredDateGroup == dateGroup.groupTitle && isMouseOverGroup) || assetInteraction.selectedGroup.has(dateGroup.groupTitle))}
|
|
<div
|
|
transition:fly={{ x: -24, duration: 200, opacity: 0.5 }}
|
|
class="inline-block px-2 hover:cursor-pointer"
|
|
on:click={() => handleSelectGroup(dateGroup.groupTitle, dateGroup.assets)}
|
|
on:keydown={() => handleSelectGroup(dateGroup.groupTitle, dateGroup.assets)}
|
|
>
|
|
{#if assetInteraction.selectedGroup.has(dateGroup.groupTitle)}
|
|
<Icon path={mdiCheckCircle} size="24" color="#4250af" />
|
|
{:else}
|
|
<Icon path={mdiCircleOutline} size="24" color="#757575" />
|
|
{/if}
|
|
</div>
|
|
{/if}
|
|
|
|
<span class="w-full truncate first-letter:capitalize" title={getDateLocaleString(dateGroup.date)}>
|
|
{dateGroup.groupTitle}
|
|
</span>
|
|
</div>
|
|
|
|
<!-- Image grid -->
|
|
<div
|
|
class="relative overflow-clip"
|
|
style:height={geometry.containerHeight + 'px'}
|
|
style:width={geometry.containerWidth + 'px'}
|
|
>
|
|
{#each dateGroup.assets as asset, i (asset.id)}
|
|
<!-- getting these together here in this order is very cache-efficient -->
|
|
{@const top = geometry.getTop(i)}
|
|
{@const left = geometry.getLeft(i)}
|
|
{@const width = geometry.getWidth(i)}
|
|
{@const height = geometry.getHeight(i)}
|
|
<!-- update ASSET_GRID_PADDING-->
|
|
<div
|
|
use:intersectionObserver={{
|
|
onIntersect: () => onAssetInGrid?.(asset),
|
|
top: `${-TITLE_HEIGHT}px`,
|
|
bottom: `${-(viewport.height - TITLE_HEIGHT - 1)}px`,
|
|
right: `${-(viewport.width - 1)}px`,
|
|
root: assetGridElement,
|
|
}}
|
|
data-asset-id={asset.id}
|
|
class="absolute"
|
|
style:top={top + 'px'}
|
|
style:left={left + 'px'}
|
|
style:width={width + 'px'}
|
|
style:height={height + 'px'}
|
|
>
|
|
<Thumbnail
|
|
{dateGroup}
|
|
{assetStore}
|
|
intersectionConfig={{
|
|
root: assetGridElement,
|
|
bottom: renderThumbsAtBottomMargin,
|
|
top: renderThumbsAtTopMargin,
|
|
}}
|
|
retrieveElement={assetStore.pendingScrollAssetId === asset.id}
|
|
onRetrieveElement={(element) => onRetrieveElement(dateGroup, asset, element)}
|
|
showStackedIcon={withStacked}
|
|
{showArchiveIcon}
|
|
{asset}
|
|
{groupIndex}
|
|
onClick={(asset) => onClick(dateGroup.assets, dateGroup.groupTitle, asset)}
|
|
onSelect={(asset) => assetSelectHandler(asset, dateGroup.assets, dateGroup.groupTitle)}
|
|
onMouseEvent={() => assetMouseEventHandler(dateGroup.groupTitle, asset)}
|
|
selected={assetInteraction.selectedAssets.has(asset) || assetStore.albumAssets.has(asset.id)}
|
|
handleFocus={() => assetOnFocusHandler(asset)}
|
|
focussed={assetInteraction.isFocussedAsset(asset)}
|
|
selectionCandidate={assetInteraction.assetSelectionCandidates.has(asset)}
|
|
disabled={assetStore.albumAssets.has(asset.id)}
|
|
thumbnailWidth={width}
|
|
thumbnailHeight={height}
|
|
/>
|
|
</div>
|
|
{/each}
|
|
</div>
|
|
</div>
|
|
{/if}
|
|
</div>
|
|
{/each}
|
|
</section>
|
|
|
|
<style>
|
|
#asset-group-by-date {
|
|
contain: layout paint style;
|
|
}
|
|
</style>
|