Skip to content

TOOL-2831 - Update docs for showTestnetFaucet #5868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 3, 2025
Merged

TOOL-2831 - Update docs for showTestnetFaucet #5868

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,15 @@ export type ConnectButton_detailsModalOptions = {
/**
* Show a "Request Testnet funds" link in `ConnectButton` Details Modal when user is connected to a testnet.
*
* 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`
* 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`.
* Keep in mind that the link will only be shown if there are faucet links registered with the chain.
* @example
* ```tsx
* <ConnectButton showTestnetFaucet={true} />
* <ConnectButton
* detailsModal={{
* showTestnetFaucet: true,
* }}
* />
* ```
*/
showTestnetFaucet?: boolean;
Expand Down
Loading