Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/cookbook/minikit/add-minikit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,19 @@ export default function RootLayout({ children }: { children: React.ReactNode })

## Initialize MiniKit in your page

Use `useMiniKit()` to call `setFrameReady()` when your app is ready.
Use `useMiniKit()` to call `setMiniAppReady()` when your app is ready.

```jsx app/page.tsx
'use client';
import { useEffect } from 'react';
import { useMiniKit } from '@coinbase/onchainkit/minikit';

export default function HomePage() {
const { setFrameReady, isFrameReady } = useMiniKit();
const { setMiniAppReady, isMiniAppReady } = useMiniKit();

useEffect(() => {
if (!isFrameReady) setFrameReady();
}, [isFrameReady, setFrameReady]);
if (!isMiniAppReady) setMiniAppReady();
}, [isMiniAppReady, setMiniAppReady]);

return <div>Your app content goes here</div>;
}
Expand Down
24 changes: 12 additions & 12 deletions docs/onchainkit/latest/components/minikit/hooks/useMiniKit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Where the Mini App was launched from (e.g., "cast", "launcher", "notification").
</Expandable>
</ResponseField>

<ResponseField name="isFrameReady" type="boolean">
<ResponseField name="isMiniAppReady" type="boolean">
Whether the frame has signaled readiness to the host application.
</ResponseField>

<ResponseField name="setFrameReady" type="() => void">
<ResponseField name="setMiniAppReady" type="() => void">
Function to signal frame readiness to the host application. Call this once your Mini App has finished loading.
</ResponseField>

Expand All @@ -61,13 +61,13 @@ import { useMiniKit } from '@coinbase/onchainkit/minikit';
import { useEffect } from 'react';

export default function MyMiniApp() {
const { context, isFrameReady, setFrameReady } = useMiniKit();
const { context, isMiniAppReady, setMiniAppReady } = useMiniKit();

useEffect(() => {
if (!isFrameReady) {
setFrameReady();
if (!isMiniAppReady) {
setMiniAppReady();
}
}, [setFrameReady, isFrameReady]);
}, [setMiniAppReady, isMiniAppReady]);

return (
<div>
Expand All @@ -86,7 +86,7 @@ import { useMiniKit } from '@coinbase/onchainkit/minikit';

export default function ClientSpecificFeatures() {
const { context } = useMiniKit();

const isBaseApp = context.client.clientFid === '309857';
const isFarcaster = context.client.clientFid === '1';

Expand Down Expand Up @@ -128,14 +128,14 @@ export default function AnalyticsTracker() {
## Usage Notes

### Frame Readiness
Always call `setFrameReady()` once your Mini App has finished initial loading:
Always call `setMiniAppReady()` once your Mini App has finished initial loading:

```tsx components/FrameReady.tsx
```tsx components/MiniAppReady.tsx
useEffect(() => {
if (!isFrameReady) {
setFrameReady();
if (!isMiniAppReady) {
setMiniAppReady();
}
}, [setFrameReady, isFrameReady]);
}, [setMiniAppReady, isMiniAppReady]);
```

### Context Data Security
Expand Down
4 changes: 2 additions & 2 deletions docs/onchainkit/latest/components/minikit/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Add MiniKit to your existing Next.js application.
### Frame Lifecycle
Mini Apps run within Farcaster frames and must signal readiness:
1. **Initialize** MiniKitProvider in your app root
2. **Signal readiness** with `setFrameReady()` in your main component
2. **Signal readiness** with `setMiniAppReady()` in your main component
3. **Handle interactions** through MiniKit hooks

### Context vs Authentication
Expand All @@ -91,4 +91,4 @@ Configure MiniKitProvider and initialize frame context.
<Card title="Hooks Reference" icon="code" href="/onchainkit/latest/components/minikit/hooks/useMiniKit">
Complete reference for all MiniKit React hooks.
</Card>
</CardGroup>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ import { useMiniKit } from '@coinbase/onchainkit/minikit';
import { useEffect } from 'react';

export default function App() {
const { setFrameReady, isFrameReady } = useMiniKit();
const { setMiniAppReady, isMiniAppReady } = useMiniKit();

useEffect(() => {
if (!isFrameReady) {
setFrameReady();
if (!isMiniAppReady) {
setMiniAppReady();
}
}, [setFrameReady, isFrameReady]);
}, [setMiniAppReady, isMiniAppReady]);

return (
<div>
Expand All @@ -89,10 +89,10 @@ export default function App() {
The `useMiniKit` hook provides access to frame state and user context:

```tsx any-component.tsx
const {
setFrameReady,
isFrameReady,
context
const {
setMiniAppReady,
isMiniAppReady,
context
} = useMiniKit();
```

Expand Down