Skip to main content

UIConfig

Defined in: src/core/ui/interfaces.ts:123

UI Configuration for AchievementProvider Allows customization of all UI components

Properties

confetti?

optional confetti: ConfettiOptions

Defined in: src/core/ui/interfaces.ts:177

Built-in confetti configuration. Ignored when enableConfetti is false. Custom confetti components receive these values as props.


ConfettiComponent?

optional ConfettiComponent: ConfettiComponent

Defined in: src/core/ui/interfaces.ts:140

Custom confetti component If not provided, uses the built-in confetti component.


enableConfetti?

optional enableConfetti: boolean

Defined in: src/core/ui/interfaces.ts:171

Enable/disable confetti animations

Default

true

enableNotifications?

optional enableNotifications: boolean

Defined in: src/core/ui/interfaces.ts:165

Enable/disable notifications

Default

true

ModalComponent?

optional ModalComponent: ModalComponent

Defined in: src/core/ui/interfaces.ts:134

Custom modal component used by AchievementsWidget and AchievementsModal. If not provided, uses the built-in AchievementsModal implementation.


NotificationComponent?

optional NotificationComponent: NotificationComponent

Defined in: src/core/ui/interfaces.ts:128

Custom notification component If not provided, uses the built-in notification component.


notificationDuration?

optional notificationDuration: number

Defined in: src/core/ui/interfaces.ts:159

Duration in milliseconds before built-in unlock notifications dismiss. Custom notification components receive this value through duration.

Default

5000

notificationPosition?

optional notificationPosition: NotificationPosition

Defined in: src/core/ui/interfaces.ts:152

Notification positioning

Default

'top-center'

theme?

optional theme: string

Defined in: src/core/ui/interfaces.ts:146

Built-in theme name. Built-in themes: 'modern' (default), 'minimal', 'gamified'