Captain is currently in ALPHA. We are happy to get your feedback
Core API
Interfaces
Helpers Types.userprimarysettings

Interface: UserPrimarySettings

helpers/types.UserPrimarySettings

Primary settings necessary for basic application functionality and user accessibility.

Table of contents

Properties

Properties

accessibilityOptions

accessibilityOptions: Object

Accessibility options to accommodate users with disabilities. Default fontSize is 16 (pixels). Valid range: 10 to 24. Default for reducedMotion and highContrast is false.

Type declaration

NameTypeDescription
fontSizenumberFont size in pixels. Default: 16. Valid range: 10 to 24.
highContrastboolean-
reducedMotionboolean-

Defined in

src/electron/helpers/types.ts:37 (opens in a new tab)


language

language: string

User's preferred language. Should be a valid IETF language tag (e.g., "en-US", "fr-FR").

Defined in

src/electron/helpers/types.ts:10 (opens in a new tab)


privacySettings

privacySettings: Object

Privacy settings, including data collection and sharing preferences.

Type declaration

NameTypeDescription
analyticsConsentbooleanIndicates whether the user consents to data collection for analytics.
thirdPartyDataSharingConsentbooleanIndicates whether the user allows sharing data with third parties.

Defined in

src/electron/helpers/types.ts:20 (opens in a new tab)


theme

theme: "light" | "dark" | "system"

User's preferred theme. Supports "light", "dark", or "system" for automatic matching.

Defined in

src/electron/helpers/types.ts:15 (opens in a new tab)