feat: useAccountEffect

README.md

@@ -44,7 +44,7 @@ For documentation and examples, visit [wagmi.sh](https://wagmi.sh).
 
 ## Contributing
 
-Check out the [Contributing docs][contributing] to get started.
+Check out the [Contributing Guide][contributing] to get started.
 
 ## Sponsors
 

packages/react/src/hooks/useAccountState.test.ts → packages/react/src/hooks/useAccountEffect.test.ts

@@ -4,7 +4,7 @@ import { createWrapper, renderHook, waitFor } from '@wagmi/test/react'
 import { expect, test, vi } from 'vitest'
 
 import { WagmiProvider } from '../context.js'
-import { useAccountState } from './useAccountState.js'
+import { useAccountEffect } from './useAccountEffect.js'
 import { useConnect } from './useConnect.js'
 import { useDisconnect } from './useDisconnect.js'
 
@@ -13,7 +13,7 @@ test('behavior: connect and disconnect called once', async () => {
  const onDisconnect = vi.fn()
 
  const { result } = renderHook(() => ({
- useAccountState: useAccountState({ onConnect, onDisconnect }),
+ useAccountEffect: useAccountEffect({ onConnect, onDisconnect }),
  useConnect: useConnect(),
  useDisconnect: useDisconnect(),
  }))
@@ -59,7 +59,7 @@ test('behavior: connect called on reconnect', async () => {
  expect(data.isReconnected).toBeTruthy()
  })
 
- renderHook(() => useAccountState({ onConnect }), {
+ renderHook(() => useAccountEffect({ onConnect }), {
  wrapper: createWrapper(WagmiProvider, { value: config }),
  })
 

packages/react/src/hooks/useAccountState.ts → packages/react/src/hooks/useAccountEffect.ts

@@ -4,7 +4,7 @@ import type { Evaluate } from '@wagmi/core/internal'
 import { useConfig } from './useConfig.js'
 import { useEffect } from 'react'
 
-export type UseAccountStateParameters = {
+export type UseAccountEffectParameters = {
  onConnect?(
  data: Evaluate<
  Pick<
@@ -18,8 +18,8 @@ export type UseAccountStateParameters = {
  onDisconnect?(): void
 }
 
-/** https://wagmi.sh/react/hooks/useAccountState */
-export function useAccountState(parameters: UseAccountStateParameters = {}) {
+/** https://wagmi.sh/react/hooks/useAccountEffect */
+export function useAccountEffect(parameters: UseAccountEffectParameters = {}) {
  const { onConnect, onDisconnect } = parameters
  const config = useConfig()
 

packages/react/src/index.ts

@@ -35,9 +35,9 @@ export { WagmiProviderNotFoundError } from './errors/context.js'
 export { type UseAccountReturnType, useAccount } from './hooks/useAccount.js'
 
 export {
- type UseAccountStateParameters,
- useAccountState,
-} from './hooks/useAccountState.js'
+ type UseAccountEffectParameters,
+ useAccountEffect,
+} from './hooks/useAccountEffect.js'
 
 export {
  type UseBalanceParameters,

playgrounds/vite-react/src/App.tsx

@@ -1,6 +1,6 @@
 import {
  useAccount,
- useAccountState,
+ useAccountEffect,
  useBalance,
  useBlockNumber,
  useChainId,
@@ -16,7 +16,7 @@ import {
 import { optimism } from 'wagmi/chains'
 
 function App() {
- useAccountState({
+ useAccountEffect({
  onConnect(data) {
  console.log('onConnect', data)
  },