Loading your app

When users open Mini Apps in Farcaster they are shown a branded splash screen instead of a blank loading page like they would in a browser. Once your interface is ready to show the splash screen can be hidden.

Calling ready

Call ready when your interface is ready to be displayed:

import { sdk } from '@farcaster/frame-sdk'
 
await sdk.actions.ready();

Minimize loading time for your app by following web performance best practices:

• Learn about web performance
• Test your app's speed and diagnose performance issues

To avoid jitter and content reflowing:

• Don't call ready until your interface has loaded
• Use placeholders and skeleton states if additional loading is required

Disabling native gestures

Mini Apps are rendered in modal elements where certain swipe gestures or clicks outside the app surface will result in the app closing. If your app has conflicting gestures you can set the disableNativeGestures flag to disable native gestures.

await sdk.actions.ready({ disableNativeGestures: true });

Splash Screen

When a user launches your app they will see a Splash Screen while your app loads.

You'll learn how to configure the Splash Screen in the sharing your app and publishing your app guides.

Previewing your app

This app doesn't do anything interesting yet but we've now done the bare minimum to preview it inside a Farcaster client.

Let's preview it in Warpcast:

1. Open the Mini App Debug Tool on desktop
2. Enter your app url
3. Hit Preview