Component props
Configure the existing mobile integration locally, including language, storage, and error reporting.
appId is required and uses the public App ID from the dashboard. Theme, interface text, button labels, and callbacks are configured in your app. The dashboard does not download remote UI configuration to the SDK.
Common options
| Prop | Purpose |
|---|---|
enabled | Set to false to disable checks and the component's UI. Defaults to true. |
locale | Override the requested release-note and interface language. Otherwise the SDK uses runtimeMetadata.locale, if supplied, then the first device locale. |
theme | Override local colors. The default follows the device's light or dark appearance. |
stringOverrides | Override interface labels such as updateNow, later, and close. |
onError | Receive SDK errors for your app's diagnostics. |
onOpenStore | Replace the default store-opening action. The callback receives the store URL. |
storage | Replace the default AsyncStorage adapter. |
runtimeMetadata | Override native metadata for preview or integration checks. |
apiUrl | API origin, normally https://api.vibeupdate.app. |
timeoutMs | Request timeout, default 3000 milliseconds. |
foregroundIntervalMs | Minimum interval before a foreground recheck, default one hour (six hours before SDK 0.4.0). |
newUserGracePeriodMs | Time after the first launch on a device during which only Required prompts appear, default 24 hours. SDK 0.4.0 and newer. See new users. |
A custom storage adapter must provide asynchronous getItem, setItem, and removeItem methods. Changing or clearing storage can change which notes the SDK considers seen.
Interface language is separate from release notes
Release notes fall back to the app's default locale. Built-in SDK headings and buttons instead resolve the requested locale, then a supported base language, then English. stringOverrides applies after that resolution.
For example, a release can show default-locale German notes while an unsupported interface language falls back to English. Changing the app's default release-note locale does not change the SDK's interface fallback.
Use the SDK README for complete types and integration examples. Review update modes before changing how checks or store actions work.