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>
221 lines
7.4 KiB
TypeScript
221 lines
7.4 KiB
TypeScript
import clsx from 'clsx';
|
|
import React, { useEffect, useRef, useState } from 'react';
|
|
|
|
import { useEnv } from '@/context/EnvContext';
|
|
import { useReaderStore } from '@/store/readerStore';
|
|
import { useSettingsStore } from '@/store/settingsStore';
|
|
import { useTranslation } from '@/hooks/useTranslation';
|
|
import { useResetViewSettings } from '@/hooks/useResetSettings';
|
|
import { SettingsPanelPanelProp } from './SettingsDialog';
|
|
import { saveViewSettings } from '@/helpers/settings';
|
|
import { validateCSS, formatCSS } from '@/utils/css';
|
|
import { getStyles } from '@/utils/style';
|
|
import { BoxedList } from './primitives';
|
|
|
|
type CSSType = 'book' | 'reader';
|
|
|
|
const MiscPanel: React.FC<SettingsPanelPanelProp> = ({ bookKey, onRegisterReset }) => {
|
|
const _ = useTranslation();
|
|
const { appService, envConfig } = useEnv();
|
|
const { settings } = useSettingsStore();
|
|
const { getView, getViewSettings, setViewSettings } = useReaderStore();
|
|
const viewSettings = getViewSettings(bookKey) || settings.globalViewSettings;
|
|
|
|
const [draftContentStylesheet, setDraftContentStylesheet] = useState(viewSettings.userStylesheet);
|
|
const [draftContentStylesheetSaved, setDraftContentStylesheetSaved] = useState(true);
|
|
const [contentError, setContentError] = useState<string | null>(null);
|
|
const [draftUIStylesheet, setDraftUIStylesheet] = useState(viewSettings.userUIStylesheet);
|
|
const [draftUIStylesheetSaved, setDraftUIStylesheetSaved] = useState(true);
|
|
const [uiError, setUIError] = useState<string | null>(null);
|
|
|
|
const [inputFocusInAndroid, setInputFocusInAndroid] = useState(false);
|
|
const contentTextareaRef = useRef<HTMLTextAreaElement | null>(null);
|
|
const uiTextareaRef = useRef<HTMLTextAreaElement | null>(null);
|
|
|
|
const resetToDefaults = useResetViewSettings();
|
|
|
|
const handleReset = () => {
|
|
resetToDefaults({
|
|
userStylesheet: setDraftContentStylesheet,
|
|
userUIStylesheet: setDraftUIStylesheet,
|
|
});
|
|
applyStyles('book', true);
|
|
applyStyles('reader', true);
|
|
};
|
|
|
|
useEffect(() => {
|
|
onRegisterReset(handleReset);
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, []);
|
|
|
|
const handleValidateCSS = (cssInput: string): { isValid: boolean; error?: string } => {
|
|
if (!cssInput.trim()) return { isValid: true };
|
|
|
|
try {
|
|
const { isValid, error } = validateCSS(cssInput);
|
|
if (!isValid) {
|
|
return { isValid: false, error: error || 'Invalid CSS' };
|
|
}
|
|
return { isValid: true };
|
|
} catch (err: unknown) {
|
|
if (err instanceof Error) {
|
|
return { isValid: false, error: err.message };
|
|
}
|
|
return { isValid: false, error: 'Invalid CSS: Please check your input.' };
|
|
}
|
|
};
|
|
|
|
const handleStylesheetChange = (e: React.ChangeEvent<HTMLTextAreaElement>, type: CSSType) => {
|
|
const cssInput = e.target.value;
|
|
|
|
if (type === 'book') {
|
|
setDraftContentStylesheet(cssInput);
|
|
setDraftContentStylesheetSaved(false);
|
|
|
|
const { isValid, error } = handleValidateCSS(cssInput);
|
|
setContentError(isValid ? null : error || 'Invalid CSS');
|
|
} else {
|
|
setDraftUIStylesheet(cssInput);
|
|
setDraftUIStylesheetSaved(false);
|
|
|
|
const { isValid, error } = handleValidateCSS(cssInput);
|
|
setUIError(isValid ? null : error || 'Invalid CSS');
|
|
}
|
|
};
|
|
|
|
const applyStyles = (type: CSSType, clear = false) => {
|
|
const cssInput = type === 'book' ? draftContentStylesheet : draftUIStylesheet;
|
|
const formattedCSS = formatCSS(clear ? '' : cssInput);
|
|
|
|
if (type === 'book') {
|
|
setDraftContentStylesheet(formattedCSS);
|
|
setDraftContentStylesheetSaved(true);
|
|
viewSettings.userStylesheet = formattedCSS;
|
|
} else {
|
|
setDraftUIStylesheet(formattedCSS);
|
|
setDraftUIStylesheetSaved(true);
|
|
viewSettings.userUIStylesheet = formattedCSS;
|
|
}
|
|
|
|
setViewSettings(bookKey, { ...viewSettings });
|
|
getView(bookKey)?.renderer.setStyles?.(getStyles(viewSettings));
|
|
saveViewSettings(
|
|
envConfig,
|
|
bookKey,
|
|
type === 'book' ? 'userStylesheet' : 'userUIStylesheet',
|
|
formattedCSS,
|
|
false,
|
|
false,
|
|
);
|
|
};
|
|
|
|
const handleInput = (e: React.FormEvent<HTMLTextAreaElement>) => {
|
|
e.stopPropagation();
|
|
e.nativeEvent.stopImmediatePropagation();
|
|
};
|
|
|
|
const handleInputFocus = (textareaRef: React.RefObject<HTMLTextAreaElement | null>) => {
|
|
if (appService?.isAndroidApp) {
|
|
setInputFocusInAndroid(true);
|
|
}
|
|
setTimeout(() => {
|
|
textareaRef.current?.scrollIntoView({
|
|
behavior: 'instant',
|
|
block: 'center',
|
|
});
|
|
}, 300);
|
|
};
|
|
|
|
const handleInputBlur = () => {
|
|
if (appService?.isAndroidApp) {
|
|
setTimeout(() => {
|
|
setInputFocusInAndroid(false);
|
|
}, 100);
|
|
}
|
|
};
|
|
|
|
const renderCSSEditor = (
|
|
type: CSSType,
|
|
title: string,
|
|
placeholder: string,
|
|
value: string,
|
|
error: string | null,
|
|
saved: boolean,
|
|
textareaRef: React.RefObject<HTMLTextAreaElement | null>,
|
|
settingId?: string,
|
|
) => (
|
|
<div className='w-full'>
|
|
<BoxedList title={_(title)} data-setting-id={settingId} innerClassName='!ps-0'>
|
|
{/* Single full-width child instead of typical settings rows — the
|
|
textarea owns the whole card surface. Apply button overlays at
|
|
the bottom-trailing corner; visible only when there are unsaved
|
|
edits and no validation error. */}
|
|
<div className={clsx('relative p-1', error && 'ring-error/60 rounded-2xl ring-1')}>
|
|
<textarea
|
|
ref={textareaRef}
|
|
className={clsx(
|
|
'textarea textarea-ghost h-48 w-full border-0 p-3 text-base !outline-none sm:text-sm',
|
|
'placeholder:text-base-content/70',
|
|
)}
|
|
placeholder={_(placeholder)}
|
|
spellCheck='false'
|
|
value={value}
|
|
onFocus={() => handleInputFocus(textareaRef)}
|
|
onBlur={handleInputBlur}
|
|
onInput={handleInput}
|
|
onKeyDown={handleInput}
|
|
onKeyUp={handleInput}
|
|
onChange={(e) => handleStylesheetChange(e, type)}
|
|
/>
|
|
<button
|
|
className={clsx(
|
|
'hover:bg-base-300 bg-base-200 absolute bottom-2 end-4 inline-flex h-8 items-center rounded-md px-3 text-xs font-medium transition-colors duration-150',
|
|
'focus-visible:ring-base-content/15 focus-visible:outline-none focus-visible:ring-2',
|
|
saved ? 'hidden' : '',
|
|
error ? 'pointer-events-none opacity-50' : '',
|
|
)}
|
|
onClick={() => applyStyles(type)}
|
|
disabled={!!error}
|
|
>
|
|
{_('Apply')}
|
|
</button>
|
|
</div>
|
|
</BoxedList>
|
|
{error && <p className='text-error mt-1 ps-4 text-sm'>{error}</p>}
|
|
</div>
|
|
);
|
|
|
|
return (
|
|
<div
|
|
className={clsx(
|
|
'my-4 w-full space-y-6',
|
|
inputFocusInAndroid && 'h-[50%] overflow-y-auto pb-[200px]',
|
|
)}
|
|
>
|
|
{renderCSSEditor(
|
|
'book',
|
|
_('Custom Content CSS'),
|
|
_('Enter CSS for book content styling...'),
|
|
draftContentStylesheet,
|
|
contentError,
|
|
draftContentStylesheetSaved,
|
|
contentTextareaRef,
|
|
'settings.custom.contentCss',
|
|
)}
|
|
|
|
{renderCSSEditor(
|
|
'reader',
|
|
_('Custom Reader UI CSS'),
|
|
_('Enter CSS for reader interface styling...'),
|
|
draftUIStylesheet,
|
|
uiError,
|
|
draftUIStylesheetSaved,
|
|
uiTextareaRef,
|
|
'settings.custom.readerUiCss',
|
|
)}
|
|
</div>
|
|
);
|
|
};
|
|
|
|
export default MiscPanel;
|