Skip to content

Main Navigation Guide Architecture Reference

Appearance

Sidebar Navigation

Guide

Features

Contributors

Development

Architecture

Decision records

Reference (generated)

IPC channels

Database schema

TypeScript API

hooks

use-achievements

Functions

useAchievements

useAchievementStats

useAchievementTracker

useOpeningAchievements

use-comic

Interfaces

UseComicOptions

Functions

useComic

use-fullscreen

Functions

useFullscreen

use-image-scan

Functions

useImageScan

use-image-upscaler

Interfaces

ImageUpscalerResult

Functions

useImageUpscaler

use-launch-file

Functions

useLaunchFile

use-library

Functions

useLibrary

use-next-in-list

Interfaces

NextInList

Functions

useNextInList

use-organization-offer

Functions

useOrganizationOffer

use-reader-fullscreen

Interfaces

ReaderFullscreen

Functions

useReaderFullscreen

use-reading-lists

Functions

useReadingLists

use-reading-pace

Interfaces

ReadingPace

Functions

formatRemainingTime

useReadingPace

use-reading-time

Functions

useReadingTime

use-resume-scroll

Functions

useResumeScroll

use-settings

Functions

applyInterfaceLanguage

keepInterfaceLanguageInSync

keepThemeInSync

loadSystemLanguages

systemLanguage

useSettings

use-settled-value

Functions

useSettledValue

use-users

Functions

useActiveUser

useUsers

lib

achievements

Interfaces

AchievementRule

AchievementStats

OpeningContext

Variables

ACHIEVEMENT_RULES

Functions

achievementProgress

computeStats

earnedFromStats

eventAchievements

app-data

Variables

appData

avatar

Functions

shrinkAvatar

squareCrop

book-edit

Interfaces

BookForm

CreditRow

Type Aliases

BookFormErrors

BookFormField

Variables

BOOK_LANGUAGES

Functions

entryToForm

formToUpdate

isValidForm

isValidReleaseDate

newCreditRow

validateForm

continue-reading

Variables

CONTINUE_READING_COUNT

Functions

continueReading

data-store

Classes

DataStore

Interfaces

DataSource

Type Aliases

DataSlice

Functions

applyLibraryChange

home-favorites

Variables

FAVORITES_COUNT

Functions

topRated

home-picks

Variables

HOME_PICK_COUNT

Functions

pickRandomUnread

home-sections

Type Aliases

ResolvedHomeSection

Functions

clampHomeCount

moveHomeSection

resolveHomeSections

setHomeSectionOptions

setHomeSectionVisible

visibleHomeSections

image-scan

Functions

formatPageSize

imageScanPercent

language-flag

Functions

languageCountry

library-editions

Functions

collapseEditions

editionGroups

editionKey

library-filter

Interfaces

LibraryFilters

Type Aliases

RatingFilter

Variables

EMPTY_FILTERS

Functions

availableTags

filterEntries

hasActiveFilters

hasFiche

matchesFilters

library-groups

Interfaces

CardsRow

EntryRow

SeriesHeaderRow

Type Aliases

LibraryLine

LibraryRow

Variables

NO_SERIES_KEY

Functions

gridLines

groupBySeries

seriesKey

ungroupedRows

library-selection

Functions

draggedEntries

selectedEntries

toggleSelection

library-sort

Functions

sortEntries

library-structure

Functions

fileNameExample

levelChoices

setLevel

structureExample

lru-cache

Interfaces

LruCache

Functions

createLruCache

metadata-review

Interfaces

CreditReview

FieldReview

MetadataReview

Type Aliases

ReviewField

Variables

REVIEW_FIELDS

Functions

buildReview

creditRoleLabel

isEmptyUpdate

reviewFieldLabel

reviewToUpdate

reader-navigation

Interfaces

DirectionalControls

Functions

directionalControls

disabledControls

scrollEdgeAfterTurn

reading-list

Interfaces

BulkAddRequest

DraggedEntry

DropFeedback

ListProgress

Variables

LIBRARY_ENTRY_DRAG_TYPE

QUICK_TAGS

TO_READ_TAG

Functions

bulkAddFeedback

bulkAddRequest

decodeDraggedEntries

dropFeedback

encodeDraggedEntries

isFinished

listEntries

listProgress

moveItem

moveUnfinished

nextToRead

seriesEntries

tagLabel

toggleTag

reading-stats

Interfaces

LibraryTotals

StatsBucket

Type Aliases

StatsPeriod

Variables

MONTHS_SHOWN

Functions

buildBuckets

formatDuration

libraryTotals

periodKey

periodLabel

totalSeconds

reading-time

Interfaces

ReadingTimeAccumulator

Variables

FLUSH_AFTER_SECONDS

Functions

createReadingTimeAccumulator

recent-books

Variables

RECENT_BOOKS_COUNT

Functions

recentlyAdded

second-chance

Variables

LOW_RATING_MAX

SECOND_CHANCE_LIMIT

Functions

lowestRated

settings-nav

Interfaces

SettingsSection

Variables

SETTINGS_SECTIONS

theme

Functions

isDarkTheme

trailing-debounce

Interfaces

TrailingDebounce

Functions

createTrailingDebounce

user-choice

Functions

markUserChoiceDone

userChoiceDone

utils

Functions

cn

formatFileSize

formatLanguage

wheel-pager

Functions

createWheelPager

main

db

achievement-repository

Classes

database

Functions

db-location

Functions

export-service

Interfaces

Functions

import-service

Functions

library-folder-repository

Classes

library-repository

Classes

path-roots

Classes

Interfaces

Variables

Functions

people-repository

Classes

Interfaces

reading-list-repository

Classes

schema

Variables

Functions

settings-repository

Classes

stats-repository

Classes

Functions

transaction

Functions

user-repository

Classes

decoder

protocol

Interfaces

Type Aliases

services

bedetheque

Functions

cbr-archive

Classes

cbz-archive

Classes

comic-archive

Interfaces

Variables

Functions

comic-service

Classes

Variables

Functions

comic-vine

Classes

Functions

google-books

Classes

Interfaces

Functions

http-json

Interfaces

Variables

Functions

image-size

Interfaces

Variables

Functions

image-stats

Functions

image-stats-scanner

Interfaces

Functions

library-organization

Interfaces

Type Aliases

Variables

Functions

library-organizer

Interfaces

Type Aliases

Variables

Functions

library-scanner

Interfaces

Functions

library-sync

Interfaces

Functions

metadata-service

Type Aliases

Functions

open-error

Functions

pdf-archive

Classes

Variables

Functions

thumbnail-cache

Classes

Variables

Functions

update-checker

Variables

Functions

preload

Interfaces

AchievementsApi

AppApi

ComicApi

DataApi

DatabaseApi

LibraryApi

MetadataApi

ReadingListApi

SettingsApi

StatsApi

TankobonApi

UsersApi

shared

achievements

Interfaces

UnlockedAchievement

Type Aliases

AchievementGroup

AchievementId

Variables

ACHIEVEMENT_GROUPS

ACHIEVEMENT_IDS

Functions

isAchievementId

app

Interfaces

AppInfo

Type Aliases

AppLink

UpdateCheckResult

Variables

APP_LINKS

Functions

formatAppInfo

isAppLink

isNewerVersion

parseVersion

comic

Interfaces

ArchiveInfo

ComicInfo

ComicPage

Type Aliases

ComicFormat

OpenComicResult

Variables

SUPPORTED_COMIC_EXTENSIONS

Functions

comicFormat

isSupportedComicFile

data

Interfaces

DatabaseLocation

Type Aliases

ClearLibraryResult

DatabaseLocationResult

ExportResult

ImportResult

data-changes

Interfaces

AchievementsChange

LibraryChange

ReadingListsChange

SettingsChange

UsersChange

Type Aliases

DataChange

file-name-template

Type Aliases

FileNameField

Variables

FILE_NAME_FIELDS

MAX_FILE_NAME_TEMPLATE_LENGTH

Functions

fileNameTemplateError

fillFileNameTemplate

isFileNameTemplate

i18n

Type Aliases

Language

LanguageSetting

Variables

FALLBACK_LANGUAGE

i18n

LANGUAGE_NAMES

SUPPORTED_LANGUAGES

t

Functions

applyLanguage

currentLanguage

isSupportedLanguage

resolveLanguage

library

Interfaces

Credit

CreditInput

ImageScanProgress

LibraryEntry

MetadataUpdate

OrganizationOutcome

PersonName

ScanProgress

UnlinkedFolder

Type Aliases

AddFileResult

CreditRole

OrganizeResult

PickOrganizationFolderResult

RelinkFolderResult

ResyncResult

ScanResult

UnorganizedCountResult

Variables

CREDIT_ROLES

READ_TAG

metadata

Interfaces

MetadataCandidate

MetadataQuery

Type Aliases

MetadataPageResult

MetadataSearchResult

MetadataSource

Variables

METADATA_SOURCE_LABELS

Functions

isBedethequeAlbumUrl

reading-list

Interfaces

ReadingList

Type Aliases

ReadingListAddResult

ReadingListOrderResult

ReadingListResult

Variables

MAX_READING_LIST_SIZE

settings

Interfaces

AppSettings

HomeSectionSetting

ReaderBackgroundPreset

Type Aliases

ApiKeys

ApiKeySetting

BookRowView

HomeSection

LibraryLevel

LibraryOrganization

LibrarySort

LibraryView

PublicSettings

SettingValidators

ThemeSetting

Variables

API_KEY_SETTINGS

DEFAULT_SETTINGS

HOME_SECTION_DEFAULT_COUNT

HOME_SECTION_HIDE_WHEN_EMPTY_DEFAULT

HOME_SECTION_MAX_COUNT

HOME_SECTION_MIN_COUNT

HOME_SECTIONS

LIBRARY_LEVELS

LIBRARY_SORTS

MAIN_PROCESS_SETTINGS

MAX_LIBRARY_LEVELS

MAX_PAGE_SPACING

READER_BACKGROUND_PRESETS

SETTING_VALIDATORS

SHARED_SETTINGS

THEME_SETTINGS

Functions

isApiKeySetting

isHomeSections

isLibraryStructure

isSettingKey

isSharedSetting

isValidSetting

pickApiKeys

toPublicSettings

stats

Interfaces

ReadingDay

ReadingHistoryEntry

ReadingStats

Variables

READING_HISTORY_LIMIT

title-parsing

Functions

formatPersonName

guessQueryFromTitle

splitPersonName

splitSeriesTitle

users

Interfaces

UserProfile

UsersState

Type Aliases

AvatarType

PickAvatarResult

UserResult

Variables

AVATAR_SIZE

DEFAULT_USER_ID

MAX_AVATAR_BYTES

MAX_AVATAR_SOURCE_BYTES

MAX_NICKNAME_LENGTH

Functions

avatarType

normalizeNickname

On this page

Tankōbon / hooks/use-comic

hooks/use-comic

Single-page reader state.

Interfaces

UseComicOptions

Functions

useComic

Edit this page on GitHub

Pager

Previous pageuseOpeningAchievements

Next pageUseComicOptions