feat: add expiration for visitor theme preferences

This commit is contained in:
Erzbir
2026-07-09 17:34:27 +08:00
parent c7cacfba25
commit a3010ae155
4 changed files with 102 additions and 32 deletions
+5 -2
View File
@@ -79,13 +79,16 @@
3. 启用自定义字体且未开启系统字体时使用上传的字体 3. 启用自定义字体且未开启系统字体时使用上传的字体
4. 其他情况使用内置 `JetBrains Mono` 4. 其他情况使用内置 `JetBrains Mono`
访客手动选择的模式, 配色和像素风格会保存在浏览器的 `localStorage` 中 访客手动选择的模式, 配色和像素风格会保存在浏览器的 `localStorage` 中. 默认有效期为 24 小时,
可通过 `style.prefer_ttl` 调整,设为 `0` 时永久保存. 偏好过期后会在下次访问时恢复默认值,
已有偏好数据会在升级后的首次访问时开始计算有效期
### 配色设置 ### 配色设置
| 设置 | 配置名 | 说明 | | 设置 | 配置名 | 说明 |
|---------|--------------------------------------|---------------------| |---------|--------------------------------------|-----------------------------|
| 默认配色模式 | `style.default_scheme_mode` | 可选深色, 浅色或跟随系统 | | 默认配色模式 | `style.default_scheme_mode` | 可选深色, 浅色或跟随系统 |
| 访客偏好有效期 | `style.prefer_ttl` | 模式, 配色和像素风格的保存小时数, `0` 表示永久 |
| 访客配色切换 | `style.color_scheme_switcher_enable` | 在页头显示可用配色列表 | | 访客配色切换 | `style.color_scheme_switcher_enable` | 在页头显示可用配色列表 |
| 深色配色 | `style.dark_color_scheme` | 深色模式使用的内置或自定义配色 | | 深色配色 | `style.dark_color_scheme` | 深色模式使用的内置或自定义配色 |
| 浅色配色 | `style.light_color_scheme` | 浅色模式使用的内置或自定义配色 | | 浅色配色 | `style.light_color_scheme` | 浅色模式使用的内置或自定义配色 |
+6
View File
@@ -64,6 +64,12 @@ spec:
value: "light" value: "light"
- label: "跟随系统" - label: "跟随系统"
value: "system" value: "system"
- $formkit: number
name: prefer_ttl
label: 访客偏好有效期 (小时)
value: 24
min: 0
help: 访客手动选择的模式, 配色和像素风格过期后会在下次访问时恢复默认值, 设为 0 表示永久保存
- $formkit: checkbox - $formkit: checkbox
name: color_scheme_switcher_enable name: color_scheme_switcher_enable
label: 启用访客配色切换 label: 启用访客配色切换
+22 -6
View File
@@ -5,6 +5,20 @@ const COLOR_SCHEME_STORAGE_KEY = "theme-color-scheme";
const PIXEL_STYLE_STORAGE_KEY = "pixel_style"; const PIXEL_STYLE_STORAGE_KEY = "pixel_style";
const COLOR_SCHEME_SELECTOR_PATTERN = /html\[theme-color-scheme\s*=\s*(['"]?)([^'"\]\s]+)\1\]/g; const COLOR_SCHEME_SELECTOR_PATTERN = /html\[theme-color-scheme\s*=\s*(['"]?)([^'"\]\s]+)\1\]/g;
function getStoredPreference(key) {
return window.TerminalTheme?.storage
? window.TerminalTheme.storage.get(key)
: localStorage.getItem(key);
}
function setStoredPreference(key, value) {
if (window.TerminalTheme?.storage) {
window.TerminalTheme.storage.set(key, value);
return;
}
localStorage.setItem(key, value);
}
function registerSearchButton() { function registerSearchButton() {
const searchButton = document.querySelector('[data-header-action="open-search"]'); const searchButton = document.querySelector('[data-header-action="open-search"]');
if (!searchButton) return; if (!searchButton) return;
@@ -25,7 +39,7 @@ function registerThemeToggle() {
const nextMode = currentScheme === "dark" ? "light" : "dark"; const nextMode = currentScheme === "dark" ? "light" : "dark";
window.applyTheme(nextMode, {clearColorScheme: true}); window.applyTheme(nextMode, {clearColorScheme: true});
localStorage.setItem(THEME_MODE_STORAGE_KEY, nextMode); setStoredPreference(THEME_MODE_STORAGE_KEY, nextMode);
syncColorSchemePicker(); syncColorSchemePicker();
}); });
} }
@@ -82,13 +96,13 @@ function syncColorSchemePicker() {
const picker = document.getElementById("color-scheme-picker"); const picker = document.getElementById("color-scheme-picker");
if (!picker) return; if (!picker) return;
const storedScheme = localStorage.getItem(COLOR_SCHEME_STORAGE_KEY); const storedScheme = getStoredPreference(COLOR_SCHEME_STORAGE_KEY);
const options = Array.from(picker.querySelectorAll("[data-color-scheme]")); const options = Array.from(picker.querySelectorAll("[data-color-scheme]"));
const hasStoredOption = storedScheme && options const hasStoredOption = storedScheme && options
.some(option => option.dataset.colorScheme === storedScheme); .some(option => option.dataset.colorScheme === storedScheme);
if (storedScheme && !hasStoredOption) { if (storedScheme && !hasStoredOption) {
const storedMode = localStorage.getItem(THEME_MODE_STORAGE_KEY) const storedMode = getStoredPreference(THEME_MODE_STORAGE_KEY)
|| window.TerminalThemeConfig?.defaultMode || window.TerminalThemeConfig?.defaultMode
|| "system"; || "system";
@@ -206,10 +220,12 @@ function registerPixelToggle() {
if (!pixelToggle) return; if (!pixelToggle) return;
pixelToggle.addEventListener("click", function () { pixelToggle.addEventListener("click", function () {
const storedStatus = localStorage.getItem(PIXEL_STYLE_STORAGE_KEY); const storedStatus = getStoredPreference(PIXEL_STYLE_STORAGE_KEY);
const newStatus = storedStatus === "true" ? "false" : "true"; const currentStatus = storedStatus
|| document.documentElement.getAttribute(PIXEL_STYLE_STORAGE_KEY);
const newStatus = currentStatus === "true" ? "false" : "true";
document.documentElement.setAttribute(PIXEL_STYLE_STORAGE_KEY, newStatus); document.documentElement.setAttribute(PIXEL_STYLE_STORAGE_KEY, newStatus);
localStorage.setItem(PIXEL_STYLE_STORAGE_KEY, newStatus); setStoredPreference(PIXEL_STYLE_STORAGE_KEY, newStatus);
window.TerminalTheme?.syncPixelFont?.(); window.TerminalTheme?.syncPixelFont?.();
}); });
} }
+62 -17
View File
@@ -16,6 +16,7 @@
customDarkTheme: /*[[${theme.config.style.custom_dark}]]*/ "", customDarkTheme: /*[[${theme.config.style.custom_dark}]]*/ "",
customLightTheme: /*[[${theme.config.style.custom_light}]]*/ "", customLightTheme: /*[[${theme.config.style.custom_light}]]*/ "",
defaultMode: /*[[${theme.config.style.default_scheme_mode}]]*/ "system", defaultMode: /*[[${theme.config.style.default_scheme_mode}]]*/ "system",
preferTTL: /*[[${theme.config.style.prefer_ttl ?: 24}]]*/ 24,
pixelStyle: /*[[${theme.config.style.pixel_style}]]*/ false, pixelStyle: /*[[${theme.config.style.pixel_style}]]*/ false,
pixelCssHref: /*[[@{/assets/dist/pixel.css?v={version}(version=${theme.spec.version})}]]*/ "", pixelCssHref: /*[[@{/assets/dist/pixel.css?v={version}(version=${theme.spec.version})}]]*/ "",
customCss: /*[[${theme.config.style.custom}]]*/ "" customCss: /*[[${theme.config.style.custom}]]*/ ""
@@ -30,6 +31,49 @@
pixelStyle: "pixel_style", pixelStyle: "pixel_style",
colorScheme: "theme-color-scheme" colorScheme: "theme-color-scheme"
}; };
const expirationSuffix = "-expires-at";
const expirationHours = Number(config.preferTTL);
const storageTtl = Number.isFinite(expirationHours) && expirationHours > 0
? expirationHours * 60 * 60 * 1000
: 0;
function removeStoredPreference(key) {
localStorage.removeItem(key);
localStorage.removeItem(key + expirationSuffix);
}
function getStoredPreference(key) {
const value = localStorage.getItem(key);
if (value === null) return null;
const expirationKey = key + expirationSuffix;
if (!storageTtl) {
localStorage.removeItem(expirationKey);
return value;
}
const expiresAt = Number(localStorage.getItem(expirationKey));
if (!Number.isFinite(expiresAt) || expiresAt <= 0) {
localStorage.setItem(expirationKey, String(Date.now() + storageTtl));
return value;
}
if (expiresAt <= Date.now()) {
removeStoredPreference(key);
return null;
}
return value;
}
function setStoredPreference(key, value) {
localStorage.setItem(key, value);
if (storageTtl) {
localStorage.setItem(key + expirationSuffix, String(Date.now() + storageTtl));
} else {
localStorage.removeItem(key + expirationSuffix);
}
}
function resolveTheme(mode) { function resolveTheme(mode) {
if (mode === "light") { if (mode === "light") {
@@ -39,7 +83,7 @@
} }
function getStoredColorScheme() { function getStoredColorScheme() {
const scheme = localStorage.getItem(storageKeys.colorScheme); const scheme = getStoredPreference(storageKeys.colorScheme);
return scheme && scheme !== "default" ? scheme : ""; return scheme && scheme !== "default" ? scheme : "";
} }
@@ -49,7 +93,7 @@
function applyTheme(mode, options = {}) { function applyTheme(mode, options = {}) {
if (options.clearColorScheme) { if (options.clearColorScheme) {
localStorage.removeItem(storageKeys.colorScheme); removeStoredPreference(storageKeys.colorScheme);
} }
const actualMode = mode === "system" ? getSystemScheme() : mode; const actualMode = mode === "system" ? getSystemScheme() : mode;
@@ -59,12 +103,12 @@
function applyColorScheme(scheme) { function applyColorScheme(scheme) {
if (!scheme || scheme === "default") { if (!scheme || scheme === "default") {
localStorage.removeItem(storageKeys.colorScheme); removeStoredPreference(storageKeys.colorScheme);
syncThemeMode(); syncThemeMode();
return; return;
} }
localStorage.setItem(storageKeys.colorScheme, scheme); setStoredPreference(storageKeys.colorScheme, scheme);
root.setAttribute("theme-color-scheme", scheme); root.setAttribute("theme-color-scheme", scheme);
} }
@@ -73,12 +117,8 @@
} }
function syncPixelStyle() { function syncPixelStyle() {
let storedStatus = localStorage.getItem(storageKeys.pixelStyle); const storedStatus = getStoredPreference(storageKeys.pixelStyle)
|| String(config.pixelStyle);
if (!storedStatus) {
storedStatus = String(config.pixelStyle);
localStorage.setItem(storageKeys.pixelStyle, storedStatus);
}
root.setAttribute("pixel_style", storedStatus); root.setAttribute("pixel_style", storedStatus);
} }
@@ -112,12 +152,9 @@
} }
function syncThemeMode() { function syncThemeMode() {
let storedMode = localStorage.getItem(storageKeys.themeMode); const storedMode = getStoredPreference(storageKeys.themeMode)
|| config.defaultMode
if (!storedMode) { || "system";
storedMode = config.defaultMode || "system";
localStorage.setItem(storageKeys.themeMode, storedMode);
}
applyTheme(storedMode); applyTheme(storedMode);
} }
@@ -127,6 +164,11 @@
applyTheme, applyTheme,
applyColorScheme, applyColorScheme,
applyCustomCss, applyCustomCss,
storage: {
get: getStoredPreference,
set: setStoredPreference,
remove: removeStoredPreference
},
syncPixelFont, syncPixelFont,
syncPixelStyle syncPixelStyle
}; };
@@ -137,7 +179,10 @@
syncPixelFont(); syncPixelFont();
window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change", () => { window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change", () => {
if (localStorage.getItem(storageKeys.themeMode) === "system") { const mode = getStoredPreference(storageKeys.themeMode)
|| config.defaultMode
|| "system";
if (mode === "system") {
applyTheme("system"); applyTheme("system");
} }
}); });