feat(web): improve UI/UX for settings pages (#12626)

* fix(web): local date time for buckets

* feat(web): improve UI/UX for setting pages

* search admin settings and icon

* clean up

* fix translation file

* Update web/src/routes/admin/system-settings/+page.svelte

Co-authored-by: Ben <45583362+ben-basten@users.noreply.github.com>

* Update web/src/lib/components/shared-components/settings/setting-accordion.svelte

Co-authored-by: Ben <45583362+ben-basten@users.noreply.github.com>

* better search bar on smaller screen

* lint

* template syntax

---------

Co-authored-by: Jason Rasmussen <jason@rasm.me>
Co-authored-by: Ben <45583362+ben-basten@users.noreply.github.com>
This commit is contained in:
Alex 2024-09-16 15:51:03 -05:00 committed by GitHub
parent b74b20824a
commit 186b4e1333
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 126 additions and 20 deletions

View File

@ -71,7 +71,7 @@
<div> <div>
<div in:fade={{ duration: 500 }}> <div in:fade={{ duration: 500 }}>
<form autocomplete="off" on:submit|preventDefault> <form autocomplete="off" on:submit|preventDefault>
<div class="ml-4 mt-4 flex flex-col gap-4"> <div class="ml-4 mt-4 flex flex-col">
<SettingAccordion <SettingAccordion
key="oauth" key="oauth"
title={$t('admin.oauth_settings')} title={$t('admin.oauth_settings')}

View File

@ -2,6 +2,7 @@
import { slide } from 'svelte/transition'; import { slide } from 'svelte/transition';
import { getAccordionState } from './setting-accordion-state.svelte'; import { getAccordionState } from './setting-accordion-state.svelte';
import { onDestroy } from 'svelte'; import { onDestroy } from 'svelte';
import Icon from '$lib/components/elements/icon.svelte';
const accordionState = getAccordionState(); const accordionState = getAccordionState();
@ -10,6 +11,7 @@
export let key: string; export let key: string;
export let isOpen = $accordionState.has(key); export let isOpen = $accordionState.has(key);
export let autoScrollTo = false; export let autoScrollTo = false;
export let icon = '';
let accordionElement: HTMLDivElement; let accordionElement: HTMLDivElement;
@ -38,7 +40,12 @@
}); });
</script> </script>
<div class="border-b-[1px] border-gray-200 py-4 dark:border-gray-700" bind:this={accordionElement}> <div
class="border rounded-2xl my-4 px-6 py-4 transition-all {isOpen
? 'border-immich-primary/40 dark:border-immich-dark-primary/50 shadow-md'
: 'dark:border-gray-800'}"
bind:this={accordionElement}
>
<button <button
type="button" type="button"
aria-expanded={isOpen} aria-expanded={isOpen}
@ -46,12 +53,17 @@
class="flex w-full place-items-center justify-between text-left" class="flex w-full place-items-center justify-between text-left"
> >
<div> <div>
<h2 class="font-medium text-immich-primary dark:text-immich-dark-primary"> <div class="flex gap-2 place-items-center">
{title} {#if icon}
</h2> <Icon path={icon} class="text-immich-primary dark:text-immich-dark-primary" size="24" ariaHidden />
{/if}
<h2 class="font-medium text-immich-primary dark:text-immich-dark-primary">
{title}
</h2>
</div>
<slot name="subtitle"> <slot name="subtitle">
<p class="text-sm dark:text-immich-dark-fg">{subtitle}</p> <p class="text-sm dark:text-immich-dark-fg mt-1">{subtitle}</p>
</slot> </slot>
</div> </div>

View File

@ -55,7 +55,7 @@
<section class="my-4"> <section class="my-4">
<div in:fade={{ duration: 500 }}> <div in:fade={{ duration: 500 }}>
<form autocomplete="off" on:submit|preventDefault> <form autocomplete="off" on:submit|preventDefault>
<div class="ml-4 mt-4 flex flex-col gap-4"> <div class="ml-4 mt-4 flex flex-col">
<SettingAccordion key="folders" title={$t('folders')} subtitle={$t('folders_feature_description')}> <SettingAccordion key="folders" title={$t('folders')} subtitle={$t('folders_feature_description')}>
<div class="ml-4 mt-6"> <div class="ml-4 mt-6">
<SettingSwitch title={$t('enable')} bind:checked={foldersEnabled} /> <SettingSwitch title={$t('enable')} bind:checked={foldersEnabled} />

View File

@ -19,6 +19,19 @@
import DownloadSettings from '$lib/components/user-settings-page/download-settings.svelte'; import DownloadSettings from '$lib/components/user-settings-page/download-settings.svelte';
import UserPurchaseSettings from '$lib/components/user-settings-page/user-purchase-settings.svelte'; import UserPurchaseSettings from '$lib/components/user-settings-page/user-purchase-settings.svelte';
import FeatureSettings from '$lib/components/user-settings-page/feature-settings.svelte'; import FeatureSettings from '$lib/components/user-settings-page/feature-settings.svelte';
import {
mdiAccountGroupOutline,
mdiAccountOutline,
mdiApi,
mdiBellOutline,
mdiCogOutline,
mdiDevices,
mdiDownload,
mdiFeatureSearchOutline,
mdiKeyOutline,
mdiOnepassword,
mdiTwoFactorAuthentication,
} from '@mdi/js';
export let keys: ApiKeyResponseDto[] = []; export let keys: ApiKeyResponseDto[] = [];
export let sessions: SessionResponseDto[] = []; export let sessions: SessionResponseDto[] = [];
@ -29,23 +42,34 @@
</script> </script>
<SettingAccordionState queryParam={QueryParameter.IS_OPEN}> <SettingAccordionState queryParam={QueryParameter.IS_OPEN}>
<SettingAccordion key="app-settings" title={$t('app_settings')} subtitle={$t('manage_the_app_settings')}> <SettingAccordion
icon={mdiCogOutline}
key="app-settings"
title={$t('app_settings')}
subtitle={$t('manage_the_app_settings')}
>
<AppSettings /> <AppSettings />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="account" title={$t('account')} subtitle={$t('manage_your_account')}> <SettingAccordion icon={mdiAccountOutline} key="account" title={$t('account')} subtitle={$t('manage_your_account')}>
<UserProfileSettings /> <UserProfileSettings />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="api-keys" title={$t('api_keys')} subtitle={$t('manage_your_api_keys')}> <SettingAccordion icon={mdiApi} key="api-keys" title={$t('api_keys')} subtitle={$t('manage_your_api_keys')}>
<UserAPIKeyList bind:keys /> <UserAPIKeyList bind:keys />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="authorized-devices" title={$t('authorized_devices')} subtitle={$t('manage_your_devices')}> <SettingAccordion
icon={mdiDevices}
key="authorized-devices"
title={$t('authorized_devices')}
subtitle={$t('manage_your_devices')}
>
<DeviceList bind:devices={sessions} /> <DeviceList bind:devices={sessions} />
</SettingAccordion> </SettingAccordion>
<SettingAccordion <SettingAccordion
icon={mdiDownload}
key="download-settings" key="download-settings"
title={$t('download_settings')} title={$t('download_settings')}
subtitle={$t('download_settings_description')} subtitle={$t('download_settings_description')}
@ -53,16 +77,27 @@
<DownloadSettings /> <DownloadSettings />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="feature" title={$t('features')} subtitle={$t('features_setting_description')}> <SettingAccordion
icon={mdiFeatureSearchOutline}
key="feature"
title={$t('features')}
subtitle={$t('features_setting_description')}
>
<FeatureSettings /> <FeatureSettings />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="notifications" title={$t('notifications')} subtitle={$t('notifications_setting_description')}> <SettingAccordion
icon={mdiBellOutline}
key="notifications"
title={$t('notifications')}
subtitle={$t('notifications_setting_description')}
>
<NotificationsSettings /> <NotificationsSettings />
</SettingAccordion> </SettingAccordion>
{#if $featureFlags.loaded && $featureFlags.oauth} {#if $featureFlags.loaded && $featureFlags.oauth}
<SettingAccordion <SettingAccordion
icon={mdiTwoFactorAuthentication}
key="oauth" key="oauth"
title={$t('oauth')} title={$t('oauth')}
subtitle={$t('manage_your_oauth_connection')} subtitle={$t('manage_your_oauth_connection')}
@ -72,15 +107,21 @@
</SettingAccordion> </SettingAccordion>
{/if} {/if}
<SettingAccordion key="password" title={$t('password')} subtitle={$t('change_your_password')}> <SettingAccordion icon={mdiOnepassword} key="password" title={$t('password')} subtitle={$t('change_your_password')}>
<ChangePasswordSettings /> <ChangePasswordSettings />
</SettingAccordion> </SettingAccordion>
<SettingAccordion key="partner-sharing" title={$t('partner_sharing')} subtitle={$t('manage_sharing_with_partners')}> <SettingAccordion
icon={mdiAccountGroupOutline}
key="partner-sharing"
title={$t('partner_sharing')}
subtitle={$t('manage_sharing_with_partners')}
>
<PartnerSettings user={$user} /> <PartnerSettings user={$user} />
</SettingAccordion> </SettingAccordion>
<SettingAccordion <SettingAccordion
icon={mdiKeyOutline}
key="user-purchase-settings" key="user-purchase-settings"
title={$t('user_purchase_settings')} title={$t('user_purchase_settings')}
subtitle={$t('user_purchase_settings_description')} subtitle={$t('user_purchase_settings_description')}

View File

@ -1080,6 +1080,7 @@
"search_options": "Search options", "search_options": "Search options",
"search_people": "Search people", "search_people": "Search people",
"search_places": "Search places", "search_places": "Search places",
"search_settings": "Search settings",
"search_state": "Search state...", "search_state": "Search state...",
"search_tags": "Search tags...", "search_tags": "Search tags...",
"search_timezone": "Search timezone...", "search_timezone": "Search timezone...",

View File

@ -27,11 +27,33 @@
import { copyToClipboard } from '$lib/utils'; import { copyToClipboard } from '$lib/utils';
import { downloadBlob } from '$lib/utils/asset-utils'; import { downloadBlob } from '$lib/utils/asset-utils';
import type { SystemConfigDto } from '@immich/sdk'; import type { SystemConfigDto } from '@immich/sdk';
import { mdiAlert, mdiContentCopy, mdiDownload, mdiUpload } from '@mdi/js'; import {
mdiAccountOutline,
mdiAlert,
mdiBellOutline,
mdiBookshelf,
mdiContentCopy,
mdiDatabaseOutline,
mdiDownload,
mdiFileDocumentOutline,
mdiFolderOutline,
mdiImageOutline,
mdiLockOutline,
mdiMapMarkerOutline,
mdiPaletteOutline,
mdiRobotOutline,
mdiServerOutline,
mdiSync,
mdiTrashCanOutline,
mdiUpdate,
mdiUpload,
mdiVideoOutline,
} from '@mdi/js';
import type { PageData } from './$types'; import type { PageData } from './$types';
import { t } from 'svelte-i18n'; import { t } from 'svelte-i18n';
import type { ComponentType, SvelteComponent } from 'svelte'; import type { ComponentType, SvelteComponent } from 'svelte';
import type { SettingsComponentProps } from '$lib/components/admin-page/settings/admin-settings'; import type { SettingsComponentProps } from '$lib/components/admin-page/settings/admin-settings';
import SearchBar from '$lib/components/elements/search-bar.svelte';
export let data: PageData; export let data: PageData;
@ -68,104 +90,128 @@
title: string; title: string;
subtitle: string; subtitle: string;
key: string; key: string;
icon: string;
}> = [ }> = [
{ {
component: AuthSettings, component: AuthSettings,
title: $t('admin.authentication_settings'), title: $t('admin.authentication_settings'),
subtitle: $t('admin.authentication_settings_description'), subtitle: $t('admin.authentication_settings_description'),
key: 'image', key: 'authentication',
icon: mdiLockOutline,
}, },
{ {
component: ImageSettings, component: ImageSettings,
title: $t('admin.image_settings'), title: $t('admin.image_settings'),
subtitle: $t('admin.image_settings_description'), subtitle: $t('admin.image_settings_description'),
key: 'image', key: 'image',
icon: mdiImageOutline,
}, },
{ {
component: JobSettings, component: JobSettings,
title: $t('admin.job_settings'), title: $t('admin.job_settings'),
subtitle: $t('admin.job_settings_description'), subtitle: $t('admin.job_settings_description'),
key: 'job', key: 'job',
icon: mdiSync,
}, },
{ {
component: MetadataSettings, component: MetadataSettings,
title: $t('admin.metadata_settings'), title: $t('admin.metadata_settings'),
subtitle: $t('admin.metadata_settings_description'), subtitle: $t('admin.metadata_settings_description'),
key: 'metadata', key: 'metadata',
icon: mdiDatabaseOutline,
}, },
{ {
component: LibrarySettings, component: LibrarySettings,
title: $t('admin.library_settings'), title: $t('admin.library_settings'),
subtitle: $t('admin.library_settings_description'), subtitle: $t('admin.library_settings_description'),
key: 'external-library', key: 'external-library',
icon: mdiBookshelf,
}, },
{ {
component: LoggingSettings, component: LoggingSettings,
title: $t('admin.logging_settings'), title: $t('admin.logging_settings'),
subtitle: $t('admin.manage_log_settings'), subtitle: $t('admin.manage_log_settings'),
key: 'logging', key: 'logging',
icon: mdiFileDocumentOutline,
}, },
{ {
component: MachineLearningSettings, component: MachineLearningSettings,
title: $t('admin.machine_learning_settings'), title: $t('admin.machine_learning_settings'),
subtitle: $t('admin.machine_learning_settings_description'), subtitle: $t('admin.machine_learning_settings_description'),
key: 'machine-learning', key: 'machine-learning',
icon: mdiRobotOutline,
}, },
{ {
component: MapSettings, component: MapSettings,
title: $t('admin.map_gps_settings'), title: $t('admin.map_gps_settings'),
subtitle: $t('admin.map_gps_settings_description'), subtitle: $t('admin.map_gps_settings_description'),
key: 'location', key: 'location',
icon: mdiMapMarkerOutline,
}, },
{ {
component: NotificationSettings, component: NotificationSettings,
title: $t('admin.notification_settings'), title: $t('admin.notification_settings'),
subtitle: $t('admin.notification_settings_description'), subtitle: $t('admin.notification_settings_description'),
key: 'notifications', key: 'notifications',
icon: mdiBellOutline,
}, },
{ {
component: ServerSettings, component: ServerSettings,
title: $t('admin.server_settings'), title: $t('admin.server_settings'),
subtitle: $t('admin.server_settings_description'), subtitle: $t('admin.server_settings_description'),
key: 'server', key: 'server',
icon: mdiServerOutline,
}, },
{ {
component: StorageTemplateSettings, component: StorageTemplateSettings,
title: $t('admin.storage_template_settings'), title: $t('admin.storage_template_settings'),
subtitle: $t('admin.storage_template_settings_description'), subtitle: $t('admin.storage_template_settings_description'),
key: 'storage-template', key: 'storage-template',
icon: mdiFolderOutline,
}, },
{ {
component: ThemeSettings, component: ThemeSettings,
title: $t('admin.theme_settings'), title: $t('admin.theme_settings'),
subtitle: $t('admin.theme_settings_description'), subtitle: $t('admin.theme_settings_description'),
key: 'theme', key: 'theme',
icon: mdiPaletteOutline,
}, },
{ {
component: TrashSettings, component: TrashSettings,
title: $t('admin.trash_settings'), title: $t('admin.trash_settings'),
subtitle: $t('admin.trash_settings_description'), subtitle: $t('admin.trash_settings_description'),
key: 'trash', key: 'trash',
icon: mdiTrashCanOutline,
}, },
{ {
component: UserSettings, component: UserSettings,
title: $t('admin.user_settings'), title: $t('admin.user_settings'),
subtitle: $t('admin.user_settings_description'), subtitle: $t('admin.user_settings_description'),
key: 'user-settings', key: 'user-settings',
icon: mdiAccountOutline,
}, },
{ {
component: NewVersionCheckSettings, component: NewVersionCheckSettings,
title: $t('admin.version_check_settings'), title: $t('admin.version_check_settings'),
subtitle: $t('admin.version_check_settings_description'), subtitle: $t('admin.version_check_settings_description'),
key: 'version-check', key: 'version-check',
icon: mdiUpdate,
}, },
{ {
component: FFmpegSettings, component: FFmpegSettings,
title: $t('admin.transcoding_settings'), title: $t('admin.transcoding_settings'),
subtitle: $t('admin.transcoding_settings_description'), subtitle: $t('admin.transcoding_settings_description'),
key: 'video-transcoding', key: 'video-transcoding',
icon: mdiVideoOutline,
}, },
]; ];
let searchQuery = '';
$: filteredSettings = settings.filter(({ title, subtitle }) => {
const query = searchQuery.toLowerCase();
return title.toLowerCase().includes(query) || subtitle.toLowerCase().includes(query);
});
</script> </script>
<input bind:this={inputElement} type="file" accept=".json" style="display: none" on:change={uploadConfig} /> <input bind:this={inputElement} type="file" accept=".json" style="display: none" on:change={uploadConfig} />
@ -182,6 +228,9 @@
<UserPageLayout title={data.meta.title} admin> <UserPageLayout title={data.meta.title} admin>
<div class="flex justify-end gap-2" slot="buttons"> <div class="flex justify-end gap-2" slot="buttons">
<div class="hidden lg:block">
<SearchBar placeholder={$t('search_settings')} bind:name={searchQuery} showLoadingSpinner={false} />
</div>
<LinkButton on:click={() => copyToClipboard(JSON.stringify(config, null, 2))}> <LinkButton on:click={() => copyToClipboard(JSON.stringify(config, null, 2))}>
<div class="flex place-items-center gap-2 text-sm"> <div class="flex place-items-center gap-2 text-sm">
<Icon path={mdiContentCopy} size="18" /> <Icon path={mdiContentCopy} size="18" />
@ -206,10 +255,13 @@
<AdminSettings bind:config let:handleReset bind:handleSave let:savedConfig let:defaultConfig> <AdminSettings bind:config let:handleReset bind:handleSave let:savedConfig let:defaultConfig>
<section id="setting-content" class="flex place-content-center sm:mx-4"> <section id="setting-content" class="flex place-content-center sm:mx-4">
<section class="w-full pb-28 sm:w-5/6 md:w-[850px]"> <section class="w-full pb-28 sm:w-5/6 md:w-[896px]">
<div class="block lg:hidden">
<SearchBar placeholder={$t('search_settings')} bind:name={searchQuery} showLoadingSpinner={false} />
</div>
<SettingAccordionState queryParam={QueryParameter.IS_OPEN}> <SettingAccordionState queryParam={QueryParameter.IS_OPEN}>
{#each settings as { component: Component, title, subtitle, key }} {#each filteredSettings as { component: Component, title, subtitle, key, icon } (key)}
<SettingAccordion {title} {subtitle} {key}> <SettingAccordion {title} {subtitle} {key} {icon}>
<Component <Component
onSave={(config) => handleSave(config)} onSave={(config) => handleSave(config)}
onReset={(options) => handleReset(options)} onReset={(options) => handleReset(options)}