Types
Glossary of Types in Token components & utilities.
FormatAmountOptions
type FormatAmountOptions = {
locale?: string; // User locale (default: browser locale)
minimumFractionDigits?: number; // Minimum fraction digits for number decimals (default: 0)
maximumFractionDigits?: number; // Maximum fraction digits for number decimals (default: 0)
};
FormatAmountResponse
type FormatAmountResponse = string; // See Number.prototype.toLocaleString for more info
Token
type Token = {
address: Address; // The address of the token contract
chainId: number; // The chain id of the token contract
decimals: number; // The number of token decimals
image: string | null; // A string url of the token logo
name: string;
symbol: string; // A ticker symbol or shorthand, up to 11 characters
};
TokenChipReact
type TokenChipReact = {
token: Token; // Rendered token
onClick?: (token: Token) => void;
className?: string;
isPressable?: boolean; // Default: true
};
TokenImageReact
type TokenImageReact = {
className?: string; // Optional additional CSS class to apply to the component
size?: number; // size of the image in px (default: 24)
token: Token;
};
TokenRowReact
type TokenRowReact = {
amount?: string; // Token amount
className?: string;
hideImage?: boolean;
hideSymbol?: boolean;
onClick?: (token: Token) => void; // Component on click handler
token: Token; // Rendered token
};
TokenSearchReact
type TokenSearchReact = {
className?: string;
delayMs?: number; // Debounce delay in milliseconds
onChange: (value: string) => void; // Search callback function
};
TokenSelectButtonReact
type TokenSelectDropdownReact = {
className?: string;
isOpen: boolean; // Determines carot icon direction
onClick: () => void; // Button on click handler
token?: Token; // Selected token
};
TokenSelectDropdownReact
type TokenSelectDropdownReact = {
options: Token[]; // List of tokens
setToken: (token: Token) => void; // Token setter
token?: Token; // Selected token
};
TokenSelectModalReact
type TokenSelectModalReact = {
options: Token[]; // List of tokens
setToken: (token: Token) => void; // Token setter
token?: Token; // Selected token
};