Skip to content

feat(hooks): async useViewModelInstanceAsync (deprecate sync hook) #305

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

Draft
mfazekas wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat(hooks): async useViewModelInstanceAsync (deprecate sync hook) #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
355f47e
feat(hooks): add async useViewModelInstanceAsync, deprecate sync hook
mfazekas Jul 1, 2026
5fa4699
style: match prettier 3.8.3 string-continuation indent (main lint)
mfazekas Jul 1, 2026
6afdedf
fix(hooks): surface native failures from useViewModelInstanceAsync
mfazekas Jul 7, 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
4 changes: 2 additions & 2 deletions example/src/demos/DataBindingArtboardsExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Fit,
RiveView,
useRiveFile,
useViewModelInstance,
useViewModelInstanceAsync,
type RiveFile,
type BindableArtboard,
} from '@rive-app/react-native';
Expand Down Expand Up @@ -78,7 +78,7 @@
mainFile: RiveFile;
assetsFile: RiveFile;
}) {
const { instance, error } = useViewModelInstance(mainFile);
const { instance, error } = useViewModelInstanceAsync(mainFile);
const [currentArtboard, setCurrentArtboard] = useState<string>('Dragon');
const initializedRef = useRef(false);

Expand All @@ -100,7 +100,7 @@

if (error) {
console.error(error.message);
return <Text style={{ color: 'red' }}>{error.message}</Text>;

Check warning on line 103 in example/src/demos/DataBindingArtboardsExample.tsx

View workflow job for this annotation

GitHub Actions / lint 

Inline style: { color: 'red' }
}

// Map display names to actual artboard names
Expand Down
24 changes: 18 additions & 6 deletions example/src/demos/QuickStart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,29 @@
- Data Binding: https://rive.app/docs/runtimes/data-binding
*/

import { Button, View, StyleSheet } from 'react-native';
import { Button, Text, View, StyleSheet } from 'react-native';
import {
RiveView,
useRive,
useRiveFile,
useRiveNumber,
useRiveTrigger,
useViewModelInstance,
useViewModelInstanceAsync,
Fit,
} from '@rive-app/react-native';
import type { Metadata } from '../shared/metadata';

export default function QuickStart() {
const { riveFile } = useRiveFile(
const { riveFile, error: fileError } = useRiveFile(
require('../../assets/rive/quick_start.riv')
);
const { riveViewRef, setHybridRef } = useRive();
const { instance: viewModelInstance } = useViewModelInstance(riveFile, {
onInit: (vmi) => vmi.numberProperty('health')!.set(9),
});
const { instance: viewModelInstance, error } = useViewModelInstanceAsync(
riveFile,
{
onInit: (vmi) => vmi.numberProperty('health')!.set(9),
}
);

const { setValue: setHealth } = useRiveNumber('health', viewModelInstance);

Expand All @@ -51,6 +54,12 @@ export default function QuickStart() {
riveViewRef!.play();
};

if (fileError || error) {
const message = (fileError ?? error)!.message;
console.error(message);
return <Text style={styles.error}>{message}</Text>;
}

return (
<View style={styles.container}>
{riveFile && viewModelInstance && (
Expand Down Expand Up @@ -86,4 +95,7 @@ const styles = StyleSheet.create({
width: '100%',
height: 400,
},
error: {
color: 'red',
},
});
4 changes: 2 additions & 2 deletions example/src/exercisers/FontFallbackExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
useRive,
useRiveFile,
useRiveString,
useViewModelInstance,
useViewModelInstanceAsync,
type FontSource,
type FallbackFont,
} from '@rive-app/react-native';
Expand Down Expand Up @@ -258,7 +258,7 @@ function MountedView({ text }: { text: string }) {
// https://rive.app/marketplace/26480-49641-simple-test-text-property/
require('../../assets/rive/font_fallback.riv')
);
const { instance } = useViewModelInstance(riveFile);
const { instance } = useViewModelInstanceAsync(riveFile);

const { setValue: setRiveText, error: textError } = useRiveString(
TEXT_PROPERTY,
Expand Down
4 changes: 2 additions & 2 deletions example/src/exercisers/MenuListExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
type RiveFile,
useRiveFile,
useRiveList,
useViewModelInstance,
useViewModelInstanceAsync,
} from '@rive-app/react-native';
import { type Metadata } from '../shared/metadata';

Expand All @@ -41,11 +41,11 @@
}

function MenuList({ file }: { file: RiveFile }) {
const { instance, error } = useViewModelInstance(file);
const { instance, error } = useViewModelInstanceAsync(file);

if (error) {
console.error(error.message);
return <Text style={{ color: 'red' }}>{error.message}</Text>;

Check warning on line 48 in example/src/exercisers/MenuListExample.tsx

View workflow job for this annotation

GitHub Actions / lint 

Inline style: { color: 'red' }
}

if (!instance) {
Expand Down
4 changes: 2 additions & 2 deletions example/src/exercisers/NestedViewModelExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RiveView,
useRiveFile,
useRiveString,
useViewModelInstance,
useViewModelInstanceAsync,
type ViewModelInstance,
type RiveFile,
type RiveViewRef,
Expand Down Expand Up @@ -40,11 +40,11 @@
}

function WithViewModelSetup({ file }: { file: RiveFile }) {
const { instance, error } = useViewModelInstance(file);
const { instance, error } = useViewModelInstanceAsync(file);

if (error) {
console.error(error.message);
return <Text style={{ color: 'red' }}>{error.message}</Text>;

Check warning on line 47 in example/src/exercisers/NestedViewModelExample.tsx

View workflow job for this annotation

GitHub Actions / lint 

Inline style: { color: 'red' }
}

if (!instance) {
Expand Down
4 changes: 2 additions & 2 deletions example/src/exercisers/RiveDataBindingExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Fit,
RiveView,
useRiveNumber,
useViewModelInstance,
useViewModelInstanceAsync,
type ViewModelInstance,
type RiveFile,
useRiveString,
Expand Down Expand Up @@ -37,11 +37,11 @@
}

function WithViewModelSetup({ file }: { file: RiveFile }) {
const { instance, error } = useViewModelInstance(file);
const { instance, error } = useViewModelInstanceAsync(file);

if (error) {
console.error(error.message);
return <Text style={{ color: 'red' }}>{error.message}</Text>;

Check warning on line 44 in example/src/exercisers/RiveDataBindingExample.tsx

View workflow job for this annotation

GitHub Actions / lint 

Inline style: { color: 'red' }
}

if (!instance) {
Expand Down
4 changes: 2 additions & 2 deletions example/src/reproducers/Issue297ThreadRace.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
Fit,
RiveView,
useRiveFile,
useViewModelInstance,
useViewModelInstanceAsync,
type ViewModelInstance,
type RiveFile,
} from '@rive-app/react-native';
Expand Down Expand Up @@ -130,7 +130,7 @@ function StressRunner({
}

function WithViewModelSetup({ file }: { file: RiveFile }) {
const { instance, error } = useViewModelInstance(file);
const { instance, error } = useViewModelInstanceAsync(file);

if (error) {
return <Text style={styles.errorText}>{error.message}</Text>;
Expand Down
Loading
Loading