Skip to content

A community-supported supercharged document management system: scan, index and archive all your documents

Enhancement: customize sidebar items (#14052)

shamoon2d6468404323
diff --git a/src-ui/src/app/components/admin/settings/settings.component.html b/src-ui/src/app/components/admin/settings/settings.component.html
index 305bb8a96..b520e8218 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.html
+++ b/src-ui/src/app/components/admin/settings/settings.component.html
@@ -112,6 +112,22 @@
<pngx-input-check i18n-title title="Use 'slim' sidebar (icons only)" formControlName="slimSidebarEnabled"></pngx-input-check>
+ <p class="mb-2 mt-3" i18n>Sidebar items to show:</p>
+ @for (option of sidebarItemOptions; track option.id) {
+ <div class="form-check">
+ <input
+ class="form-check-input"
+ type="checkbox"
+ [id]="'sidebar-item-setting-' + option.id"
+ [checked]="isSidebarItemShown(option.id)"
+ (change)="toggleSidebarItem(option.id, $event.target.checked)"
+ />
+ <label class="form-check-label" [for]="'sidebar-item-setting-' + option.id">
+ {{ option.label }}
+ </label>
+ </div>
+ }
+
</div>
</div>
diff --git a/src-ui/src/app/components/admin/settings/settings.component.spec.ts b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
index 7b65281d0..71889e74b 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.spec.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
@@ -24,7 +24,7 @@ import {
SystemStatus,
SystemStatusItemStatus,
} from 'src/app/data/system-status'
-import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { HideableSidebarItemID, SETTINGS_KEYS } from 'src/app/data/ui-settings'
import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
@@ -209,6 +209,45 @@ describe('SettingsComponent', () => {
fixture.detectChanges()
}
+ it('supports configuring sidebar items and canceling changes', () => {
+ completeSetup()
+
+ component.toggleSidebarItem(HideableSidebarItemID.Workflows, false)
+ fixture.detectChanges()
+
+ expect(component.settingsForm.value.sidebarHiddenItems).toContain(
+ HideableSidebarItemID.Workflows
+ )
+
+ settingsService.updateSidebarItemVisibility(
+ HideableSidebarItemID.Mail,
+ false
+ )
+
+ expect(component.settingsForm.value.sidebarHiddenItems).toContain(
+ HideableSidebarItemID.Mail
+ )
+
+ component.reset()
+
+ expect(component.settingsForm.value.sidebarHiddenItems).not.toContain(
+ HideableSidebarItemID.Workflows
+ )
+ expect(component.settingsForm.value.sidebarHiddenItems).not.toContain(
+ HideableSidebarItemID.Mail
+ )
+ })
+
+ it('enables sidebar item controls on general settings until destroyed', () => {
+ completeSetup()
+
+ expect(settingsService.organizingSidebarItems()).toBe(true)
+
+ component.ngOnDestroy()
+
+ expect(settingsService.organizingSidebarItems()).toBe(false)
+ })
+
it('should support tabbed settings & change URL, prevent navigation if dirty confirmation rejected', async () => {
completeSetup()
const navigateSpy = jest.spyOn(router, 'navigate')
@@ -249,6 +288,7 @@ describe('SettingsComponent', () => {
it('should support save local settings updating appearance settings and calling API, show error', () => {
completeSetup()
+ component.toggleSidebarItem(HideableSidebarItemID.Workflows, false)
const toastErrorSpy = jest.spyOn(toastService, 'showError')
const toastSpy = jest.spyOn(toastService, 'show')
const storeSpy = jest.spyOn(settingsService, 'storeSettings')
@@ -267,7 +307,10 @@ describe('SettingsComponent', () => {
expect(toastErrorSpy).toHaveBeenCalled()
expect(storeSpy).toHaveBeenCalled()
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
- expect(setSpy).toHaveBeenCalledTimes(33)
+ expect(setSpy).toHaveBeenCalledTimes(34)
+ expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+ HideableSidebarItemID.Workflows,
+ ])
// succeed
storeSpy.mockReturnValueOnce(of(true))
diff --git a/src-ui/src/app/components/admin/settings/settings.component.ts b/src-ui/src/app/components/admin/settings/settings.component.ts
index 218f6683c..9076d2a3e 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.ts
@@ -39,7 +39,12 @@ import {
SystemStatus,
SystemStatusItemStatus,
} from 'src/app/data/system-status'
-import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import {
+ GlobalSearchType,
+ HIDEABLE_SIDEBAR_ITEM_IDS,
+ HideableSidebarItemID,
+ SETTINGS_KEYS,
+} from 'src/app/data/ui-settings'
import { User } from 'src/app/data/user'
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
@@ -102,6 +107,14 @@ const documentDetailFieldOptions = [
{ id: DocumentDetailFieldID.Tags, label: $localize`Tags` },
]
+const sidebarItemLabels: Record<HideableSidebarItemID, string> = {
+ [HideableSidebarItemID.Dashboard]: $localize`Dashboard`,
+ [HideableSidebarItemID.SavedViews]: $localize`Saved Views`,
+ [HideableSidebarItemID.Workflows]: $localize`Workflows`,
+ [HideableSidebarItemID.Mail]: $localize`Mail`,
+ [HideableSidebarItemID.Documentation]: $localize`Documentation`,
+}
+
@Component({
selector: 'pngx-settings',
templateUrl: './settings.component.html',
@@ -149,6 +162,7 @@ export class SettingsComponent
bulkEditApplyOnClose: new FormControl(null),
documentListItemPerPage: new FormControl(null),
slimSidebarEnabled: new FormControl(null),
+ sidebarHiddenItems: new FormControl<HideableSidebarItemID[]>([]),
darkModeUseSystem: new FormControl(null),
darkModeEnabled: new FormControl(null),
darkModeInvertThumbs: new FormControl(null),
@@ -186,6 +200,7 @@ export class SettingsComponent
store: BehaviorSubject<any>
storeSub: Subscription
+ sidebarItemsSub: Subscription
isDirty$: Observable<boolean>
isDirty: boolean = false
unsubscribeNotifier: Subject<any> = new Subject()
@@ -203,6 +218,10 @@ export class SettingsComponent
public readonly PdfEditorEditMode = PdfEditorEditMode
public readonly documentDetailFieldOptions = documentDetailFieldOptions
+ public readonly sidebarItemOptions = HIDEABLE_SIDEBAR_ITEM_IDS.map((id) => ({
+ id,
+ label: sidebarItemLabels[id],
+ }))
get systemStatusHasErrors(): boolean {
const status = this.systemStatus()
@@ -230,6 +249,10 @@ export class SettingsComponent
constructor() {
super()
+ this.sidebarItemsSub =
+ this.settings.sidebarHiddenItemsEditingChanged.subscribe((hiddenItems) =>
+ this.settingsForm.controls.sidebarHiddenItems.setValue(hiddenItems)
+ )
this.settings.settingsSaved.subscribe(() => {
if (!this.savePending) this.initialize()
this.savedViewsService.maybeRefreshDocumentCounts()
@@ -279,14 +302,21 @@ export class SettingsComponent
this.activatedRoute.paramMap.subscribe((paramMap) => {
const section = paramMap.get('section')
+ let navID = SettingsNavIDs.General
if (section) {
const navIDKey: string = Object.keys(SettingsNavIDs).find(
(navID) => navID.toLowerCase() == section
)
if (navIDKey) {
- this.activeNavID.set(SettingsNavIDs[navIDKey])
+ navID = SettingsNavIDs[navIDKey]
}
}
+ this.activeNavID.set(navID)
+ this.settings.sidebarHiddenItemsEditing.set(
+ navID === SettingsNavIDs.General
+ ? [...this.settingsForm.controls.sidebarHiddenItems.value]
+ : null
+ )
})
}
@@ -310,6 +340,7 @@ export class SettingsComponent
SETTINGS_KEYS.DOCUMENT_LIST_SIZE
),
slimSidebarEnabled: this.settings.get(SETTINGS_KEYS.SLIM_SIDEBAR),
+ sidebarHiddenItems: this.settings.get(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS),
darkModeUseSystem: this.settings.get(SETTINGS_KEYS.DARK_MODE_USE_SYSTEM),
darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED),
darkModeInvertThumbs: this.settings.get(
@@ -436,6 +467,12 @@ export class SettingsComponent
this.settingsForm.patchValue(currentFormValue)
}
+ if (this.settings.organizingSidebarItems()) {
+ this.settings.sidebarHiddenItemsEditing.set([
+ ...this.settingsForm.controls.sidebarHiddenItems.value,
+ ])
+ }
+
if (this.canViewSystemStatus) {
this.systemStatusService.get().subscribe((status) => {
this.systemStatus.set(status)
@@ -444,8 +481,18 @@ export class SettingsComponent
}
ngOnDestroy() {
+ this.settings.sidebarHiddenItemsEditing.set(null)
if (this.isDirty) this.settings.updateAppearanceSettings() // in case user changed appearance but didn't save
this.storeSub && this.storeSub.unsubscribe()
+ this.sidebarItemsSub.unsubscribe()
+ }
+
+ isSidebarItemShown(item: HideableSidebarItemID): boolean {
+ return !(this.settingsForm.value.sidebarHiddenItems || []).includes(item)
+ }
+
+ toggleSidebarItem(item: HideableSidebarItemID, checked: boolean): void {
+ this.settings.updateSidebarItemVisibility(item, checked)
}
public saveSettings() {
@@ -473,6 +520,10 @@ export class SettingsComponent
SETTINGS_KEYS.SLIM_SIDEBAR,
this.settingsForm.value.slimSidebarEnabled
)
+ this.settings.set(
+ SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS,
+ this.settingsForm.value.sidebarHiddenItems
+ )
this.settings.set(
SETTINGS_KEYS.DARK_MODE_USE_SYSTEM,
this.settingsForm.value.darkModeUseSystem
@@ -632,6 +683,11 @@ export class SettingsComponent
reset() {
this.settingsForm.patchValue(this.store.getValue())
+ if (this.settings.organizingSidebarItems()) {
+ this.settings.sidebarHiddenItemsEditing.set([
+ ...this.settingsForm.controls.sidebarHiddenItems.value,
+ ])
+ }
}
clearThemeColor() {
diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html
index 6faddbb8a..a8dd12d34 100644
--- a/src-ui/src/app/components/app-frame/app-frame.component.html
+++ b/src-ui/src/app/components/app-frame/app-frame.component.html
@@ -86,12 +86,15 @@
}
<div class="sidebar-sticky pt-3 pb-1 d-flex flex-column justify-space-around">
<ul class="nav flex-column">
- <li class="nav-item app-link">
- <a class="nav-link" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()"
+ <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard) && !settingsService.organizingSidebarItems()">
+ <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()"
ngbPopover="Dashboard" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
<i-bs class="me-2" name="house"></i-bs><span class="nav-link-label"><ng-container i18n>Dashboard</ng-container></span>
</a>
+ @if (settingsService.organizingSidebarItems()) {
+ <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Dashboard" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Dashboard, $event)"></pngx-input-switch>
+ }
</li>
<li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Document }">
<a class="nav-link" routerLink="documents" routerLinkActive="active"
@@ -237,29 +240,38 @@
</div>
</li>
}
- <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.SavedView }">
- <a class="nav-link" routerLink="savedviews" routerLinkActive="active" (click)="closeMenu()"
+ <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.SavedView }">
+ <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="savedviews" routerLinkActive="active" (click)="closeMenu()"
ngbPopover="Saved Views" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
<i-bs class="me-2" name="window-stack"></i-bs><span class="nav-link-label"><ng-container i18n>Saved Views</ng-container></span>
</a>
+ @if (settingsService.organizingSidebarItems()) {
+ <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Saved Views" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.SavedViews, $event)"></pngx-input-switch>
+ }
</li>
- <li class="nav-item app-link"
+ <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows) && !settingsService.organizingSidebarItems()"
*pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Workflow }"
tourAnchor="tour.workflows">
- <a class="nav-link" routerLink="workflows" routerLinkActive="active" (click)="closeMenu()"
+ <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="workflows" routerLinkActive="active" (click)="closeMenu()"
ngbPopover="Workflows" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
<i-bs class="me-2" name="boxes"></i-bs><span class="nav-link-label"><ng-container i18n>Workflows</ng-container></span>
</a>
+ @if (settingsService.organizingSidebarItems()) {
+ <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Workflows" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Workflows, $event)"></pngx-input-switch>
+ }
</li>
- <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
+ <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
tourAnchor="tour.mail">
- <a class="nav-link" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
+ <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end" container="body"
triggers="mouseenter:mouseleave" popoverClass="popover-slim">
<i-bs class="me-2" name="envelope"></i-bs><span class="nav-link-label"><ng-container i18n>Mail</ng-container></span>
</a>
+ @if (settingsService.organizingSidebarItems()) {
+ <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Mail" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Mail, $event)"></pngx-input-switch>
+ }
</li>
<li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.Document }">
<a class="nav-link" routerLink="trash" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Trash"
@@ -322,13 +334,16 @@
</a>
</li>
}
- <li class="nav-item mt-2" tourAnchor="tour.outro">
- <a class="text-muted small d-flex align-items-center flex-wrap text-decoration-none nav-anchor"
+ <li class="nav-item mt-2 position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation) && !settingsService.organizingSidebarItems()" tourAnchor="tour.outro">
+ <a class="text-muted small d-flex align-items-center flex-wrap text-decoration-none nav-anchor" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()"
target="_blank" rel="noopener noreferrer" href="https://docs.paperless-ngx.com" ngbPopover="Documentation"
i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end" container="body"
triggers="mouseenter:mouseleave" popoverClass="popover-slim">
<i-bs class="d-flex me-2" name="question-circle"></i-bs><span><ng-container i18n>Documentation</ng-container></span>
</a>
+ @if (settingsService.organizingSidebarItems()) {
+ <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Documentation" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Documentation, $event)"></pngx-input-switch>
+ }
</li>
<li class="nav-item" [class.visually-hidden]="slimSidebarEnabled">
<div class="text-muted small d-flex align-items-center flex-wrap nav-label">
diff --git a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts
index d9b1acda4..4dd88c84d 100644
--- a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts
+++ b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts
@@ -15,7 +15,7 @@ import { provideUiTour } from 'ngx-ui-tour-ng-bootstrap'
import { of, throwError } from 'rxjs'
import { routes } from 'src/app/app-routing.module'
import { SavedView } from 'src/app/data/saved-view'
-import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { HideableSidebarItemID, SETTINGS_KEYS } from 'src/app/data/ui-settings'
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
import {
@@ -287,6 +287,82 @@ describe('AppFrameComponent', () => {
jest.useRealTimers()
})
+ it('should hide configured sidebar items', () => {
+ settingsService.set(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+ HideableSidebarItemID.Dashboard,
+ HideableSidebarItemID.Workflows,
+ ])
+ fixture.detectChanges()
+
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="dashboard"]')
+ .parentElement.classList
+ ).toContain('d-none')
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="workflows"]')
+ .parentElement.classList
+ ).toContain('d-none')
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="mail"]').parentElement
+ .classList
+ ).not.toContain('d-none')
+ })
+
+ it('should show hidden items and visibility switches while customizing', () => {
+ settingsService.set(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+ HideableSidebarItemID.Dashboard,
+ ])
+ settingsService.sidebarHiddenItemsEditing.set([
+ HideableSidebarItemID.Dashboard,
+ ])
+ fixture.detectChanges()
+
+ expect(
+ fixture.nativeElement.querySelectorAll('pngx-input-switch').length
+ ).toBe(5)
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="dashboard"]')
+ .parentElement.classList
+ ).not.toContain('d-none')
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+ ).toContain('opacity-50')
+
+ settingsService.set(SETTINGS_KEYS.SLIM_SIDEBAR, true)
+ fixture.detectChanges()
+
+ expect(
+ Array.from(
+ fixture.nativeElement.querySelectorAll('pngx-input-switch')
+ ).every((toggle: HTMLElement) => toggle.classList.contains('d-none'))
+ ).toBe(true)
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+ ).not.toContain('pe-5')
+
+ settingsService.set(SETTINGS_KEYS.SLIM_SIDEBAR, false)
+ component.slimSidebarAnimating.set(true)
+ fixture.detectChanges()
+
+ expect(
+ Array.from(
+ fixture.nativeElement.querySelectorAll('pngx-input-switch')
+ ).every((toggle: HTMLElement) => toggle.classList.contains('d-none'))
+ ).toBe(true)
+
+ component.slimSidebarAnimating.set(false)
+ fixture.detectChanges()
+
+ expect(
+ Array.from(
+ fixture.nativeElement.querySelectorAll('pngx-input-switch')
+ ).every((toggle: HTMLElement) => !toggle.classList.contains('d-none'))
+ ).toBe(true)
+ expect(
+ fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+ ).toContain('pe-5')
+ })
+
it('should show error on toggle slim sidebar if store settings fails', () => {
jest.spyOn(console, 'warn').mockImplementation(() => {})
const toastSpy = jest.spyOn(toastService, 'showError')
diff --git a/src-ui/src/app/components/app-frame/app-frame.component.ts b/src-ui/src/app/components/app-frame/app-frame.component.ts
index 59a2ba18b..7b4c29d2f 100644
--- a/src-ui/src/app/components/app-frame/app-frame.component.ts
+++ b/src-ui/src/app/components/app-frame/app-frame.component.ts
@@ -7,6 +7,7 @@ import {
} from '@angular/cdk/drag-drop'
import { NgClass } from '@angular/common'
import { Component, HostListener, inject, OnInit, signal } from '@angular/core'
+import { FormsModule } from '@angular/forms'
import { ActivatedRoute, Router, RouterModule } from '@angular/router'
import {
NgbCollapseModule,
@@ -21,7 +22,11 @@ import { Observable } from 'rxjs'
import { first } from 'rxjs/operators'
import { Document } from 'src/app/data/document'
import { SavedView } from 'src/app/data/saved-view'
-import { CollapsibleSection, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import {
+ CollapsibleSection,
+ HideableSidebarItemID,
+ SETTINGS_KEYS,
+} from 'src/app/data/ui-settings'
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
import { ComponentCanDeactivate } from 'src/app/guards/dirty-doc.guard'
import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
@@ -48,6 +53,7 @@ import { ChatComponent } from '../chat/chat/chat.component'
import { BrandMarkComponent } from '../common/logo/brand-mark/brand-mark.component'
import { LogoComponent } from '../common/logo/logo.component'
import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component'
+import { SwitchComponent } from '../common/input/switch/switch.component'
import { DocumentDetailComponent } from '../document-detail/document-detail.component'
import { ComponentWithPermissions } from '../with-permissions/with-permissions.component'
import { GlobalSearchComponent } from './global-search/global-search.component'
@@ -76,6 +82,8 @@ const SCROLL_THRESHOLD = 16
NgxBootstrapIconsModule,
DragDropModule,
TourNgBootstrap,
+ FormsModule,
+ SwitchComponent,
],
})
export class AppFrameComponent
@@ -98,6 +106,7 @@ export class AppFrameComponent
readonly isMenuCollapsed = signal(true)
readonly slimSidebarAnimating = signal(false)
readonly mobileSearchHidden = signal(false)
+ readonly HideableSidebarItemID = HideableSidebarItemID
private readonly versionSetting = this.settingsService.getSignal<string>(
SETTINGS_KEYS.VERSION
)
@@ -195,6 +204,10 @@ export class AppFrameComponent
}, 200) // slightly longer than css animation for slim sidebar
}
+ toggleSidebarItem(item: HideableSidebarItemID, visible: boolean): void {
+ this.settingsService.updateSidebarItemVisibility(item, visible)
+ }
+
toggleAttributesSections(event?: Event): void {
event?.preventDefault()
event?.stopPropagation()
diff --git a/src-ui/src/app/components/common/input/switch/switch.component.html b/src-ui/src/app/components/common/input/switch/switch.component.html
index edd831e5c..636356d64 100644
--- a/src-ui/src/app/components/common/input/switch/switch.component.html
+++ b/src-ui/src/app/components/common/input/switch/switch.component.html
@@ -1,6 +1,6 @@
-<div class="mb-3">
- <div class="row">
- @if (!horizontal) {
+<div [class.mb-3]="!compact">
+ <div [class.row]="!compact">
+ @if (!horizontal && !compact) {
<div class="d-flex align-items-center position-relative hidden-button-container col-md-3">
<label class="form-label" [for]="inputId" [ngbTooltip]="showUnsetNote && isUnset ? tipContent: null" placement="end">
{{title}}
@@ -17,8 +17,8 @@
}
<div [ngClass]="{'align-items-center': horizontal, 'd-flex': horizontal}">
<div class="form-check form-switch">
- <input #inputField type="checkbox" class="form-check-input" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" (blur)="onTouched()" [disabled]="disabled">
- @if (horizontal) {
+ <input #inputField type="checkbox" class="form-check-input" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" (blur)="onTouched()" [disabled]="disabled" [attr.aria-label]="compact ? title : null">
+ @if (horizontal && !compact) {
<label class="form-check-label" [class.text-muted]="showUnsetNote && isUnset" [for]="inputId" [ngbTooltip]="showUnsetNote && isUnset ? tipContent: null" placement="end">
{{title}}
@if (showUnsetNote && isUnset) {
diff --git a/src-ui/src/app/components/common/input/switch/switch.component.spec.ts b/src-ui/src/app/components/common/input/switch/switch.component.spec.ts
index 8dfe0c435..83d909014 100644
--- a/src-ui/src/app/components/common/input/switch/switch.component.spec.ts
+++ b/src-ui/src/app/components/common/input/switch/switch.component.spec.ts
@@ -48,4 +48,14 @@ describe('SwitchComponent', () => {
component.value = undefined
expect(component.isUnset).toBeTruthy()
})
+
+ it('should support a compact layout', () => {
+ component.compact = true
+ component.title = 'Test switch'
+ fixture.detectChanges()
+
+ expect(fixture.nativeElement.querySelector('.mb-3')).toBeNull()
+ expect(fixture.nativeElement.querySelector('.row')).toBeNull()
+ expect(input.getAttribute('aria-label')).toEqual('Test switch')
+ })
})
diff --git a/src-ui/src/app/components/common/input/switch/switch.component.ts b/src-ui/src/app/components/common/input/switch/switch.component.ts
index 2b888225a..b74e489a0 100644
--- a/src-ui/src/app/components/common/input/switch/switch.component.ts
+++ b/src-ui/src/app/components/common/input/switch/switch.component.ts
@@ -25,6 +25,9 @@ export class SwitchComponent extends AbstractInputComponent<boolean> {
@Input()
showUnsetNote: boolean = false
+ @Input()
+ compact: boolean = false
+
constructor() {
super()
}
diff --git a/src-ui/src/app/data/ui-settings.ts b/src-ui/src/app/data/ui-settings.ts
index 959a30669..a36435e37 100644
--- a/src-ui/src/app/data/ui-settings.ts
+++ b/src-ui/src/app/data/ui-settings.ts
@@ -24,6 +24,16 @@ export enum CollapsibleSection {
ATTRIBUTES = 'attributes',
}
+export enum HideableSidebarItemID {
+ Dashboard = 'dashboard',
+ SavedViews = 'saved_views',
+ Workflows = 'workflows',
+ Mail = 'mail',
+ Documentation = 'documentation',
+}
+
+export const HIDEABLE_SIDEBAR_ITEM_IDS = Object.values(HideableSidebarItemID)
+
export const PAPERLESS_GREEN_HEX = '#17541f'
export const SETTINGS_KEYS = {
@@ -56,6 +66,7 @@ export const SETTINGS_KEYS = {
NOTES_ENABLED: 'general-settings:notes-enabled',
AUDITLOG_ENABLED: 'general-settings:auditlog-enabled',
SLIM_SIDEBAR: 'general-settings:slim-sidebar',
+ SIDEBAR_HIDDEN_ITEMS: 'general-settings:sidebar:hidden-items',
ATTRIBUTES_SECTIONS_COLLAPSED:
'general-settings:attributes-sections-collapsed',
UPDATE_CHECKING_ENABLED: 'general-settings:update-checking:enabled',
@@ -127,6 +138,11 @@ export const SETTINGS: UiSetting[] = [
type: 'boolean',
default: false,
},
+ {
+ key: SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS,
+ type: 'array',
+ default: [],
+ },
{
key: SETTINGS_KEYS.ATTRIBUTES_SECTIONS_COLLAPSED,
type: 'array',
diff --git a/src-ui/src/app/services/settings.service.spec.ts b/src-ui/src/app/services/settings.service.spec.ts
index b89a3554f..010f2f1c7 100644
--- a/src-ui/src/app/services/settings.service.spec.ts
+++ b/src-ui/src/app/services/settings.service.spec.ts
@@ -14,7 +14,11 @@ import { CustomFieldDataType } from '../data/custom-field'
import { DEFAULT_DISPLAY_FIELDS, DisplayField } from '../data/document'
import { SavedView } from '../data/saved-view'
import { RemoteOCRModeConfig } from '../data/paperless-config'
-import { SETTINGS_KEYS, UiSettings } from '../data/ui-settings'
+import {
+ HideableSidebarItemID,
+ SETTINGS_KEYS,
+ UiSettings,
+} from '../data/ui-settings'
import { PermissionsService } from './permissions.service'
import { CustomFieldsService } from './rest/custom-fields.service'
import { SettingsService } from './settings.service'
@@ -230,6 +234,35 @@ describe('SettingsService', () => {
expect(notesEnabled()).toBeFalsy()
})
+ it('updates sidebar item visibility', () => {
+ httpTestingController
+ .expectOne(`${environment.apiBaseUrl}ui_settings/`)
+ .flush(ui_settings)
+
+ expect(
+ settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+ ).toBe(false)
+
+ settingsService.updateSidebarItemVisibility(
+ HideableSidebarItemID.Workflows,
+ false
+ )
+
+ expect(
+ settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+ ).toBe(true)
+ expect(settingsService.get(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS)).toEqual([])
+
+ settingsService.updateSidebarItemVisibility(
+ HideableSidebarItemID.Workflows,
+ true
+ )
+
+ expect(
+ settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+ ).toBe(false)
+ })
+
it('updates setting signals when settings are reinitialized', () => {
let req = httpTestingController.expectOne(
`${environment.apiBaseUrl}ui_settings/`
diff --git a/src-ui/src/app/services/settings.service.ts b/src-ui/src/app/services/settings.service.ts
index c6fd5c8f3..ef27e6e55 100644
--- a/src-ui/src/app/services/settings.service.ts
+++ b/src-ui/src/app/services/settings.service.ts
@@ -24,6 +24,7 @@ import { DEFAULT_DISPLAY_FIELDS, DisplayField } from '../data/document'
import { RemoteOCRModeConfig } from '../data/paperless-config'
import { SavedView } from '../data/saved-view'
import {
+ HideableSidebarItemID,
PAPERLESS_GREEN_HEX,
SETTINGS,
SETTINGS_KEYS,
@@ -313,6 +314,18 @@ export class SettingsService {
readonly globalDropzoneEnabled = signal(true)
readonly globalDropzoneActive = signal(false)
readonly organizingSidebarSavedViews = signal(false)
+ readonly sidebarHiddenItemsEditing = signal<HideableSidebarItemID[] | null>(
+ null
+ )
+ readonly organizingSidebarItems = computed(
+ () => this.sidebarHiddenItemsEditing() !== null
+ )
+ readonly sidebarHiddenItemsEditingChanged = new EventEmitter<
+ HideableSidebarItemID[]
+ >()
+ readonly hiddenSidebarItems = this.getSignal<HideableSidebarItemID[]>(
+ SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS
+ )
readonly allDisplayFields = signal<Array<{ id: DisplayField; name: string }>>(
DEFAULT_DISPLAY_FIELDS
@@ -749,6 +762,29 @@ export class SettingsService {
return this.storeSettings()
}
+ sidebarItemIsHidden(item: HideableSidebarItemID): boolean {
+ return (
+ this.sidebarHiddenItemsEditing() ?? this.hiddenSidebarItems()
+ ).includes(item)
+ }
+
+ updateSidebarItemVisibility(
+ item: HideableSidebarItemID,
+ visible: boolean
+ ): void {
+ const hiddenItems = new Set(
+ this.sidebarHiddenItemsEditing() ?? this.hiddenSidebarItems()
+ )
+ if (visible) {
+ hiddenItems.delete(item)
+ } else {
+ hiddenItems.add(item)
+ }
+ const updatedHiddenItems = [...hiddenItems]
+ this.sidebarHiddenItemsEditing.set(updatedHiddenItems)
+ this.sidebarHiddenItemsEditingChanged.emit(updatedHiddenItems)
+ }
+
updateSavedViewsVisibility(
dashboardVisibleViewIds: number[],
sidebarVisibleViewIds: number[]