forked from akai/readest
772bb73b46
* ui/ux: codify design system and migrate settings to shared primitives Document Readest's design language in DESIGN.md (Adwaita-aligned, e-ink-first, RTL-correct) and migrate every settings panel onto a small set of primitives (BoxedList, SettingsRow, SettingsSwitchRow, SettingsSelect, SettingsInput, NavigationRow, Tips, SubPageHeader). AGENTS.md links to DESIGN.md so contributors land there before inventing new chassis classes. Replace the standalone KOReader/Readwise/Hardcover Config dialogs with a single Integrations panel (Reading Sync + Content Sources sub-pages). The reader's BookMenu now hides each provider until it's configured, and Hardcover's per-book "Enable for This Book" toggle is dropped — there's no auto-sync to gate, so the flag was just extra clicks. Refresh highlight colors (two-trigger swatch + label, translatable default names), background texture / theme color selectors (border-current keeps selection legible on any backdrop), CustomFonts/CustomDictionaries (quiet list-extension style + shared Tips primitive), the OPDS catalog manager (debounced auto-download, right-aligned Browse), Set PIN, and the KOSync conflict resolver. Translate the ~30 new strings across all 33 locales. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * ui/ux: responsive typography, OPDS card polish, deep-link return paths Restore the .settings-content responsive cascade (14px desktop / 16px mobile) the legacy panels relied on by dropping hardcoded `text-sm`/`text-xs` from the new primitives. Secondary text moves to em-relative `text-[0.85em]` so it scales with the parent. Form controls (`<input>`, `<select>`) re-apply the cascade explicitly via the `settings-content` class since browsers don't inherit font-size onto form elements. Extract `<SectionTitle>` primitive (caseless-language aware via `isCaselessUILang`/`isCaselessLang`) and route every uppercase tag-style header through it: BoxedList groups, Reading Sync, Content Sources, Theme Color, Background Image, integration form labels, KOSyncResolver device labels, and the OPDS My Catalogs / Popular Catalogs sections. CJK / Arabic / Hebrew / Indic / Thai / Tibetan locales bump to `1em` since `uppercase` is a no-op on those scripts. Redesign the OPDS My Catalogs cards: whole card becomes the browse trigger (role='button'), edit/delete collapse into a 3-dot dropdown menu, and the sync-status moves to a sub-line under Auto-download so the card height stays constant whether the toggle is on/off or sync data has arrived. Plumb a `from=settings-integrations` URL marker through the OPDS browser so both manual close and auto-close-on-failure (preserved as `router.back()` for transient failures, paired with a new `stashOPDSReturnTarget` helper) return the user to Settings -> Integrations -> OPDS Catalogs sub-page rather than the dialog's top level. Backed by new `requestedSubPage` deep-link store field. Skip the OPDS catalog passphrase prompt when credentials sync is disabled -- `replicaPublish` already drops encrypted fields at the wire, so prompting was both pointless and confusing. Fix `SettingsDialog` calling `setRequestedPanel(null)` inside a `useState` lazy initializer (zustand setter during render -> React warning); move the clear into a one-shot `useEffect`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * ui/ux: opt Settings into OverlayScrollbars + caseless typography polish Add an opt-in `useOverlayScroll` prop to `<Dialog>` that swaps the body's native `overflow-y-auto` for `<OverlayScrollbarsComponent>` (autohide, click-scroll, no native overlaid bars). SettingsDialog flips it on so the long Layout / Color panels keep a visible, theme-aware scroll track on Android / iOS webviews where native scrollbars auto-hide entirely. Other short-modal callers stay on the native scrollbar. Drop the `uppercase tracking-wider` SectionTitle styling for caseless scripts and pair it with body-weight `font-medium` instead — those typographic effects are no-ops on Han / Hangul / Devanagari / Thai etc., so a plain medium-weight body-size title reads more correctly than a shrunken pseudo-uppercase one. SettingsRow / NavigationRow primary labels follow the same rule (drop `font-medium` in caseless locales since the inherited body weight already carries; CJK fonts bold poorly at body size). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * ui/ux: SettingLabel primitive + KOSyncForm select polish + Tips alignment Add `<SettingLabel>` primitive — caseless-aware row/field label that pairs with `<SectionTitle>` (groups) for per-item labels. Cased scripts get `font-medium`; caseless scripts (CJK / Arabic / Hebrew / Indic / Thai / Tibetan) drop the weight since Han / Hangul / Devanagari etc. bold poorly at body size. No font-size class so it inherits the `.settings-content` 14/16 cascade. Routed through `SettingsRow`, `NavigationRow`, and the ~12 ad-hoc inline `text-sm font-medium` callsites in AIPanel / FontPanel / ColorPanel / IntegrationsPanel / KOSync / Readwise / Hardcover forms. Refactor KOSyncForm's Sync Strategy + Checksum Method rows onto the shared `<SettingsSelect>` primitive — the inline 17-line div/select/ MdArrowDropDown chassis becomes a single SettingsSelect call with an options array. Drops the unused MdArrowDropDown import and ~25 lines. Fix Tips list-item alignment: callers traditionally pass `<li>` elements (semantic) but the primitive was double-wrapping into `<li><span><li>...</li></span></li>` — invalid HTML, and the inner `<li>`'s `display: list-item` broke line-wrap alignment on multi-line items. Unwrap caller `<li>` to its content; add `flex-1` on the text span so wrapped lines align under the first line instead of falling back to the bullet column. Bullet container switches to `h-[1.4em]` so it tracks the text line-height and pins to the first line's optical center via `items-center` regardless of how much the content wraps. DESIGN.md §5 typography updated to point primary-label callers at `<SettingLabel>`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
309 lines
12 KiB
TypeScript
309 lines
12 KiB
TypeScript
import clsx from 'clsx';
|
|
import React, { useState, useEffect, useMemo, useCallback } from 'react';
|
|
import { md5 } from 'js-md5';
|
|
import { type as osType } from '@tauri-apps/plugin-os';
|
|
import { useEnv } from '@/context/EnvContext';
|
|
import { useTranslation } from '@/hooks/useTranslation';
|
|
import { useSettingsStore } from '@/store/settingsStore';
|
|
import { eventDispatcher } from '@/utils/event';
|
|
import { KOSyncClient } from '@/services/sync/KOSyncClient';
|
|
import { KOSyncChecksumMethod, KOSyncStrategy } from '@/types/settings';
|
|
import { debounce } from '@/utils/debounce';
|
|
import { getOSPlatform } from '@/utils/misc';
|
|
import SubPageHeader from '../SubPageHeader';
|
|
import { SectionTitle, SettingLabel, SettingsSelect } from '../primitives';
|
|
|
|
interface KOSyncFormProps {
|
|
onBack: () => void;
|
|
}
|
|
|
|
const KOSyncForm: React.FC<KOSyncFormProps> = ({ onBack }) => {
|
|
const _ = useTranslation();
|
|
const { settings, setSettings, saveSettings } = useSettingsStore();
|
|
const { envConfig, appService } = useEnv();
|
|
|
|
const [url, setUrl] = useState(settings.kosync.serverUrl || '');
|
|
const [username, setUsername] = useState(settings.kosync.username || '');
|
|
const [password, setPassword] = useState('');
|
|
const [isConnecting, setIsConnecting] = useState(false);
|
|
const [deviceName, setDeviceName] = useState('');
|
|
const [osName, setOsName] = useState('');
|
|
|
|
useEffect(() => {
|
|
const formatOsName = (name: string): string => {
|
|
if (!name) return '';
|
|
if (name.toLowerCase() === 'macos') return 'macOS';
|
|
if (name.toLowerCase() === 'ios') return 'iOS';
|
|
return name.charAt(0).toUpperCase() + name.slice(1);
|
|
};
|
|
|
|
const getOsName = async () => {
|
|
let name = '';
|
|
if (appService?.appPlatform === 'tauri') {
|
|
name = await osType();
|
|
} else {
|
|
const platform = getOSPlatform();
|
|
if (platform !== 'unknown') {
|
|
name = platform;
|
|
}
|
|
}
|
|
setOsName(formatOsName(name));
|
|
};
|
|
getOsName();
|
|
}, [appService]);
|
|
|
|
useEffect(() => {
|
|
const defaultName = osName ? `Readest (${osName})` : 'Readest';
|
|
setDeviceName(settings.kosync.deviceName || defaultName);
|
|
}, [settings.kosync.deviceName, osName]);
|
|
|
|
const isConfigured = useMemo(() => !!settings.kosync.userkey, [settings.kosync.userkey]);
|
|
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
const debouncedSaveDeviceName = useCallback(
|
|
debounce((newDeviceName: string) => {
|
|
const newSettings = {
|
|
...settings,
|
|
kosync: { ...settings.kosync, deviceName: newDeviceName },
|
|
};
|
|
setSettings(newSettings);
|
|
saveSettings(envConfig, newSettings);
|
|
}, 500),
|
|
[settings, setSettings, saveSettings, envConfig],
|
|
);
|
|
|
|
const handleDeviceNameChange = (e: React.ChangeEvent<HTMLInputElement>) => {
|
|
const newName = e.target.value;
|
|
setDeviceName(newName);
|
|
debouncedSaveDeviceName(newName);
|
|
};
|
|
|
|
const handleConnect = async () => {
|
|
setIsConnecting(true);
|
|
const config = {
|
|
...settings.kosync,
|
|
serverUrl: url,
|
|
username,
|
|
userkey: md5(password),
|
|
password,
|
|
deviceName,
|
|
enabled: true,
|
|
};
|
|
const client = new KOSyncClient(config);
|
|
const result = await client.connect(username, password);
|
|
|
|
if (result.success) {
|
|
const newSettings = { ...settings, kosync: config };
|
|
setSettings(newSettings);
|
|
await saveSettings(envConfig, newSettings);
|
|
} else {
|
|
eventDispatcher.dispatch('toast', {
|
|
message: `${_('Failed to connect')}: ${_(result.message || 'Connection error')}`,
|
|
type: 'error',
|
|
});
|
|
}
|
|
setIsConnecting(false);
|
|
setPassword('');
|
|
};
|
|
|
|
const handleDisconnect = async () => {
|
|
const kosync = { ...settings.kosync, userkey: '', enabled: false };
|
|
const newSettings = { ...settings, kosync };
|
|
setSettings(newSettings);
|
|
await saveSettings(envConfig, newSettings);
|
|
setUsername('');
|
|
eventDispatcher.dispatch('toast', { message: _('Disconnected'), type: 'info' });
|
|
};
|
|
|
|
const handleToggleEnabled = async () => {
|
|
const kosync = { ...settings.kosync, enabled: !settings.kosync.enabled };
|
|
const newSettings = { ...settings, kosync };
|
|
setSettings(newSettings);
|
|
await saveSettings(envConfig, newSettings);
|
|
};
|
|
|
|
const handleStrategyChange = async (e: React.ChangeEvent<HTMLSelectElement>) => {
|
|
const kosync = { ...settings.kosync, strategy: e.target.value as KOSyncStrategy };
|
|
const newSettings = { ...settings, kosync };
|
|
setSettings(newSettings);
|
|
await saveSettings(envConfig, newSettings);
|
|
};
|
|
|
|
const handleChecksumMethodChange = async (e: React.ChangeEvent<HTMLSelectElement>) => {
|
|
const kosync = {
|
|
...settings.kosync,
|
|
checksumMethod: e.target.value as KOSyncChecksumMethod,
|
|
};
|
|
const newSettings = { ...settings, kosync };
|
|
setSettings(newSettings);
|
|
await saveSettings(envConfig, newSettings);
|
|
};
|
|
|
|
const description: string = isConfigured
|
|
? _('Sync as {{userDisplayName}}', { userDisplayName: settings.kosync.username })
|
|
: _('Connect to your KOReader Sync server.');
|
|
|
|
return (
|
|
<div className='w-full'>
|
|
<SubPageHeader
|
|
parentLabel={_('Integrations')}
|
|
currentLabel={_('KOReader Sync')}
|
|
description={description}
|
|
onBack={onBack}
|
|
/>
|
|
|
|
{isConfigured ? (
|
|
<div className='space-y-5'>
|
|
<div className='card eink-bordered border-base-200 bg-base-100 overflow-hidden border'>
|
|
<div className='divide-base-200 divide-y'>
|
|
{/* Each row uses min-h-14 + items-center so toggle/select/input
|
|
rows render at a uniform height regardless of the embedded
|
|
control's intrinsic size. Selects and inputs are end-aligned
|
|
to match modern preferences-panel convention. */}
|
|
<label className='flex min-h-14 items-center justify-between px-4'>
|
|
<SettingLabel>{_('Sync Server Connected')}</SettingLabel>
|
|
<input
|
|
type='checkbox'
|
|
className='toggle'
|
|
checked={settings.kosync.enabled}
|
|
onChange={handleToggleEnabled}
|
|
/>
|
|
</label>
|
|
{/* SettingsSelect handles the chromeless treatment, the
|
|
custom MdArrowDropDown icon at the trailing edge (so the
|
|
chevron lands at the same X as the toggle's right edge),
|
|
and the focus/hover signal — see DESIGN.md §5. */}
|
|
<div className='flex min-h-14 items-center justify-between gap-3 px-4'>
|
|
<SettingLabel>{_('Sync Strategy')}</SettingLabel>
|
|
<SettingsSelect
|
|
value={settings.kosync.strategy}
|
|
onChange={handleStrategyChange}
|
|
ariaLabel={_('Sync Strategy')}
|
|
options={[
|
|
{ value: 'prompt', label: _('Ask on conflict') },
|
|
{ value: 'silent', label: _('Always use latest') },
|
|
{ value: 'send', label: _('Send changes only') },
|
|
{ value: 'receive', label: _('Receive changes only') },
|
|
]}
|
|
/>
|
|
</div>
|
|
<div className='flex min-h-14 items-center justify-between gap-3 px-4'>
|
|
<SettingLabel>{_('Checksum Method')}</SettingLabel>
|
|
<SettingsSelect
|
|
value={settings.kosync.checksumMethod}
|
|
onChange={handleChecksumMethodChange}
|
|
ariaLabel={_('Checksum Method')}
|
|
options={[{ value: 'binary', label: _('File Content') }]}
|
|
/>
|
|
</div>
|
|
<div className='-me-2 flex min-h-14 items-center justify-between gap-3 px-4'>
|
|
<SettingLabel>{_('Device Name')}</SettingLabel>
|
|
<input
|
|
type='text'
|
|
placeholder={osName ? `Readest (${osName})` : 'Readest'}
|
|
className='input h-9 max-w-[60%] rounded-md !border-0 !bg-transparent !pe-3 !ps-2 text-end text-sm hover:!bg-transparent focus:!border-0 focus:!bg-transparent focus:!shadow-none focus:!outline-none focus:!ring-0'
|
|
value={deviceName}
|
|
onChange={handleDeviceNameChange}
|
|
/>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div className='flex justify-end'>
|
|
<button
|
|
type='button'
|
|
onClick={handleDisconnect}
|
|
className={clsx(
|
|
'eink-bordered',
|
|
'h-10 rounded-lg px-4 text-sm font-medium',
|
|
'text-error hover:bg-error/10',
|
|
'transition-colors duration-150',
|
|
'focus-visible:ring-error/40 focus-visible:outline-none focus-visible:ring-2',
|
|
)}
|
|
>
|
|
{_('Disconnect')}
|
|
</button>
|
|
</div>
|
|
</div>
|
|
) : (
|
|
<div className='space-y-5'>
|
|
<form
|
|
className='space-y-4'
|
|
onSubmit={(e) => {
|
|
e.preventDefault();
|
|
handleConnect();
|
|
}}
|
|
>
|
|
<div className='space-y-1.5'>
|
|
<SectionTitle as='label' htmlFor='kosync-server-url' className='block'>
|
|
{_('Server URL')}
|
|
</SectionTitle>
|
|
<input
|
|
id='kosync-server-url'
|
|
type='text'
|
|
placeholder='https://koreader.sync.server'
|
|
className='input input-bordered eink-bordered h-11 w-full text-sm focus:outline-none'
|
|
spellCheck='false'
|
|
value={url}
|
|
onChange={(e) => setUrl(e.target.value)}
|
|
/>
|
|
</div>
|
|
|
|
<div className='space-y-1.5'>
|
|
<SectionTitle as='label' htmlFor='kosync-username' className='block'>
|
|
{_('Username')}
|
|
</SectionTitle>
|
|
<input
|
|
id='kosync-username'
|
|
type='text'
|
|
placeholder={_('Your Username')}
|
|
className='input input-bordered eink-bordered h-11 w-full text-sm focus:outline-none'
|
|
spellCheck='false'
|
|
value={username}
|
|
onChange={(e) => setUsername(e.target.value)}
|
|
autoComplete='username'
|
|
/>
|
|
</div>
|
|
|
|
<div className='space-y-1.5'>
|
|
<SectionTitle as='label' htmlFor='kosync-password' className='block'>
|
|
{_('Password')}
|
|
</SectionTitle>
|
|
<input
|
|
id='kosync-password'
|
|
type='password'
|
|
placeholder={_('Your Password')}
|
|
className='input input-bordered eink-bordered h-11 w-full text-sm focus:outline-none'
|
|
value={password}
|
|
onChange={(e) => setPassword(e.target.value)}
|
|
autoComplete='current-password'
|
|
/>
|
|
</div>
|
|
|
|
<div className='flex justify-end pt-1'>
|
|
<button
|
|
type='submit'
|
|
disabled={isConnecting || !url || !username || !password}
|
|
className={clsx(
|
|
'btn btn-primary',
|
|
'h-10 min-h-10 rounded-lg border-0 px-5 text-sm font-medium',
|
|
'focus-visible:ring-primary/40 focus-visible:outline-none focus-visible:ring-2',
|
|
isConnecting && 'opacity-60',
|
|
)}
|
|
>
|
|
{isConnecting ? (
|
|
<span className='loading loading-spinner loading-sm' />
|
|
) : (
|
|
_('Connect')
|
|
)}
|
|
</button>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
)}
|
|
</div>
|
|
);
|
|
};
|
|
|
|
export default KOSyncForm;
|