Skip to content

Tankōbon / hooks/use-settings / useSettings

Function: useSettings() ​

useSettings(): object

Defined in: hooks/use-settings.ts:77

The app settings, shared by every component, and the function that changes one.

Returns ​

settings ​

settings: PublicSettings

update ​

update: <K>(key, value) => void

Updates one setting in every view immediately and persists it in the background.

Type Parameters ​

K ​

K extends "language" | "pageSpacing" | "theme" | "readerBackground" | "resyncOnStartup" | "askUserOnStartup" | "readingDirection" | "addOpenedBooksToLibrary" | "libraryView" | "readingListView" | "libraryGroupBySeries" | "librarySort" | "homeEnabled" | "homeSections" | "sidebarCollapsed" | "scrollDirection" | "readingMode" | "comicVineEnabled" | "googleBooksEnabled" | "checkUpdatesOnStartup" | "lastResyncAt" | "libraryOrganization" | "libraryOrganizationFolder" | "libraryStructure" | "libraryFileName" | "lastScanFolder"

Parameters ​

key ​

K

value ​

AppSettings[K] & PublicSettings[K]

Returns ​

void