Skip to content

Commit 3b1ed73

Browse files
authored
TOOL-2831 - Update docs for showTestnetFaucet (#5868)
1 parent 8f43aa7 commit 3b1ed73

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,15 @@ export type ConnectButton_detailsModalOptions = {
216216
/**
217217
* Show a "Request Testnet funds" link in `ConnectButton` Details Modal when user is connected to a testnet.
218218
*
219-
* By default it is `false`, If you want to show the "Request Testnet funds" link when user is connected to a testnet, set this prop to `true`
219+
* By default it is `false`, If you want to show the "Request Testnet funds" link when user is connected to a testnet, set this prop to `true`.
220+
* Keep in mind that the link will only be shown if there are faucet links registered with the chain.
220221
* @example
221222
* ```tsx
222-
* <ConnectButton showTestnetFaucet={true} />
223+
* <ConnectButton
224+
* detailsModal={{
225+
* showTestnetFaucet: true,
226+
* }}
227+
* />
223228
* ```
224229
*/
225230
showTestnetFaucet?: boolean;

0 commit comments

Comments
 (0)