Skip to content

Document RiveRuntime Android init API #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mfazekas wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document RiveRuntime Android init API #524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02ab14c
docs: add RiveRuntime Android initialization API to error handling page
mfazekas Mar 3, 2026
aa86aaf
docs: remove re-init recommendation, mention initialize() only for ma…
mfazekas Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions runtimes/react-native/error-handling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,24 @@ import { RiveView, RiveErrorType } from "@rive-app/react-native";
If no `onError` handler is provided, errors will be logged to the console by
default.
</Note>

### Android Runtime Initialization

On Android, the Rive native library is automatically initialized at app startup. In rare cases (ABI mismatch, missing native libraries, etc.), this initialization can fail. Use `RiveRuntime.getStatus()` to check whether initialization succeeded:

```ts
import { RiveRuntime } from '@rive-app/react-native';

const { isInitialized, error } = RiveRuntime.getStatus();
if (!isInitialized) {
console.error('Rive failed to initialize:', error);
}
```

<Note>
On iOS, the runtime requires no explicit initialization — `getStatus()` will always return `{ isInitialized: true }`.
</Note>

<Warning>
**Advanced:** If you need full control over when initialization happens, you can disable automatic initialization by adding `Rive_RiveRuntimeAndroidSkipSetup=true` to `android/gradle.properties` and calling `RiveRuntime.initialize()` yourself. This is not recommended for most apps — only use this if you have a specific reason to defer initialization.
</Warning>