Skip to content

Update connect docs with balance type #1329

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

Merged
merged 1 commit into from
Jun 17, 2025
Merged

Update connect docs with balance type #1329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 2 deletions docs/tools/kit/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,17 @@ If you're using **Next.js**, place the `FlowProvider` inside your `layout.tsx`.

### `Connect`

A drop-in wallet connection component with UI for copy address, logout, and balance (future dynamic).
A drop-in wallet connection component with UI for copy address, logout, and balance display.

**Props:**

- `variant?: ButtonProps["variant"]` – Optional button style variant (default: `"primary"`)
- `onConnect?: () => void` – Callback triggered after successful authentication
- `onDisconnect?: () => void` – Callback triggered after logout
- `balanceType?: "cadence" | "evm" | "combined"` – Specifies which balance to display (default: `"cadence"`). Options:
- `"cadence"`: Shows the FLOW token balance from the Cadence side
- `"evm"`: Shows the FLOW token balance from the Flow EVM side
- `"combined"`: Shows the total combined FLOW token balance from both sides

```tsx
import { Connect } from "@onflow/kit"
Expand Down Expand Up @@ -183,7 +187,7 @@ import { TransactionLink } from "@onflow/kit"
### Live Demo

<FlowProviderDemo>
<TransactionLink
<TransactionLink
txId="0x1234567890abcdef"
variant="primary"
/>
Expand Down