useConnectionEffect

Hook for listening to connection lifecycle events.

Import

import { useConnectionEffect } from 'wagmi'

Usage

index.tsx

import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  })
}

config.ts

import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Parameters

import { type UseConnectionEffectParameters } from 'wagmi'

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

index.tsx

import { useConnectionEffect } from 'wagmi'
import { config } from './config'

function App() {
  useConnectionEffect({
    config,
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  })
}

config.ts

import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

onConnect

((data: { address: `0x${string}`; addresses: readonly [`0x${string}`, ...`0x${string}`[]]; chain: Chain | undefined chainId: number; connector: Connector; isReconnected: boolean }) => void) | undefined

Callback that is called when connection is made.

index.tsx

import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onConnect(data) {
      console.log('Connected!', data)
    },
  })
}

config.ts

import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

onDisconnect

(() => void) | undefined

Callback that is called when there no more connections.

index.tsx

import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onDisconnect() {
      console.log('Disconnected!')
    },
  })
}

config.ts

import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Action

• getConnection
• watchConnection