Neynar Documentation

Calling ready

Call ready when your interface is ready to be displayed:

In React applications

If you’re using React, call ready inside a useEffect hook to prevent it from running on every re-render:You should call ready as soon as possible while avoiding jitter and content reflows. 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.

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

You must be logged into your Warpcast account on desktop to access the Mini App Debug Tool.