Skip to content

useConnections

Primitive for getting all active connections.

Import

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

Usage

tsx
import { useConnections } from '@wagmi/solid'
import { For } from 'solid-js'

function App() {
  const connections = useConnections()
  
  return (
    <ul>
      <For each={connections()}>
        {(connection) => (
          <li>
            {connection.connector.name}: {connection.accounts[0]}
          </li>
        )}
      </For>
    </ul>
  )
}
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 { useConnections } from '@wagmi/solid'

useConnections.Parameters
useConnections.SolidParameters

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

ts
useConnections(() => ({
  config,
}))

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

Return Type

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

useConnections.ReturnType

Accessor<readonly Connection[]>

Returns an accessor containing all active connections. Each connection includes:

  • accounts: Connected account addresses
  • chainId: Connected chain ID
  • connector: The connector instance

Action

Released under the MIT License.