Skip to content

fix: add ellipsis for permit fiat values #26001

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 4 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 12 additions & 5 deletions ui/helpers/utils/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -247,24 +247,30 @@ export function getRandomFileName() {
* @param {number} options.truncatedCharLimit - The maximum length of the string.
* @param {number} options.truncatedStartChars - The number of characters to preserve at the beginning.
* @param {number} options.truncatedEndChars - The number of characters to preserve at the end.
* @param {boolean} options.skipCharacterInEnd - Skip the character at the end.
* @returns {string} The shortened string.
*/
export function shortenString(
stringToShorten = '',
{ truncatedCharLimit, truncatedStartChars, truncatedEndChars } = {
{
truncatedCharLimit,
truncatedStartChars,
truncatedEndChars,
skipCharacterInEnd,
} = {
truncatedCharLimit: TRUNCATED_NAME_CHAR_LIMIT,
truncatedStartChars: TRUNCATED_ADDRESS_START_CHARS,
truncatedEndChars: TRUNCATED_ADDRESS_END_CHARS,
skipCharacterInEnd: false,
},
) {
if (stringToShorten.length < truncatedCharLimit) {
return stringToShorten;
}

return `${stringToShorten.slice(
0,
truncatedStartChars,
)}...${stringToShorten.slice(-truncatedEndChars)}`;
return `${stringToShorten.slice(0, truncatedStartChars)}...${
skipCharacterInEnd ? '' : stringToShorten.slice(-truncatedEndChars)
}`;
}

/**
Expand All @@ -283,6 +289,7 @@ export function shortenAddress(address = '') {
truncatedCharLimit: TRUNCATED_NAME_CHAR_LIMIT,
truncatedStartChars: TRUNCATED_ADDRESS_START_CHARS,
truncatedEndChars: TRUNCATED_ADDRESS_END_CHARS,
skipCharacterInEnd: false,
});
}

Expand Down
11 changes: 11 additions & 0 deletions ui/helpers/utils/util.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1081,5 +1081,16 @@ describe('util', () => {
}),
).toStrictEqual('0x12...7890');
});

it('should shorten the string and remove all characters from the end if skipCharacterInEnd is true', () => {
expect(
util.shortenString('0x1234567890123456789012345678901234567890', {
truncatedCharLimit: 10,
truncatedStartChars: 4,
truncatedEndChars: 4,
skipCharacterInEnd: true,
}),
).toStrictEqual('0x12...');
});
});
});
41 changes: 40 additions & 1 deletion ui/hooks/useFiatFormatter.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,44 @@ describe('useFiatFormatter', () => {
expect(formatFiat(0)).toBe('$0.00');
});

describe('shorten the fiat', () => {
it('when currency symbol on the left for given locale', () => {
mockGetIntlLocale.mockReturnValue('en-US');
mockGetCurrentCurrency.mockReturnValue('USD');

const { result } = renderHook(() => useFiatFormatter());
const formatFiat = result.current;

expect(formatFiat(100000000000000000, { shorten: true })).toBe(
'$100,000,000,...',
);
});

it('when currency symbol on the right for given locale', () => {
mockGetIntlLocale.mockReturnValue('es-ES');
mockGetCurrentCurrency.mockReturnValue('EUR');

const { result } = renderHook(() => useFiatFormatter());
const formatFiat = result.current;

expect(formatFiat(100000000000000000, { shorten: true })).toBe(
'100.000.000....€',
);
});

it('handle unknown currencies by returning amount followed by currency code', () => {
mockGetCurrentCurrency.mockReturnValue('storj');
mockGetIntlLocale.mockReturnValue('en-US');

const { result } = renderHook(() => useFiatFormatter());
const formatFiat = result.current;

expect(formatFiat(100000, { shorten: true })).toBe('100,000 storj');
expect(formatFiat(500.5, { shorten: true })).toBe('500.5 storj');
expect(formatFiat(0, { shorten: true })).toBe('0 storj');
});
});

it('should use the current locale and currency from the mocked functions', () => {
mockGetIntlLocale.mockReturnValue('fr-FR');
mockGetCurrentCurrency.mockReturnValue('EUR');
Expand All @@ -47,12 +85,13 @@ describe('useFiatFormatter', () => {

it('should gracefully handle unknown currencies by returning amount followed by currency code', () => {
mockGetCurrentCurrency.mockReturnValue('storj');
mockGetIntlLocale.mockReturnValue('en-US');

const { result } = renderHook(() => useFiatFormatter());
const formatFiat = result.current;

// Testing the fallback formatting for an unknown currency
expect(formatFiat(1000)).toBe('1000 storj');
expect(formatFiat(100000)).toBe('100,000 storj');
expect(formatFiat(500.5)).toBe('500.5 storj');
expect(formatFiat(0)).toBe('0 storj');
});
Expand Down
73 changes: 68 additions & 5 deletions ui/hooks/useFiatFormatter.ts
Original file line number Diff line number Diff line change
@@ -1,35 +1,98 @@
import { useSelector } from 'react-redux';
import { getIntlLocale } from '../ducks/locale/locale';
import { getCurrentCurrency } from '../selectors';
import { shortenString } from '../helpers/utils/util';

/**
* Returns a function that formats a fiat amount as a localized string.
* The hook takes an optional options object to configure the formatting.
*
* Example usage:
*
* ```
* const formatFiat = useFiatFormatter();
* const formattedAmount = formatFiat(1000);
*
* const shorteningFiatFormatter = useFiatFormatter();
* const shortenedAmount = shorteningFiatFormatter(100000000000000000, { shorten: true });
* ```
*
* @returns A function that takes a fiat amount as a number and returns a formatted string.
*/

type FiatFormatter = (fiatAmount: number) => string;
const TRUNCATED_CHAR_LIMIT_FOR_SHORTENED_FIAT = 15;
const TRUNCATED_START_CHARS_FOR_SHORTENED_FIAT = 12;

type FiatFormatterOptions = {
shorten?: boolean;
};

type FiatFormatter = (
fiatAmount: number,
options?: FiatFormatterOptions,
) => string;

export const useFiatFormatter = (): FiatFormatter => {
const locale = useSelector(getIntlLocale);
const fiatCurrency = useSelector(getCurrentCurrency);

return (fiatAmount: number) => {
return (fiatAmount: number, options: FiatFormatterOptions = {}) => {
const { shorten } = options;

try {
return new Intl.NumberFormat(locale, {
const formatter = new Intl.NumberFormat(locale, {
style: 'currency',
currency: fiatCurrency,
}).format(fiatAmount);
});

if (!shorten) {
return formatter.format(fiatAmount);
}

const parts = formatter.formatToParts(fiatAmount);

let currencySymbol = '';
let numberString = '';

parts.forEach((part) => {
if (part.type === 'currency') {
currencySymbol += part.value;
} else {
numberString += part.value;
}
});

// Shorten the number part while preserving commas
const shortenedNumberString = shortenString(numberString, {
truncatedCharLimit: TRUNCATED_CHAR_LIMIT_FOR_SHORTENED_FIAT,
truncatedStartChars: TRUNCATED_START_CHARS_FOR_SHORTENED_FIAT,
truncatedEndChars: 0,
skipCharacterInEnd: true,
});

// Determine the position of the currency symbol
const currencyBeforeNumber =
parts.findIndex((part) => part.type === 'currency') <
parts.findIndex((part) => part.type === 'integer');

// Reassemble the formatted string
return currencyBeforeNumber
? `${currencySymbol}${shortenedNumberString}`
: `${shortenedNumberString}${currencySymbol}`;
} catch (error) {
// Fallback for unknown or unsupported currencies
return `${fiatAmount} ${fiatCurrency}`;
const formattedNumber = new Intl.NumberFormat(locale).format(fiatAmount);
const shortenedNumberString = shortenString(formattedNumber, {
truncatedCharLimit: TRUNCATED_CHAR_LIMIT_FOR_SHORTENED_FIAT,
truncatedStartChars: TRUNCATED_START_CHARS_FOR_SHORTENED_FIAT,
truncatedEndChars: 0,
skipCharacterInEnd: true,
});

if (shorten) {
return `${shortenedNumberString} ${fiatCurrency}`;
}
return `${formattedNumber} ${fiatCurrency}`;
}
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,9 @@ const PermitSimulation: React.FC<{
<Name value={verifyingContract} type={NameType.ETHEREUM_ADDRESS} />
</Box>
<Box>
{fiatValue && <IndividualFiatDisplay fiatAmount={fiatValue} />}
{fiatValue && (
<IndividualFiatDisplay fiatAmount={fiatValue} shorten />
)}
</Box>
</Box>
</ConfirmInfoRow>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export const AmountPill: React.FC<{
truncatedCharLimit: 11,
truncatedStartChars: 4,
truncatedEndChars: 4,
skipCharacterInEnd: false,
});

const shortenedTokenIdPart = `#${shortenedDecimalTokenId}`;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ export function calculateTotalFiat(fiatAmounts: FiatAmount[]): number {
/**
* Displays the fiat value of a single balance change.
*
* @param props
* @param props.fiatAmount
* @param props - The props object.
* @param props.fiatAmount - The fiat amount to display.
* @param props.shorten - Whether to shorten the fiat amount.
*/
export const IndividualFiatDisplay: React.FC<{ fiatAmount: FiatAmount }> = ({
fiatAmount,
}) => {
export const IndividualFiatDisplay: React.FC<{
fiatAmount: FiatAmount;
shorten?: boolean;
}> = ({ fiatAmount, shorten = false }) => {
const hideFiatForTestnet = useHideFiatForTestnet();
const fiatFormatter = useFiatFormatter();

Expand All @@ -50,7 +52,7 @@ export const IndividualFiatDisplay: React.FC<{ fiatAmount: FiatAmount }> = ({
}
const absFiat = Math.abs(fiatAmount);

return <Text {...textStyle}>{fiatFormatter(absFiat)}</Text>;
return <Text {...textStyle}>{fiatFormatter(absFiat, { shorten })}</Text>;
};

/**
Expand Down
Loading