react
Plugin for generating type-safe Wagmi Hooks.
Import
ts
import { react } from '@wagmi/cli/plugins'import { react } from '@wagmi/cli/plugins'Usage
ts
import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'
export default defineConfig({
plugins: [
react(),
],
})import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'
export default defineConfig({
plugins: [
react(),
],
})Configuration
ts
import { type ReactConfig } from '@wagmi/cli/plugins'import { type ReactConfig } from '@wagmi/cli/plugins'getHookName
'legacy' | ((options: { contractName: string; type: 'read' | 'simulate' | 'watch' | 'write' }) => `use${string}`)
- Function for setting custom hook names.
- Defaults to
`use${type}${contractName}`. For example,useReadErc20,useSimulateErc20,useWatchErc20Event,useWriteErc20. - When
'legacy'(deprecated), hook names are set to@wagmi/cli@1format.
ts
import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'
export default defineConfig({
plugins: [
react({
getHookName({ contractName, type }) {
return `use${contractName}__${type}`
},
}),
],
})import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'
export default defineConfig({
plugins: [
react({
getHookName({ contractName, type }) {
return `use${contractName}__${type}`
},
}),
],
})