-
Notifications
You must be signed in to change notification settings - Fork 559
[SDK] USD balance for AccountBalance #5533
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
"thirdweb": minor | ||
--- | ||
The Connected-details button now shows USD value next to the token balance. | ||
|
||
### Breaking change to the AccountBalance | ||
The formatFn props now takes in an object of type `AccountBalanceInfo`. The old `formatFn` was inflexible because it only allowed you to format the balance value. | ||
With this new version, you have access to both the balance and symbol. | ||
```tsx | ||
import { AccountBalance, type AccountBalanceInfo } from "thirdweb/react"; | ||
|
||
<AccountBalance | ||
// Show the symbol in lowercase, before the balance | ||
formatFn={(props: AccountBalanceInfo) => `${props.symbol.toLowerCase()} ${props.balance}`} | ||
/> | ||
``` | ||
|
||
AccountBalance now supports showing the token balance in fiat value (only USD supported at the moment) | ||
```tsx | ||
<AccountBalance | ||
showBalanceInFiat="USD" | ||
/> | ||
``` | ||
|
||
The `formatFn` prop now takes in an object of type `AccountBalanceInfo` and outputs a string | ||
```tsx | ||
import { AccountBalance, type AccountBalanceInfo } from "thirdweb/react"; | ||
|
||
<AccountBalance | ||
formatFn={(props: AccountBalanceInfo) => `${props.balance}---${props.symbol.toLowerCase()}`} | ||
/> | ||
|
||
// Result: 11.12---eth | ||
``` | ||
|
||
### ConnectButton also supports displaying balance in fiat since it uses AccountBalance internally | ||
```tsx | ||
<ConnectButton | ||
// Show USD value on the button | ||
detailsButton={{ | ||
showBalanceInFiat: "USD", | ||
}} | ||
|
||
// Show USD value on the modal | ||
detailsModal={{ | ||
showBalanceInFiat: "USD", | ||
}} | ||
/> | ||
``` | ||
|
||
### Export utils functions: | ||
formatNumber: Round up a number to a certain decimal place | ||
```tsx | ||
import { formatNumber } from "thirdweb/utils"; | ||
const value = formatNumber(12.1214141, 1); // 12.1 | ||
``` | ||
|
||
shortenLargeNumber: Shorten the string for large value. Mainly used for the AccountBalance's `formatFn` | ||
```tsx | ||
import { shortenLargeNumber } from "thirdweb/utils"; | ||
const numStr = shortenLargeNumber(1_000_000_000) | ||
``` | ||
|
||
### Fix to ConnectButton | ||
The social image of the Details button now display correctly for non-square image. | ||
|
||
### Massive test coverage improvement for the Connected-button components |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
const SUPPORTED_FIAT_CURRENCIES = ["USD"] as const; | ||
/** | ||
* @internal | ||
*/ | ||
export type SupportedFiatCurrency = (typeof SUPPORTED_FIAT_CURRENCIES)[number]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.