Skip to main content

AchievementProviderProps

Defined in: src/providers/WebAchievementProvider.tsx:108

Extends​

  • AchievementProviderProps

Properties​

achievements?​

optional achievements: AchievementConfigurationType

Defined in: src/providers/AchievementProvider.tsx:76

Inherited from​

HeadlessAchievementProviderProps.achievements

children​

children: ReactNode

Defined in: src/providers/AchievementProvider.tsx:82

Inherited from​

HeadlessAchievementProviderProps.children

client?​

optional client: AchievementClient

Defined in: src/providers/AchievementProvider.tsx:75

Inherited from​

HeadlessAchievementProviderProps.client

engine?​

optional engine: AchievementEngine

Defined in: src/providers/AchievementProvider.tsx:81

Inherited from​

HeadlessAchievementProviderProps.engine

eventMapping?​

optional eventMapping: EventMapping

Defined in: src/providers/AchievementProvider.tsx:80

Inherited from​

HeadlessAchievementProviderProps.eventMapping

icons?​

optional icons: Record<string, string>

Defined in: src/providers/WebAchievementProvider.tsx:109

Overrides​

HeadlessAchievementProviderProps.icons

onError()?​

optional onError: (error) => void

Defined in: src/providers/AchievementProvider.tsx:84

Parameters​

error​

AchievementError

Returns​

void

Inherited from​

HeadlessAchievementProviderProps.onError

restApiConfig?​

optional restApiConfig: RestApiStorageConfig

Defined in: src/providers/AchievementProvider.tsx:79

Deprecated​

Uses the legacy split-state REST storage protocol. Prefer client.

Inherited from​

HeadlessAchievementProviderProps.restApiConfig

storage?​

optional storage: AchievementStorage | AsyncAchievementStorage | StorageType

Defined in: src/providers/AchievementProvider.tsx:77

Inherited from​

HeadlessAchievementProviderProps.storage

ui?​

optional ui: UIConfig

Defined in: src/providers/WebAchievementProvider.tsx:110

useBuiltInUI?​

optional useBuiltInUI: boolean

Defined in: src/providers/WebAchievementProvider.tsx:115

Deprecated​

Built-in UI is the default in v4. This prop is a no-op and will be removed in the next major release.

Overrides​

HeadlessAchievementProviderProps.useBuiltInUI