scheduleOnUI

scheduleOnUI lets you schedule a function to be executed on the UI Runtime. The callback executes asynchronously and doesn't return a value.

To compare it with runOnUIAsync and runOnUISync, see Running worklet functions on the UI runtime.

Reference

Code

Code

Colours connect each executing thread to its current code line. Recently executed lines fade over the next three ticks.

1function myFunction() {

2 'worklet';

3 console.log('Hello from the UI Runtime!');

4}

5

6scheduleOnUI(myFunction);

7console.log('The RN Runtime continues');

Type definitions

function scheduleOnUI<Args extends unknown[], ReturnValue>(
  fun: (...args: Args) => ReturnValue,
  ...args: Args
): void;

Arguments

fun

A reference to a function you want to schedule on the UI Runtime.

args

Arguments to pass to the function.

Remarks

• The callback passed as the argument is automatically workletized and ready to be run on the UI Runtime.

• On the Web, scheduleOnUI schedules work to run on the next animation frame using requestAnimationFrame.

Call table

Mode	RN Runtime	UI Runtime	Worker Runtime
Bundle Mode	✅	✅	✅
Legacy Eval Mode	✅	❌	❌

What does it mean?

Platform compatibility

Native	Web
✅	✅