mirror of
https://github.com/SableClient/Sable.git
synced 2026-11-20 17:11:17 -08:00
feat(desktop): add spellcheck setting (#1850)
<!-- Please read https://github.com/SableClient/Sable/blob/dev/CONTRIBUTING.md before submitting your pull request --> ### Description <!-- Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Fixes # #### Type of change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ### Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings ### AI disclosure: - [ ] Partially AI assisted (clarify which code was AI assisted and briefly explain what it does). - [ ] Fully AI generated (explain what all the generated code does in moderate detail). <!-- Write any explanation required here, but do not generate the explanation using AI!! You must prove you understand what the code in this PR does. -->
This commit is contained in:
14 files changed
+191
-17
No files matched your search
@@ -8,12 +8,14 @@ pub struct DesktopSettings {
|
||||
pub close_to_background_on_close: bool,
|
||||
pub show_system_tray_icon: bool,
|
||||
pub use_custom_title_bar: bool,
|
||||
pub spellcheck: bool,
|
||||
}
|
||||
|
||||
pub(crate) const DESKTOP_SETTINGS_PATH: &str = "desktop-preferences.json";
|
||||
pub(crate) const CLOSE_TO_BACKGROUND_ON_CLOSE_KEY: &str = "closeToBackgroundOnClose";
|
||||
pub(crate) const SHOW_SYSTEM_TRAY_ICON_KEY: &str = "showSystemTrayIcon";
|
||||
pub(crate) const USE_CUSTOM_TITLE_BAR_KEY: &str = "useCustomTitleBar";
|
||||
pub(crate) const SPELLCHECK_KEY: &str = "spellcheck";
|
||||
pub(crate) const LEGACY_KEEP_BACKGROUND_RUNNING_KEY: &str = "keepBackgroundRunning";
|
||||
|
||||
pub(crate) const fn use_custom_title_bar_default() -> bool {
|
||||
@@ -28,6 +30,7 @@ pub(crate) fn desktop_settings_from_values(
|
||||
close_to_background_on_close: Option<bool>,
|
||||
show_system_tray_icon: Option<bool>,
|
||||
use_custom_title_bar: Option<bool>,
|
||||
spellcheck: Option<bool>,
|
||||
keep_background_running: Option<bool>,
|
||||
) -> DesktopSettings {
|
||||
DesktopSettings {
|
||||
@@ -35,6 +38,7 @@ pub(crate) fn desktop_settings_from_values(
|
||||
|| keep_background_running.unwrap_or(false),
|
||||
show_system_tray_icon: show_system_tray_icon.unwrap_or(true),
|
||||
use_custom_title_bar: use_custom_title_bar.unwrap_or(use_custom_title_bar_default()),
|
||||
spellcheck: spellcheck.unwrap_or(true),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -50,6 +54,7 @@ mod tests {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: false,
|
||||
use_custom_title_bar: true,
|
||||
spellcheck: false,
|
||||
};
|
||||
|
||||
assert_eq!(
|
||||
@@ -58,6 +63,7 @@ mod tests {
|
||||
"closeToBackgroundOnClose": true,
|
||||
"showSystemTrayIcon": false,
|
||||
"useCustomTitleBar": true,
|
||||
"spellcheck": false,
|
||||
})
|
||||
);
|
||||
}
|
||||
@@ -69,12 +75,14 @@ mod tests {
|
||||
"closeToBackgroundOnClose": true,
|
||||
"showSystemTrayIcon": false,
|
||||
"useCustomTitleBar": true,
|
||||
"spellcheck": false,
|
||||
}))
|
||||
.unwrap(),
|
||||
DesktopSettings {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: false,
|
||||
use_custom_title_bar: true,
|
||||
spellcheck: false,
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -87,17 +95,19 @@ mod tests {
|
||||
assert!(output.contains("closeToBackgroundOnClose: boolean"));
|
||||
assert!(output.contains("showSystemTrayIcon: boolean"));
|
||||
assert!(output.contains("useCustomTitleBar: boolean"));
|
||||
assert!(output.contains("spellcheck: boolean"));
|
||||
assert!(!output.contains("keepBackgroundRunning: boolean"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_background_setting_keeps_close_behavior_enabled() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(false), Some(true)),
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(false), None, Some(true)),
|
||||
DesktopSettings {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: false,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -105,11 +115,12 @@ mod tests {
|
||||
#[test]
|
||||
fn explicit_close_setting_stays_disabled_when_legacy_background_is_off() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(Some(false), Some(true), Some(true), Some(false)),
|
||||
desktop_settings_from_values(Some(false), Some(true), Some(true), None, Some(false)),
|
||||
DesktopSettings {
|
||||
close_to_background_on_close: false,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: true,
|
||||
spellcheck: true,
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -117,8 +128,15 @@ mod tests {
|
||||
#[test]
|
||||
fn missing_custom_title_bar_setting_uses_platform_default() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(Some(true), Some(true), None, None).use_custom_title_bar,
|
||||
desktop_settings_from_values(Some(true), Some(true), None, None, None)
|
||||
.use_custom_title_bar,
|
||||
cfg!(target_os = "windows")
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_spellcheck_setting_defaults_to_enabled() {
|
||||
assert!(desktop_settings_from_values(None, None, None, None, None).spellcheck);
|
||||
assert!(!desktop_settings_from_values(None, None, None, Some(false), None).spellcheck);
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,8 @@ use crate::desktop::runtime_state::DesktopRuntimeState;
|
||||
use crate::desktop::settings::{
|
||||
desktop_settings_from_values, tray_available_for_session, use_custom_title_bar_default,
|
||||
DesktopSettings, CLOSE_TO_BACKGROUND_ON_CLOSE_KEY, DESKTOP_SETTINGS_PATH,
|
||||
LEGACY_KEEP_BACKGROUND_RUNNING_KEY, SHOW_SYSTEM_TRAY_ICON_KEY, USE_CUSTOM_TITLE_BAR_KEY,
|
||||
LEGACY_KEEP_BACKGROUND_RUNNING_KEY, SHOW_SYSTEM_TRAY_ICON_KEY, SPELLCHECK_KEY,
|
||||
USE_CUSTOM_TITLE_BAR_KEY,
|
||||
};
|
||||
use serde_json::json;
|
||||
use tauri::{
|
||||
@@ -26,6 +27,7 @@ pub struct DesktopSettingsState {
|
||||
close_to_background_on_close: AtomicBool,
|
||||
show_system_tray_icon: AtomicBool,
|
||||
use_custom_title_bar: AtomicBool,
|
||||
spellcheck: AtomicBool,
|
||||
tray_available: AtomicBool,
|
||||
}
|
||||
|
||||
@@ -35,6 +37,7 @@ impl Default for DesktopSettingsState {
|
||||
close_to_background_on_close: AtomicBool::new(true),
|
||||
show_system_tray_icon: AtomicBool::new(true),
|
||||
use_custom_title_bar: AtomicBool::new(use_custom_title_bar_default()),
|
||||
spellcheck: AtomicBool::new(true),
|
||||
tray_available: AtomicBool::new(false),
|
||||
}
|
||||
}
|
||||
@@ -98,6 +101,7 @@ pub(crate) fn load_desktop_settings(
|
||||
USE_CUSTOM_TITLE_BAR_KEY.into(),
|
||||
json!(use_custom_title_bar_default()),
|
||||
),
|
||||
(SPELLCHECK_KEY.into(), json!(true)),
|
||||
]))
|
||||
.build()
|
||||
.map_err(|error| tauri::Error::PluginInitialization("store".into(), error.to_string()))?;
|
||||
@@ -112,6 +116,7 @@ pub(crate) fn load_desktop_settings(
|
||||
store
|
||||
.get(USE_CUSTOM_TITLE_BAR_KEY)
|
||||
.and_then(|value| value.as_bool()),
|
||||
store.get(SPELLCHECK_KEY).and_then(|value| value.as_bool()),
|
||||
store
|
||||
.get(LEGACY_KEEP_BACKGROUND_RUNNING_KEY)
|
||||
.and_then(|value| value.as_bool()),
|
||||
@@ -124,6 +129,7 @@ fn current_desktop_settings(app: &AppHandle<crate::BrowserEngine>) -> DesktopSet
|
||||
close_to_background_on_close: state.close_to_background_on_close.load(Ordering::Relaxed),
|
||||
show_system_tray_icon: state.show_system_tray_icon.load(Ordering::Relaxed),
|
||||
use_custom_title_bar: state.use_custom_title_bar.load(Ordering::Relaxed),
|
||||
spellcheck: state.spellcheck.load(Ordering::Relaxed),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -171,6 +177,9 @@ fn apply_desktop_settings(
|
||||
state
|
||||
.use_custom_title_bar
|
||||
.store(settings.use_custom_title_bar, Ordering::Relaxed);
|
||||
state
|
||||
.spellcheck
|
||||
.store(settings.spellcheck, Ordering::Relaxed);
|
||||
|
||||
apply_main_window_title_bar_settings(app, settings)?;
|
||||
|
||||
@@ -395,6 +404,7 @@ mod tests {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
};
|
||||
|
||||
assert_eq!(
|
||||
@@ -409,6 +419,7 @@ mod tests {
|
||||
show_system_tray_icon: true,
|
||||
close_to_background_on_close: false,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
};
|
||||
|
||||
assert_eq!(
|
||||
@@ -423,6 +434,7 @@ mod tests {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
};
|
||||
|
||||
assert!(!tray_available_for_session(settings, false));
|
||||
@@ -451,6 +463,7 @@ mod tests {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
};
|
||||
|
||||
assert_eq!(
|
||||
@@ -462,11 +475,12 @@ mod tests {
|
||||
#[test]
|
||||
fn missing_store_values_default_to_enabled() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(None, None, None, None),
|
||||
desktop_settings_from_values(None, None, None, None, None),
|
||||
DesktopSettings {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: use_custom_title_bar_default(),
|
||||
spellcheck: true,
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -474,11 +488,12 @@ mod tests {
|
||||
#[test]
|
||||
fn legacy_background_store_value_migrates_to_close_behavior() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(false), Some(true)),
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(false), None, Some(true)),
|
||||
DesktopSettings {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: false,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -486,11 +501,12 @@ mod tests {
|
||||
#[test]
|
||||
fn explicit_store_values_are_preserved_when_legacy_background_is_off() {
|
||||
assert_eq!(
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(true), Some(false)),
|
||||
desktop_settings_from_values(Some(false), Some(false), Some(true), None, Some(false)),
|
||||
DesktopSettings {
|
||||
show_system_tray_icon: false,
|
||||
close_to_background_on_close: false,
|
||||
use_custom_title_bar: true,
|
||||
spellcheck: true,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
@@ -540,6 +540,7 @@ mod tests {
|
||||
close_to_background_on_close: true,
|
||||
show_system_tray_icon: true,
|
||||
use_custom_title_bar: false,
|
||||
spellcheck: true,
|
||||
};
|
||||
let _ = crate::desktop::runtime_state::DesktopRuntimeState {
|
||||
tray_available: true,
|
||||
|
||||
@@ -6,6 +6,7 @@ import { QueryClientProvider } from '@tanstack/react-query';
|
||||
import { isTauri } from '@tauri-apps/api/core';
|
||||
import { type as osType } from '@tauri-apps/plugin-os';
|
||||
|
||||
import { DesktopSpellcheck } from '$components/tauri/DesktopSpellcheck';
|
||||
import { TauriFrontendReady } from '$components/tauri/TauriFrontendReady';
|
||||
import { TauriWindowFocus } from '$components/tauri/TauriWindowFocus';
|
||||
import { DesktopTitleBar } from '$components/tauri/DesktopTitleBar';
|
||||
@@ -89,6 +90,7 @@ function AppShellFrame({ children, portalContainer, onPortalContainerChange }: A
|
||||
<>
|
||||
<TauriFrontendReady />
|
||||
<TauriWindowFocus />
|
||||
<DesktopSpellcheck />
|
||||
<div
|
||||
style={{
|
||||
display: 'flex',
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
import { render } from '@testing-library/react';
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { DesktopSpellcheck } from './DesktopSpellcheck';
|
||||
|
||||
const { mockIsDesktopTauri, mockUseDesktopSetting } = vi.hoisted(() => ({
|
||||
mockIsDesktopTauri: vi.fn<() => boolean>(),
|
||||
mockUseDesktopSetting: vi.fn<() => readonly [boolean, (value: boolean) => void]>(),
|
||||
}));
|
||||
|
||||
vi.mock('$utils/platform', () => ({
|
||||
isDesktopTauri: mockIsDesktopTauri,
|
||||
}));
|
||||
|
||||
vi.mock('$state/hooks/desktopSettings', () => ({
|
||||
useDesktopSetting: mockUseDesktopSetting,
|
||||
}));
|
||||
|
||||
describe('DesktopSpellcheck', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
mockUseDesktopSetting.mockReturnValue([true, vi.fn<(value: boolean) => void>()]);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
document.body.removeAttribute('spellcheck');
|
||||
});
|
||||
|
||||
it('disables inherited spellcheck on the body when the setting is off', () => {
|
||||
mockIsDesktopTauri.mockReturnValue(true);
|
||||
mockUseDesktopSetting.mockReturnValue([false, vi.fn<(value: boolean) => void>()]);
|
||||
|
||||
render(<DesktopSpellcheck />);
|
||||
|
||||
expect(document.body.spellcheck).toBe(false);
|
||||
});
|
||||
|
||||
it('keeps inherited spellcheck enabled on the body when the setting is on', () => {
|
||||
mockIsDesktopTauri.mockReturnValue(true);
|
||||
|
||||
render(<DesktopSpellcheck />);
|
||||
|
||||
expect(document.body.spellcheck).toBe(true);
|
||||
});
|
||||
|
||||
it('follows setting changes after mount', () => {
|
||||
mockIsDesktopTauri.mockReturnValue(true);
|
||||
mockUseDesktopSetting.mockReturnValue([true, vi.fn<(value: boolean) => void>()]);
|
||||
|
||||
const { rerender } = render(<DesktopSpellcheck />);
|
||||
expect(document.body.spellcheck).toBe(true);
|
||||
|
||||
mockUseDesktopSetting.mockReturnValue([false, vi.fn<(value: boolean) => void>()]);
|
||||
rerender(<DesktopSpellcheck />);
|
||||
|
||||
expect(document.body.spellcheck).toBe(false);
|
||||
});
|
||||
|
||||
it('does not touch the body outside desktop Tauri builds', () => {
|
||||
mockIsDesktopTauri.mockReturnValue(false);
|
||||
mockUseDesktopSetting.mockReturnValue([false, vi.fn<(value: boolean) => void>()]);
|
||||
|
||||
render(<DesktopSpellcheck />);
|
||||
|
||||
expect(document.body.hasAttribute('spellcheck')).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,16 @@
|
||||
import { useEffect } from 'react';
|
||||
import { isDesktopTauri } from '$utils/platform';
|
||||
import { useDesktopSetting } from '$state/hooks/desktopSettings';
|
||||
|
||||
// Editable fields inherit their spellcheck state from <body>, so a single
|
||||
// attribute governs the composer and every text input.
|
||||
export function DesktopSpellcheck() {
|
||||
const [spellcheck] = useDesktopSetting('spellcheck');
|
||||
|
||||
useEffect(() => {
|
||||
if (!isDesktopTauri()) return;
|
||||
document.body.spellcheck = spellcheck;
|
||||
}, [spellcheck]);
|
||||
|
||||
return null;
|
||||
}
|
||||
@@ -13,20 +13,24 @@ const {
|
||||
mockUseDesktopRuntimeState,
|
||||
mockUseDesktopSettingsSyncing,
|
||||
mockSetUseCustomTitleBar,
|
||||
mockSetSpellcheck,
|
||||
} = vi.hoisted(() => {
|
||||
const setUseCustomTitleBarMock = vi.fn<(value: boolean) => void>();
|
||||
const setSpellcheckMock = vi.fn<(value: boolean) => void>();
|
||||
|
||||
return {
|
||||
mockUseDesktopSetting: vi.fn<
|
||||
(
|
||||
key: 'closeToBackgroundOnClose' | 'showSystemTrayIcon' | 'useCustomTitleBar'
|
||||
key: 'closeToBackgroundOnClose' | 'showSystemTrayIcon' | 'useCustomTitleBar' | 'spellcheck'
|
||||
) => readonly [boolean, (value: boolean) => void]
|
||||
>((key) => {
|
||||
if (key === 'useCustomTitleBar') return [true, setUseCustomTitleBarMock] as const;
|
||||
if (key === 'spellcheck') return [true, setSpellcheckMock] as const;
|
||||
if (key === 'closeToBackgroundOnClose') return [true, vi.fn<() => void>()] as const;
|
||||
return [true, vi.fn<() => void>()] as const;
|
||||
}),
|
||||
mockSetUseCustomTitleBar: setUseCustomTitleBarMock,
|
||||
mockSetSpellcheck: setSpellcheckMock,
|
||||
mockUseDesktopSettingsReady: vi.fn<() => boolean>(() => true),
|
||||
mockUseDesktopSettingsSyncing: vi.fn<() => boolean>(() => false),
|
||||
mockUseDesktopRuntimeState: vi.fn<() => { trayAvailable: boolean }>(() => ({
|
||||
@@ -115,7 +119,19 @@ describe('Desktop', () => {
|
||||
'Show a system tray icon while Sable is running. Disable this if you want Sable to stay available without a tray icon.'
|
||||
)
|
||||
).toBeInTheDocument();
|
||||
expect(container.getElementsByClassName(SequenceCardStyle)).toHaveLength(4);
|
||||
expect(screen.getByText('Spellcheck')).toBeInTheDocument();
|
||||
expect(
|
||||
screen.getByText('Underline misspelled words and offer corrections in text fields.')
|
||||
).toBeInTheDocument();
|
||||
expect(container.getElementsByClassName(SequenceCardStyle)).toHaveLength(5);
|
||||
});
|
||||
|
||||
it('updates the spellcheck setting from the Text input switch', () => {
|
||||
renderDesktop();
|
||||
|
||||
fireEvent.click(screen.getByRole('switch', { name: 'spellcheck' }));
|
||||
|
||||
expect(mockSetSpellcheck).toHaveBeenCalledWith(false);
|
||||
});
|
||||
|
||||
it('updates the custom title bar setting from the Window switch', () => {
|
||||
|
||||
@@ -26,6 +26,7 @@ export function Desktop({ requestBack, requestClose }: DesktopProps) {
|
||||
);
|
||||
const [showSystemTrayIcon, setShowSystemTrayIcon] = useDesktopSetting('showSystemTrayIcon');
|
||||
const [useCustomTitleBar, setUseCustomTitleBar] = useDesktopSetting('useCustomTitleBar');
|
||||
const [spellcheck, setSpellcheck] = useDesktopSetting('spellcheck');
|
||||
const [autoUpdateCheck, setAutoUpdateCheck] = useAtom(autoUpdateCheckAtom);
|
||||
|
||||
if (!isTauri() || !ready) return null;
|
||||
@@ -84,6 +85,17 @@ export function Desktop({ requestBack, requestClose }: DesktopProps) {
|
||||
/>
|
||||
)}
|
||||
</Box>
|
||||
<Box direction="Column" gap="100">
|
||||
<Text size="L400">Text input</Text>
|
||||
<SettingToggle
|
||||
title="Spellcheck"
|
||||
focusId="spellcheck"
|
||||
description="Underline misspelled words and offer corrections in text fields."
|
||||
value={spellcheck}
|
||||
onChange={setSpellcheck}
|
||||
ariaLabel="spellcheck"
|
||||
/>
|
||||
</Box>
|
||||
<Box direction="Column" gap="100">
|
||||
<Text size="L400">Updates</Text>
|
||||
<SettingToggle
|
||||
|
||||
@@ -223,6 +223,7 @@ export const settingsLinkFocusIdsBySection: Record<SettingsSectionId, readonly s
|
||||
'auto-update-check',
|
||||
'close-to-background-on-close',
|
||||
'show-system-tray-icon',
|
||||
'spellcheck',
|
||||
'use-custom-title-bar',
|
||||
],
|
||||
emojis: ['default-pack', 'select-pack'],
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type DesktopSettings = { closeToBackgroundOnClose: boolean, showSystemTrayIcon: boolean, useCustomTitleBar: boolean, };
|
||||
export type DesktopSettings = { closeToBackgroundOnClose: boolean, showSystemTrayIcon: boolean, useCustomTitleBar: boolean, spellcheck: boolean, };
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* Auto-generated TypeScript bindings for Tauri commands
|
||||
* Generated by tauri-typegen v0.5.0
|
||||
* Generated at: 2026-08-15T15:25:41.892923977+00:00
|
||||
* Generated at: 2026-08-18T09:43:40.541173302+00:00
|
||||
* Generator: none
|
||||
*
|
||||
* Do not edit manually - regenerate using: cargo tauri-typegen generate
|
||||
@@ -18,6 +18,7 @@ export interface DesktopSettings {
|
||||
closeToBackgroundOnClose: boolean;
|
||||
showSystemTrayIcon: boolean;
|
||||
useCustomTitleBar: boolean;
|
||||
spellcheck: boolean;
|
||||
}
|
||||
|
||||
export interface LoopbackFetchRequest {
|
||||
|
||||
@@ -104,32 +104,40 @@ describe('desktop settings state', () => {
|
||||
});
|
||||
|
||||
it('migrates the legacy background-running flag into close behavior', () => {
|
||||
expect(desktopSettingsFromStoreValues(false, false, true, undefined)).toEqual({
|
||||
expect(desktopSettingsFromStoreValues(false, false, true, undefined, undefined)).toEqual({
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('preserves an explicit close-off setting when the legacy flag is off', () => {
|
||||
expect(desktopSettingsFromStoreValues(false, true, false, undefined)).toEqual({
|
||||
expect(desktopSettingsFromStoreValues(false, true, false, undefined, undefined)).toEqual({
|
||||
closeToBackgroundOnClose: false,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('preserves an explicit custom title bar value over platform defaults', () => {
|
||||
expect(
|
||||
desktopSettingsFromStoreValues(undefined, undefined, undefined, false, 'windows')
|
||||
desktopSettingsFromStoreValues(undefined, undefined, undefined, false, undefined, 'windows')
|
||||
).toMatchObject({ useCustomTitleBar: false });
|
||||
expect(
|
||||
desktopSettingsFromStoreValues(undefined, undefined, undefined, true, 'macos')
|
||||
desktopSettingsFromStoreValues(undefined, undefined, undefined, true, undefined, 'macos')
|
||||
).toMatchObject({
|
||||
useCustomTitleBar: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('loads an explicit persisted spellcheck value', async () => {
|
||||
mockEntries.mockResolvedValue([['spellcheck', false]]);
|
||||
|
||||
await expect(getDesktopSetting('spellcheck')).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it('writes through the desktop settings atom and syncs runtime state', async () => {
|
||||
const store = createStore();
|
||||
const unsubscribe = store.sub(desktopSettingsReadyAtom, () => {});
|
||||
@@ -142,6 +150,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
});
|
||||
|
||||
expect(mockSet).not.toHaveBeenCalled();
|
||||
@@ -150,6 +159,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
expect(store.get(desktopRuntimeStateAtom)).toEqual({ trayAvailable: false });
|
||||
@@ -176,6 +186,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
});
|
||||
|
||||
await vi.waitFor(() => {
|
||||
@@ -196,19 +207,22 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: false,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: false,
|
||||
spellcheck: false,
|
||||
})
|
||||
).resolves.toEqual({ trayAvailable: false });
|
||||
|
||||
expect(mockSet).toHaveBeenCalledTimes(4);
|
||||
expect(mockSet).toHaveBeenCalledTimes(5);
|
||||
expect(mockSet).toHaveBeenCalledWith('closeToBackgroundOnClose', false);
|
||||
expect(mockSet).toHaveBeenCalledWith('showSystemTrayIcon', false);
|
||||
expect(mockSet).toHaveBeenCalledWith('keepBackgroundRunning', false);
|
||||
expect(mockSet).toHaveBeenCalledWith('useCustomTitleBar', false);
|
||||
expect(mockSet).toHaveBeenCalledWith('spellcheck', false);
|
||||
expect(mockSyncDesktopSettings).toHaveBeenCalledWith({
|
||||
settings: {
|
||||
closeToBackgroundOnClose: false,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: false,
|
||||
spellcheck: false,
|
||||
},
|
||||
});
|
||||
});
|
||||
@@ -231,6 +245,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
@@ -253,6 +268,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: false,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
@@ -275,6 +291,7 @@ describe('desktop settings state', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
@@ -29,6 +29,7 @@ export function desktopSettingsDefaultsForPlatform(platform: DesktopPlatform): D
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: platform === 'windows',
|
||||
spellcheck: true,
|
||||
};
|
||||
}
|
||||
export type DesktopSettingKey = keyof DesktopSettings;
|
||||
@@ -75,6 +76,7 @@ export function desktopSettingsFromStoreValues(
|
||||
showSystemTrayIcon: boolean | undefined,
|
||||
legacyKeepBackgroundRunning: boolean | undefined,
|
||||
useCustomTitleBar: boolean | undefined,
|
||||
spellcheck: boolean | undefined,
|
||||
platform = getDesktopTauriPlatform()
|
||||
): DesktopSettings {
|
||||
const defaults = desktopSettingsDefaultsForPlatform(platform);
|
||||
@@ -85,6 +87,7 @@ export function desktopSettingsFromStoreValues(
|
||||
readBoolean(legacyKeepBackgroundRunning, false),
|
||||
showSystemTrayIcon: readBoolean(showSystemTrayIcon, defaults.showSystemTrayIcon),
|
||||
useCustomTitleBar: readBoolean(useCustomTitleBar, defaults.useCustomTitleBar),
|
||||
spellcheck: readBoolean(spellcheck, defaults.spellcheck),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -113,18 +116,21 @@ export async function getDesktopSettings(): Promise<DesktopSettings> {
|
||||
showSystemTrayIcon,
|
||||
legacyKeepBackgroundRunning,
|
||||
useCustomTitleBar,
|
||||
spellcheck,
|
||||
] = await Promise.all([
|
||||
desktopSettingsStore.get<boolean>('closeToBackgroundOnClose'),
|
||||
desktopSettingsStore.get<boolean>('showSystemTrayIcon'),
|
||||
desktopSettingsStore.get<boolean>(LEGACY_KEEP_BACKGROUND_RUNNING_KEY),
|
||||
desktopSettingsStore.get<boolean>('useCustomTitleBar'),
|
||||
desktopSettingsStore.get<boolean>('spellcheck'),
|
||||
]);
|
||||
|
||||
currentDesktopSettings = desktopSettingsFromStoreValues(
|
||||
closeToBackgroundOnClose,
|
||||
showSystemTrayIcon,
|
||||
legacyKeepBackgroundRunning,
|
||||
useCustomTitleBar
|
||||
useCustomTitleBar,
|
||||
spellcheck
|
||||
);
|
||||
|
||||
return currentDesktopSettings;
|
||||
|
||||
@@ -94,6 +94,7 @@ describe('useDesktopSetting', () => {
|
||||
closeToBackgroundOnClose: true,
|
||||
showSystemTrayIcon: false,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
|
||||
@@ -128,6 +129,7 @@ describe('useDesktopSetting', () => {
|
||||
closeToBackgroundOnClose: false,
|
||||
showSystemTrayIcon: true,
|
||||
useCustomTitleBar: true,
|
||||
spellcheck: true,
|
||||
},
|
||||
});
|
||||
|
||||
|
||||
Reference in new issue
Block a user