Skip to content

useConnectionEffect

Primitive for reacting to connection state changes.

Import

ts
import { useConnectionEffect } from '@wagmi/solid'

Usage

tsx
import { useConnectionEffect } from '@wagmi/solid'

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

  return <div>...</div>
}
ts
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

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

Parameters

ts
import { useConnectionEffect } from '@wagmi/solid'

useConnectionEffect.Parameters
useConnectionEffect.SolidParameters

Parameters are passed as a getter function to maintain Solid reactivity.

ts
useConnectionEffect(() => ({
  onConnect(data) { /* ... */ },
  onDisconnect() { /* ... */ },
}))

onConnect

((data: { address: Address; addresses: readonly Address[]; chain: Chain | undefined; chainId: number; connector: Connector; isReconnected: boolean }) => void) | undefined

Callback that is called when accounts are connected.

onDisconnect

(() => void) | undefined

Callback that is called when no more accounts are connected.

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

Return Type

ts
import { useConnectionEffect } from '@wagmi/solid'

useConnectionEffect.ReturnType

void

Action

Released under the MIT License.