readest / apps /readest-app /src /app /reader /hooks /useBookShortcuts.ts
dlxj
init
4e1096a
import { useEffect, useRef } from 'react';
import { useReaderStore } from '@/store/readerStore';
import { useNotebookStore } from '@/store/notebookStore';
import { isTauriAppPlatform } from '@/services/environment';
import { useSidebarStore } from '@/store/sidebarStore';
import { useSettingsStore } from '@/store/settingsStore';
import { useBookDataStore } from '@/store/bookDataStore';
import { useCommandPalette } from '@/components/command-palette';
import { tauriHandleClose, tauriHandleToggleFullScreen, tauriQuitApp } from '@/utils/window';
import { eventDispatcher } from '@/utils/event';
import { MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, ZOOM_STEP } from '@/services/constants';
import { viewPagination } from './usePagination';
import { getStyles } from '@/utils/style';
import useShortcuts from '@/hooks/useShortcuts';
import useBooksManager from './useBooksManager';
interface UseBookShortcutsProps {
sideBarBookKey: string | null;
bookKeys: string[];
}
const useBookShortcuts = ({ sideBarBookKey, bookKeys }: UseBookShortcutsProps) => {
const { getView, getViewState, getViewSettings, setViewSettings } = useReaderStore();
const { toggleSideBar, setSideBarBookKey } = useSidebarStore();
const { setSettingsDialogOpen } = useSettingsStore();
const { getBookData } = useBookDataStore();
const { toggleNotebook } = useNotebookStore();
const { getNextBookKey } = useBooksManager();
const { open: openCommandPalette } = useCommandPalette();
const lastParagraphToggleRef = useRef(0);
const viewSettings = getViewSettings(sideBarBookKey ?? '');
const fontSize = viewSettings?.defaultFontSize ?? 16;
const lineHeight = viewSettings?.lineHeight ?? 1.6;
const distance = fontSize * lineHeight * 3;
const toggleScrollMode = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
if (viewSettings && sideBarBookKey) {
viewSettings.scrolled = !viewSettings.scrolled;
setViewSettings(sideBarBookKey, viewSettings!);
const flowMode = viewSettings.scrolled ? 'scrolled' : 'paginated';
getView(sideBarBookKey)?.renderer.setAttribute('flow', flowMode);
}
};
const switchSideBar = () => {
if (sideBarBookKey) setSideBarBookKey(getNextBookKey(sideBarBookKey));
};
const goLeft = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
// If paragraph mode is enabled, navigate to previous paragraph instead
if (viewSettings?.paragraphMode?.enabled && sideBarBookKey) {
eventDispatcher.dispatch('paragraph-prev', { bookKey: sideBarBookKey });
return;
}
viewPagination(getView(sideBarBookKey), viewSettings, 'left', 'pan', distance);
};
const goRight = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
// If paragraph mode is enabled, navigate to next paragraph instead
if (viewSettings?.paragraphMode?.enabled && sideBarBookKey) {
eventDispatcher.dispatch('paragraph-next', { bookKey: sideBarBookKey });
return;
}
viewPagination(getView(sideBarBookKey), viewSettings, 'right', 'pan', distance);
};
const goUp = (event?: KeyboardEvent | MessageEvent) => {
const view = getView(sideBarBookKey);
const viewSettings = getViewSettings(sideBarBookKey ?? '');
// If paragraph mode is enabled, navigate to previous paragraph instead
if (viewSettings?.paragraphMode?.enabled && sideBarBookKey) {
eventDispatcher.dispatch('paragraph-prev', { bookKey: sideBarBookKey });
return;
}
if (view?.renderer.scrolled && event instanceof MessageEvent) return;
viewPagination(view, viewSettings, 'up', 'pan', distance);
};
const goDown = (event?: KeyboardEvent | MessageEvent) => {
const view = getView(sideBarBookKey);
const viewSettings = getViewSettings(sideBarBookKey ?? '');
// If paragraph mode is enabled, navigate to next paragraph instead
if (viewSettings?.paragraphMode?.enabled && sideBarBookKey) {
eventDispatcher.dispatch('paragraph-next', { bookKey: sideBarBookKey });
return;
}
if (view?.renderer.scrolled && event instanceof MessageEvent) return;
viewPagination(view, viewSettings, 'down', 'pan', distance);
};
const goPrevSection = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
viewPagination(getView(sideBarBookKey), viewSettings, 'up', 'section');
};
const goNextSection = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
viewPagination(getView(sideBarBookKey), viewSettings, 'down', 'section');
};
const goLeftSection = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
viewPagination(getView(sideBarBookKey), viewSettings, 'left', 'section');
};
const goRightSection = () => {
const viewSettings = getViewSettings(sideBarBookKey ?? '');
viewPagination(getView(sideBarBookKey), viewSettings, 'right', 'section');
};
const goPrev = () => {
getView(sideBarBookKey)?.prev(distance);
};
const goNext = () => {
getView(sideBarBookKey)?.next(distance);
};
const goBack = () => {
getView(sideBarBookKey)?.history.back();
};
const goHalfPageDown = () => {
const view = getView(sideBarBookKey);
const viewSettings = getViewSettings(sideBarBookKey ?? '');
if (view && viewSettings && viewSettings.scrolled) {
view.next(view.renderer.size / 2);
}
};
const goHalfPageUp = () => {
const view = getView(sideBarBookKey);
const viewSettings = getViewSettings(sideBarBookKey ?? '');
if (view && viewSettings && viewSettings.scrolled) {
view.prev(view.renderer.size / 2);
}
};
const goForward = () => {
getView(sideBarBookKey)?.history.forward();
};
const reloadPage = () => {
window.location.reload();
};
const toggleFullscreen = async () => {
if (isTauriAppPlatform()) {
await tauriHandleToggleFullScreen();
}
};
const closeWindow = async () => {
if (isTauriAppPlatform()) {
await tauriHandleClose();
}
};
const quitApp = async () => {
// on web platform use browser's default shortcut to close the tab
if (isTauriAppPlatform()) {
await tauriQuitApp();
}
};
const showSearchBar = () => {
setTimeout(() => {
eventDispatcher.dispatch('search-term', { term: null, bookKey: sideBarBookKey });
}, 100);
};
const applyZoomLevel = (zoomLevel: number) => {
if (!sideBarBookKey) return;
const view = getView(sideBarBookKey);
const bookData = getBookData(sideBarBookKey);
const viewSettings = getViewSettings(sideBarBookKey)!;
viewSettings!.zoomLevel = zoomLevel;
setViewSettings(sideBarBookKey, viewSettings!);
view?.renderer.setStyles?.(getStyles(viewSettings!));
if (bookData?.bookDoc?.rendition?.layout === 'pre-paginated') {
view?.renderer.setAttribute('scale-factor', zoomLevel);
}
};
const zoomInFactor = (factor = 1.0) => {
if (!sideBarBookKey) return;
const viewSettings = getViewSettings(sideBarBookKey)!;
const zoomLevel = viewSettings!.zoomLevel + ZOOM_STEP * factor;
applyZoomLevel(Math.min(zoomLevel, MAX_ZOOM_LEVEL));
};
const zoomOutFactor = (factor = 1.0) => {
if (!sideBarBookKey) return;
const viewSettings = getViewSettings(sideBarBookKey)!;
const zoomLevel = viewSettings!.zoomLevel - ZOOM_STEP * factor;
applyZoomLevel(Math.max(zoomLevel, MIN_ZOOM_LEVEL));
};
const zoomIn = () => {
zoomInFactor();
};
const zoomOut = () => {
zoomOutFactor();
};
const handleZoomIn = (event: CustomEvent) => {
const factor = event.detail?.factor || 1.0;
zoomInFactor(factor);
};
const handleZoomOut = (event: CustomEvent) => {
const factor = event.detail?.factor || 1.0;
zoomOutFactor(factor);
};
const resetZoom = () => {
if (!sideBarBookKey) return;
applyZoomLevel(100);
};
const toggleTTS = () => {
if (!sideBarBookKey) return;
const bookKey = sideBarBookKey;
const viewState = getViewState(bookKey);
eventDispatcher.dispatch(viewState?.ttsEnabled ? 'tts-stop' : 'tts-speak', { bookKey });
};
const toggleBookmark = () => {
if (!sideBarBookKey) return;
eventDispatcher.dispatch('toggle-bookmark', { bookKey: sideBarBookKey });
};
const toggleParagraphMode = (event?: KeyboardEvent | MessageEvent) => {
if (!sideBarBookKey) return false;
if (event instanceof KeyboardEvent && event.repeat) return true;
const now = Date.now();
if (now - lastParagraphToggleRef.current < 300) return true;
lastParagraphToggleRef.current = now;
eventDispatcher.dispatch('toggle-paragraph-mode', { bookKey: sideBarBookKey });
return true;
};
useEffect(() => {
eventDispatcher.on('zoom-in', handleZoomIn);
eventDispatcher.on('zoom-out', handleZoomOut);
eventDispatcher.on('reset-zoom', resetZoom);
return () => {
eventDispatcher.off('zoom-in', handleZoomIn);
eventDispatcher.off('zoom-out', handleZoomOut);
eventDispatcher.off('reset-zoom', resetZoom);
};
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [sideBarBookKey]);
useShortcuts(
{
onSwitchSideBar: switchSideBar,
onToggleSideBar: toggleSideBar,
onToggleNotebook: toggleNotebook,
onToggleScrollMode: toggleScrollMode,
onToggleBookmark: toggleBookmark,
onToggleParagraphMode: toggleParagraphMode,
onOpenFontLayoutSettings: () => setSettingsDialogOpen(true),
onShowSearchBar: showSearchBar,
onToggleFullscreen: toggleFullscreen,
onToggleTTS: toggleTTS,
onReloadPage: reloadPage,
onCloseWindow: closeWindow,
onQuitApp: quitApp,
onGoLeft: goLeft,
onGoRight: goRight,
onGoUp: goUp,
onGoDown: goDown,
onGoPrev: goPrev,
onGoNext: goNext,
onGoHalfPageDown: goHalfPageDown,
onGoHalfPageUp: goHalfPageUp,
onGoPrevSection: goPrevSection,
onGoNextSection: goNextSection,
onGoLeftSection: goLeftSection,
onGoRightSection: goRightSection,
onGoBack: goBack,
onGoForward: goForward,
onZoomIn: zoomIn,
onZoomOut: zoomOut,
onResetZoom: resetZoom,
onOpenCommandPalette: openCommandPalette,
},
[sideBarBookKey, bookKeys],
);
};
export default useBookShortcuts;