Function.FormattedBalance

function FormattedBalance(props: FormatedBalanceProps): string;

A React component that formats and displays a balance.

Parameters

Parameter	Type	Description
props	FormatedBalanceProps	The properties for the FormattedBalance component.

Returns

string

A React element containing the formatted balance.

Example

// Display a native balance in a React component
import { useKeybanAccount, useKeybanAccountBalance, FormattedBalance } from "@keyban/sdk-react";
const MyComponent: React.FC = () => {
  const [account, accountError] = useKeybanAccount();
  if (accountError) throw accountError;

  const [balance, balanceError] = useKeybanAccountBalance(account);
  if (balanceError) throw balanceError;
  return (
    <div>
      Your balance: <FormattedBalance balance={{ raw: balance, isNative: true }} />
    </div>
  );
};