Adds a settings item to choose the start time for week based views

This commit adds the options to select a default value for three days
and week views to scroll to.

Author: mup

src/calendar-app/calendar/view/CalendarView.ts

@@ -36,7 +36,6 @@ import {
 	getStartOfTheWeekOffset,
 	getStartOfTheWeekOffsetForUser,
 	getTimeZone,
-	getWeekNumber,
 	hasSourceUrl,
 	isBirthdayEvent,
 	isClientOnlyCalendar,
@@ -1141,6 +1140,9 @@ export class CalendarView extends BaseTopLevelView implements TopLevelView<Calen
 	onNewUrl(args: Record<string, any>) {
 		if (!args.view) {
 			this.setUrl(this.currentViewType, this.viewModel.selectedDate(), true)
+			if (this.currentViewType === CalendarViewType.WEEK || this.currentViewType === CalendarViewType.THREE_DAY) {
+				this.viewModel.setSelectedTime(Time.fromDateTime(DateTime.fromObject({ hour: deviceConfig.getScrollTime(), minute: 0 })))
+			}
 		} else {
 			this.currentViewType = CalendarViewTypeByValue[args.view as CalendarViewType] ? args.view : CalendarViewType.MONTH
 			const urlDateParam = args.date
@@ -1162,7 +1164,9 @@ export class CalendarView extends BaseTopLevelView implements TopLevelView<Calen
 				}
 
 				const today = new Date()
-				if (isSameDayOfDate(today, date) || (args.view === "week" && getWeekNumber(date) === getWeekNumber(today))) {
+				if (args.view === "week" || args.view === "three") {
+					this.viewModel.setSelectedTime(Time.fromDateTime(DateTime.fromObject({ hour: deviceConfig.getScrollTime(), minute: 0 })))
+				} else if (isSameDayOfDate(today, date)) {
 					const time = Time.fromDate(today)
 					this.viewModel.setSelectedTime(time)
 				} else {

src/common/misc/DeviceConfig.ts

@@ -81,6 +81,11 @@ interface ConfigObject {
 	 * This is only for the case the user does not want to rate right now or completely opts out of the in-app ratings.
 	 */
 	retryRatingPromptAfter?: number
+
+	/**
+	 * Which time the three days or week view will scroll to when opened
+	 */
+	scrollTime: number
 }
 
 /**
@@ -144,6 +149,7 @@ export class DeviceConfig implements UsageTestStorage, NewsItemStorage {
 			events: loadedConfig.events ?? [],
 			lastRatingPromptedDate: loadedConfig.lastRatingPromptedDate ?? null,
 			retryRatingPromptAfter: loadedConfig.retryRatingPromptAfter ?? null,
+			scrollTime: loadedConfig.scrollTime ?? 8,
 		}
 
 		this.lastSyncStream(new Map(Object.entries(this.config.lastExternalCalendarSync)))
@@ -173,6 +179,15 @@ export class DeviceConfig implements UsageTestStorage, NewsItemStorage {
 		}
 	}
 
+	getScrollTime(): number {
+		return this.config.scrollTime
+	}
+
+	setScrollTime(time: number) {
+		this.config.scrollTime = time
+		this.writeToStorage()
+	}
+
 	storeCredentials(credentials: DeviceConfigCredentials) {
 		this.config._credentials.set(credentials.credentialInfo.userId, credentials)
 

src/common/misc/TranslationKey.ts

@@ -1892,6 +1892,8 @@ export type TranslationKeyType =
 	| "threeDays_label"
 	| "prevThreeDays_label"
 	| "nextThreeDays_label"
+	| "weekScrollTime_label"
+	| "weekScrollTime_msg"
 	// Put in temporarily, will be removed soon
 	| "localAdminGroup_label"
 	| "assignAdminRightsToLocallyAdministratedUserError_msg"

src/common/settings/AppearanceSettingsViewer.ts

@@ -14,15 +14,27 @@ import { isDesktop } from "../../common/api/common/Env"
 import { locator } from "../../common/api/main/CommonLocator"
 import { EntityUpdateData, isUpdateForTypeRef } from "../../common/api/common/utils/EntityUpdateUtils.js"
 import { client } from "../misc/ClientDetector.js"
+import { DateTime } from "../../../libs/luxon.js"
 
 export class AppearanceSettingsViewer implements UpdatableSettingsViewer {
 	private _customThemes: Array<ThemeId> | null = null
+	private timeOptions: Array<{ name: string; value: number }> = []
 
 	oncreate() {
 		locator.themeController.getCustomThemes().then((themes) => {
 			this._customThemes = themes
 			m.redraw()
 		})
+
+		const userSettingsGroupRoot = locator.logins.getUserController().userSettingsGroupRoot
+		const timeFormat = userSettingsGroupRoot.timeFormat
+
+		for (let hour = 0; hour < 24; hour++) {
+			this.timeOptions.push({
+				name: DateTime.fromFormat(hour.toString(), "h").toFormat(timeFormat === TimeFormat.TWENTY_FOUR_HOURS ? "HH:mm" : "hh:mm a"),
+				value: hour,
+			})
+		}
 	}
 
 	view(): Children {
@@ -117,6 +129,7 @@ export class AppearanceSettingsViewer implements UpdatableSettingsViewer {
 			m(".h4.mt-l", lang.get("settingsForDevice_label")),
 			m(DropDownSelector, languageDropDownAttrs),
 			this._renderThemeSelector(),
+			this.renderScrollTimeSelector(),
 			m(".h4.mt-l", lang.get("userSettings_label")),
 			m(DropDownSelector, hourFormatDropDownAttrs),
 			m(DropDownSelector, weekStartDropDownAttrs),
@@ -145,6 +158,18 @@ export class AppearanceSettingsViewer implements UpdatableSettingsViewer {
 		return m(DropDownSelector, themeDropDownAttrs)
 	}
 
+	renderScrollTimeSelector(): Children {
+		const themeDropDownAttrs: DropDownSelectorAttrs<number> = {
+			label: "weekScrollTime_label",
+			helpLabel: () => lang.get("weekScrollTime_msg"),
+			items: this.timeOptions as SelectorItemList<number>,
+			selectedValue: deviceConfig.getScrollTime(),
+			selectionChangedHandler: (value) => deviceConfig.setScrollTime(value),
+			dropdownWidth: 300,
+		}
+		return m(DropDownSelector, themeDropDownAttrs)
+	}
+
 	entityEventsReceived(updates: ReadonlyArray<EntityUpdateData>): Promise<void> {
 		return promiseMap(updates, (update) => {
 			if (isUpdateForTypeRef(UserSettingsGroupRootTypeRef, update)) {

src/mail-app/translations/de.ts

@@ -1912,6 +1912,8 @@ export default {
 		"threeDays_label": "Drei Tage",
 		"prevThreeDays_label": "Vorherige drei Tage",
 		"nextThreeDays_label": "Nächsten drei Tage",
+		"weekScrollTime_label": "Standardzeit",
+		"weekScrollTime_msg": "Standardzeit für Drei-Tage- und Wochen-Ansichten zum Blättern zu",
 		// Put in temporarily, will be removed soon
 		"localAdminGroup_label": "Local admin group",
 		"assignAdminRightsToLocallyAdministratedUserError_msg": "You can't assign global admin rights to a locally administrated user.",

src/mail-app/translations/de_sie.ts

@@ -1912,6 +1912,8 @@ export default {
 		"threeDays_label": "Drei Tage",
 		"prevThreeDays_label": "Vorherige drei Tage",
 		"nextThreeDays_label": "Nächsten drei Tage",
+		"weekScrollTime_label": "Standardzeit",
+		"weekScrollTime_msg": "Standardzeit für Drei-Tage- und Wochen-Ansichten zum Blättern zu",
 		// Put in temporarily, will be removed soon
 		"localAdminGroup_label": "Local admin group",
 		"assignAdminRightsToLocallyAdministratedUserError_msg": "You can't assign global admin rights to a locally administrated user.",

src/mail-app/translations/en.ts

@@ -1906,12 +1906,14 @@ export default {
 		"yourMessage_label": "Your message",
 		"you_label": "You",
 		// Put in temporarily, will be removed soon
-		"localAdminGroup_label": "Local admin group",
-		"assignAdminRightsToLocallyAdministratedUserError_msg": "You can't assign global admin rights to a locally administrated user.",
-		"localAdminGroups_label": "Local admin groups",
 		"threeDays_label": "Three Days",
 		"prevThreeDays_label": "Previous three days",
-		"nextThreeDays_label": "Next three days"
+		"nextThreeDays_label": "Next three days",
+		"weekScrollTime_label": "Default time",
+		"weekScrollTime_msg": "Default time for Three Days and Week views to scroll to",
+		// Put in temporarily
+		"localAdminGroup_label": "Local admin group",
+		"assignAdminRightsToLocallyAdministratedUserError_msg": "You can't assign global admin rights to a locally administrated user.",
 		"localAdminGroups_label": "Local admin groups"
 	}
 }

test/tests/misc/DeviceConfigTest.ts

@@ -109,6 +109,7 @@ o.spec("DeviceConfig", function () {
 				events: [],
 				lastRatingPromptedDate: null,
 				retryRatingPromptAfter: null,
+				scrollTime: 8
 			}
 
 			when(localStorageMock.getItem(DeviceConfig.LocalStorageKey)).thenReturn(JSON.stringify(storedInLocalStorage))