Skip to main content

Interface: SettingsControllerState

Defined in: src/components/Settings/useSettingsController.tsx:58

The derived UI state/props for the Settings modal.

Properties​

applicationSectionProps​

readonly applicationSectionProps: { autoStartControl: ReactNode; availableThemes: readonly ThemeName[]; currentThemeName: ThemeName; icon: IconType; isLoading: boolean; minimizeToTrayControl: ReactNode; onThemeChange: (event: ChangeEvent<HTMLSelectElement>) => void; }

Defined in: src/components/Settings/useSettingsController.tsx:59

autoStartControl​

readonly autoStartControl: ReactNode

availableThemes​

readonly availableThemes: readonly ThemeName[]

currentThemeName​

readonly currentThemeName: ThemeName

icon​

readonly icon: IconType

isLoading​

readonly isLoading: boolean

minimizeToTrayControl​

readonly minimizeToTrayControl: ReactNode

onThemeChange()​

readonly onThemeChange: (event: ChangeEvent<HTMLSelectElement>) => void

Parameters​
event​

ChangeEvent<HTMLSelectElement>

Returns​

void

clearError()​

readonly clearError: () => void

Defined in: src/components/Settings/useSettingsController.tsx:68

Returns​

void

handleCloseButtonClick()​

readonly handleCloseButtonClick: () => void

Defined in: src/components/Settings/useSettingsController.tsx:69

Returns​

void

headerBackground​

readonly headerBackground: ReactNode

Defined in: src/components/Settings/useSettingsController.tsx:70

headerIcon​

readonly headerIcon: ReactNode

Defined in: src/components/Settings/useSettingsController.tsx:71

isClosing​

readonly isClosing: boolean

Defined in: src/components/Settings/useSettingsController.tsx:72

isDark​

readonly isDark: boolean

Defined in: src/components/Settings/useSettingsController.tsx:73

isLoading​

readonly isLoading: boolean

Defined in: src/components/Settings/useSettingsController.tsx:74

lastError​

readonly lastError: string | null

Defined in: src/components/Settings/useSettingsController.tsx:75

maintenanceSectionProps​

readonly maintenanceSectionProps: { backupSummary: BackupSummary | null; downloadButtonIcon: ReactNode; icon: IconType; isLoading: boolean; onDownloadBackup: () => void; onRefreshHistory: () => void; onResetData: () => void; onRestoreClick: () => void; onRestoreFileChange: (event: ChangeEvent<HTMLInputElement>) => void; refreshButtonIcon: ReactNode; resetButtonIcon: ReactNode; restoreFileInputRef: RefObject<HTMLInputElement | null>; showButtonLoading: boolean; uploadButtonIcon: ReactNode; }

Defined in: src/components/Settings/useSettingsController.tsx:76

backupSummary​

readonly backupSummary: BackupSummary | null

downloadButtonIcon​

readonly downloadButtonIcon: ReactNode

icon​

readonly icon: IconType

isLoading​

readonly isLoading: boolean

onDownloadBackup()​

readonly onDownloadBackup: () => void

Returns​

void

onRefreshHistory()​

readonly onRefreshHistory: () => void

Returns​

void

onResetData()​

readonly onResetData: () => void

Returns​

void

onRestoreClick()​

readonly onRestoreClick: () => void

Returns​

void

onRestoreFileChange()​

readonly onRestoreFileChange: (event: ChangeEvent<HTMLInputElement>) => void

Parameters​
event​

ChangeEvent<HTMLInputElement>

Returns​

void

refreshButtonIcon​

readonly refreshButtonIcon: ReactNode

resetButtonIcon​

readonly resetButtonIcon: ReactNode

restoreFileInputRef​

readonly restoreFileInputRef: RefObject<HTMLInputElement | null>

showButtonLoading​

readonly showButtonLoading: boolean

uploadButtonIcon​

readonly uploadButtonIcon: ReactNode

monitoringSectionProps​

readonly monitoringSectionProps: { currentHistoryLimit: number; icon: IconType; isLoading: boolean; onHistoryLimitChange: (event: ChangeEvent<HTMLSelectElement>) => void; }

Defined in: src/components/Settings/useSettingsController.tsx:94

currentHistoryLimit​

readonly currentHistoryLimit: number

icon​

readonly icon: IconType

isLoading​

readonly isLoading: boolean

onHistoryLimitChange()​

readonly onHistoryLimitChange: (event: ChangeEvent<HTMLSelectElement>) => void

Parameters​
event​

ChangeEvent<HTMLSelectElement>

Returns​

void

notificationSectionProps​

readonly notificationSectionProps: { icon: IconType; inAppAlertsControl: ReactNode; inAppAlertSoundControl: ReactNode; inAppAlertVolumeControl: ReactNode; isLoading: boolean; isVolumeControlDisabled: boolean; systemNotificationsControl: ReactNode; systemNotificationSoundControl: ReactNode; }

Defined in: src/components/Settings/useSettingsController.tsx:102

icon​

readonly icon: IconType

inAppAlertsControl​

readonly inAppAlertsControl: ReactNode

inAppAlertSoundControl​

readonly inAppAlertSoundControl: ReactNode

inAppAlertVolumeControl​

readonly inAppAlertVolumeControl: ReactNode

isLoading​

readonly isLoading: boolean

isVolumeControlDisabled​

readonly isVolumeControlDisabled: boolean

systemNotificationsControl​

readonly systemNotificationsControl: ReactNode

systemNotificationSoundControl​

readonly systemNotificationSoundControl: ReactNode

overlayClassName​

readonly overlayClassName: string

Defined in: src/components/Settings/useSettingsController.tsx:112

shellClassName​

readonly shellClassName: string

Defined in: src/components/Settings/useSettingsController.tsx:113

showSyncSuccessBanner​

readonly showSyncSuccessBanner: boolean

Defined in: src/components/Settings/useSettingsController.tsx:114

subtitle​

readonly subtitle: ReactNode

Defined in: src/components/Settings/useSettingsController.tsx:115