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

feat(web): add ctrl+a / ctrl+d shortcuts to select / deselect all assets #8105

Merged
merged 4 commits into from
Mar 21, 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
38 changes: 10 additions & 28 deletions web/src/lib/components/photos-page/actions/select-all-assets.svelte
Original file line number Diff line number Diff line change
@@ -1,42 +1,24 @@
<script lang="ts">
import CircleIconButton from '$lib/components/elements/buttons/circle-icon-button.svelte';
import type { AssetInteractionStore } from '$lib/stores/asset-interaction.store';
import { BucketPosition, type AssetStore, isSelectAllCancelled } from '$lib/stores/assets.store';
import { handleError } from '$lib/utils/handle-error';
import { get } from 'svelte/store';
import { mdiTimerSand, mdiSelectAll } from '@mdi/js';
import { type AssetStore, isSelectingAllAssets } from '$lib/stores/assets.store';
import { mdiSelectAll, mdiTimerSand } from '@mdi/js';
import { selectAllAssets } from '$lib/utils/asset-utils';

export let assetStore: AssetStore;
export let assetInteractionStore: AssetInteractionStore;

let selecting = false;

const handleSelectAll = async () => {
try {
$isSelectAllCancelled = false;
selecting = true;

const assetGridState = get(assetStore);
for (const bucket of assetGridState.buckets) {
if ($isSelectAllCancelled) {
break;
}
await assetStore.loadBucket(bucket.bucketDate, BucketPosition.Unknown);
for (const asset of bucket.assets) {
assetInteractionStore.selectAsset(asset);
}
}
await selectAllAssets(assetStore, assetInteractionStore);
};

selecting = false;
} catch (error) {
handleError(error, 'Error selecting all assets');
}
const handleCancel = () => {
$isSelectingAllAssets = false;
};
</script>

{#if selecting}
<CircleIconButton title="Delete" icon={mdiTimerSand} />
{/if}
{#if !selecting}
{#if $isSelectingAllAssets}
<CircleIconButton title="Cancel" icon={mdiTimerSand} on:click={handleCancel} />
{:else}
<CircleIconButton title="Select all" icon={mdiSelectAll} on:click={handleSelectAll} />
{/if}
16 changes: 12 additions & 4 deletions web/src/lib/components/photos-page/asset-grid.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
import { AppRoute, AssetAction } from '$lib/constants';
import type { AssetInteractionStore } from '$lib/stores/asset-interaction.store';
import { assetViewingStore } from '$lib/stores/asset-viewing.store';
import { BucketPosition, type AssetStore, type Viewport } from '$lib/stores/assets.store';
import { BucketPosition, isSelectingAllAssets, type AssetStore, type Viewport } from '$lib/stores/assets.store';
import { locale, showDeleteModal } from '$lib/stores/preferences.store';
import { isSearchEnabled } from '$lib/stores/search.store';
import { featureFlags } from '$lib/stores/server-config.store';
import { deleteAssets } from '$lib/utils/actions';
import { shortcuts, type ShortcutOptions, matchesShortcut } from '$lib/utils/shortcut';
import { type ShortcutOptions, shortcuts } from '$lib/utils/shortcut';
import { formatGroupTitle, splitBucketIntoDateGroups } from '$lib/utils/timeline-util';
import type { AlbumResponseDto, AssetResponseDto } from '@immich/sdk';
import { DateTime } from 'luxon';
Expand All @@ -20,6 +20,7 @@
import AssetDateGroup from './asset-date-group.svelte';
import DeleteAssetDialog from './delete-asset-dialog.svelte';
import { handlePromiseError } from '$lib/utils';
import { selectAllAssets } from '$lib/utils/asset-utils';

export let isSelectionMode = false;
export let singleSelect = false;
Expand Down Expand Up @@ -93,12 +94,14 @@
{ shortcut: { key: 'Escape' }, onShortcut: () => dispatch('escape') },
{ shortcut: { key: '?', shift: true }, onShortcut: () => (showShortcuts = !showShortcuts) },
{ shortcut: { key: '/' }, onShortcut: () => goto(AppRoute.EXPLORE) },
{ shortcut: { key: 'A', ctrl: true }, onShortcut: () => selectAllAssets(assetStore, assetInteractionStore) },
];

if ($isMultiSelectState) {
shortcuts.push(
{ shortcut: { key: 'Delete' }, onShortcut: onDelete },
{ shortcut: { key: 'Delete', shift: true }, onShortcut: onForceDelete },
{ shortcut: { key: 'D', ctrl: true }, onShortcut: () => deselectAllAssets() },
);
}

Expand Down Expand Up @@ -202,12 +205,17 @@

let shiftKeyIsDown = false;

const deselectAllAssets = () => {
$isSelectingAllAssets = false;
assetInteractionStore.clearMultiselect();
};

const onKeyDown = (event: KeyboardEvent) => {
if ($isSearchEnabled) {
return;
}

if (matchesShortcut(event, { key: 'Shift', shift: true })) {
if (event.key === 'Shift') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we reverting back to the previous implementation here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked that already and it handles edge cases better: #8105 (comment)

event.preventDefault();
shiftKeyIsDown = true;
}
Expand All @@ -218,7 +226,7 @@
return;
}

if (matchesShortcut(event, { key: 'Shift', shift: false })) {
if (event.key === 'Shift') {
event.preventDefault();
shiftKeyIsDown = false;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import CircleIconButton from '../elements/buttons/circle-icon-button.svelte';
import { fly } from 'svelte/transition';
import { mdiClose } from '@mdi/js';
import { isSelectAllCancelled } from '$lib/stores/assets.store';
import { isSelectingAllAssets } from '$lib/stores/assets.store';

export let showBackButton = true;
export let backIcon = mdiClose;
Expand All @@ -31,7 +31,7 @@
};

const handleClose = () => {
$isSelectAllCancelled = true;
$isSelectingAllAssets = false;
dispatch('close');
};

Expand Down
9 changes: 9 additions & 0 deletions web/src/lib/stores/asset-interaction.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { derived, writable } from 'svelte/store';

export interface AssetInteractionStore {
selectAsset: (asset: AssetResponseDto) => void;
selectAssets: (assets: AssetResponseDto[]) => void;
removeAssetFromMultiselectGroup: (asset: AssetResponseDto) => void;
addGroupToMultiselectGroup: (group: string) => void;
removeGroupFromMultiselectGroup: (group: string) => void;
Expand Down Expand Up @@ -76,6 +77,13 @@ export function createAssetInteractionStore(): AssetInteractionStore {
selectedAssets.set(_selectedAssets);
};

const selectAssets = (assets: AssetResponseDto[]) => {
for (const asset of assets) {
_selectedAssets.add(asset);
}
selectedAssets.set(_selectedAssets);
};

const removeAssetFromMultiselectGroup = (asset: AssetResponseDto) => {
_selectedAssets.delete(asset);
selectedAssets.set(_selectedAssets);
Expand Down Expand Up @@ -123,6 +131,7 @@ export function createAssetInteractionStore(): AssetInteractionStore {

return {
selectAsset,
selectAssets,
removeAssetFromMultiselectGroup,
addGroupToMultiselectGroup,
removeGroupFromMultiselectGroup,
Expand Down
2 changes: 1 addition & 1 deletion web/src/lib/stores/assets.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -517,4 +517,4 @@ export class AssetStore {
}
}

export const isSelectAllCancelled = writable(false);
export const isSelectingAllAssets = writable(false);
32 changes: 32 additions & 0 deletions web/src/lib/utils/asset-utils.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { notificationController, NotificationType } from '$lib/components/shared-components/notification/notification';
import type { AssetInteractionStore } from '$lib/stores/asset-interaction.store';
import { BucketPosition, isSelectingAllAssets, type AssetStore } from '$lib/stores/assets.store';
import { downloadManager } from '$lib/stores/download';
import { downloadRequest, getKey } from '$lib/utils';
import {
Expand All @@ -13,6 +15,7 @@ import {
type UserResponseDto,
} from '@immich/sdk';
import { DateTime } from 'luxon';
import { get } from 'svelte/store';
import { handleError } from './handle-error';

export const addAssetsToAlbum = async (albumId: string, assetIds: Array<string>): Promise<BulkIdResponseDto[]> =>
Expand Down Expand Up @@ -224,6 +227,35 @@ export const getSelectedAssets = (assets: Set<AssetResponseDto>, user: UserRespo
return ids;
};

export const selectAllAssets = async (assetStore: AssetStore, assetInteractionStore: AssetInteractionStore) => {
Ethan13310 marked this conversation as resolved.
Show resolved Hide resolved
if (get(isSelectingAllAssets)) {
// Selection is already ongoing
return;
}
isSelectingAllAssets.set(true);

try {
for (const bucket of assetStore.buckets) {
await assetStore.loadBucket(bucket.bucketDate, BucketPosition.Unknown);

if (!get(isSelectingAllAssets)) {
break; // Cancelled
}
assetInteractionStore.selectAssets(bucket.assets);

// We use setTimeout to allow the UI to update. Otherwise, this may
// cause a long delay between the start of 'select all' and the
// effective update of the UI, depending on the number of assets
// to select
await delay(0);
}
} catch (error) {
handleError(error, 'Error selecting all assets');
} finally {
isSelectingAllAssets.set(false);
}
};

export const delay = async (ms: number) => {
return new Promise((resolve) => setTimeout(resolve, ms));
};
Loading