feat(Amount): Negative Amount support #2320
There are no files selected for viewing
This file contains 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 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 |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| import type { ReactElement } from 'react'; | ||
| import React from 'react'; | ||
| import type { CurrencyCodeType } from '@razorpay/i18nify-js/currency'; | ||
| import { formatNumberByParts } from '@razorpay/i18nify-js/currency'; | ||
| import type { AmountTypeProps } from './amountTokens'; | ||
| import { normalAmountSizes, subtleFontSizes, amountLineHeights } from './amountTokens'; | ||
| import type { BaseTextProps } from '~components/Typography/BaseText/types'; | ||
|
|
@@ -19,6 +19,43 @@ import { Text } from '~components/Typography'; | |
| import { opacity } from '~tokens/global'; | ||
| import type { FontFamily } from '~tokens/global'; | ||
|
|
||
| /** | ||
| * Pollyfill function to get around the node 18 error | ||
| * | ||
| * This function is maintained by i18nify team. Reach out to them for any change regarding this. | ||
| */ | ||
| const stripTrailingZerosFromParts = ( | ||
| parts: ReturnType<typeof formatNumberByParts>, | ||
| ): ReturnType<typeof formatNumberByParts> => { | ||
| const decimalPart = parts.rawParts | ||
| .filter(({ type }) => type === 'fraction') | ||
| .map(({ value }) => value) | ||
| .join(''); | ||
|
|
||
| const hasFraction = parts.rawParts.some(({ type }) => type === 'fraction'); | ||
|
|
||
| if (hasFraction && /^0+$/.test(decimalPart)) { | ||
| delete parts.decimal; | ||
| delete parts.fraction; | ||
| parts.rawParts = parts.rawParts.filter(({ type }) => type !== 'decimal' && type !== 'fraction'); | ||
| } | ||
|
|
||
| return parts; | ||
| }; | ||
|
|
||
| /** | ||
| * Wrapper that uses pollyfill of i18nify team | ||
| */ | ||
| const pollyfilledFormatNumberByParts: typeof formatNumberByParts = (value, options) => { | ||
|
There was a problem hiding this comment. Also since this is a polyfill are we conditionally calling it or are we always calling it regardless. eg: checking for formatToParts existence There was a problem hiding this comment. I've put conditions inside this function itself. So we can always call this instead of |
||
| const parts = formatNumberByParts(value, options); | ||
|
|
||
| if (options?.intlOptions?.trailingZeroDisplay === 'stripIfInteger') { | ||
| return stripTrailingZerosFromParts(parts); | ||
| } | ||
|
|
||
| return parts; | ||
| }; | ||
|
|
||
| type AmountCommonProps = { | ||
| /** | ||
| * The value to be rendered within the component. | ||
|
|
@@ -82,7 +119,7 @@ const getTextColorProps = ({ color }: { color: AmountProps['color'] }): ColorPro | |
| return props; | ||
| }; | ||
|
|
||
| type AmountType = Partial<ReturnType<typeof formatNumberByParts>>; | ||
|
|
||
| interface AmountValue extends Omit<AmountProps, 'value'> { | ||
| amountValueColor: BaseTextProps['color']; | ||
|
|
@@ -141,35 +178,38 @@ const AmountValue = ({ | |
| color={amountValueColor} | ||
| lineHeight={amountLineHeights[type][size]} | ||
| > | ||
| {amount.integer} | ||
| {amount.decimal} | ||
| {amount.fraction} | ||
| {amount.compact} | ||
| </BaseText> | ||
| ); | ||
| }; | ||
|
|
||
| type FormatAmountWithSuffixType = { | ||
| suffix: AmountProps['suffix']; | ||
| value: number; | ||
| currency: AmountProps['currency']; | ||
| }; | ||
|
|
||
| /** | ||
| * Returns a parsed object based on the suffix passed in parameters | ||
| * === Logic === | ||
| * value = 12500.45 | ||
| * if suffix === 'decimals' => { | ||
| "integer": "12,500", | ||
| "decimal": ".", | ||
| "fraction": "45", | ||
| "compact": "K", | ||
| "isPrefixSymbol": false, | ||
| "rawParts": [{"type": "integer","value": "12"},{"type": "group","value": ","},{"type": "integer","value": "500"},{"type": "decimal","value": "."},{"type": "fraction","value": "45"}] | ||
| } | ||
| * @returns {AmountType} | ||
| */ | ||
| export const getAmountByParts = ({ | ||
| suffix, | ||
| value, | ||
| currency, | ||
| }: FormatAmountWithSuffixType): AmountType => { | ||
| try { | ||
| switch (suffix) { | ||
|
|
@@ -179,40 +219,37 @@ export const formatAmountWithSuffix = ({ | |
| maximumFractionDigits: 2, | ||
| minimumFractionDigits: 2, | ||
| }, | ||
| currency, | ||
| } as const; | ||
| return pollyfilledFormatNumberByParts(value, options); | ||
| } | ||
| case 'humanize': { | ||
| const options = { | ||
| intlOptions: { | ||
| notation: 'compact', | ||
| maximumFractionDigits: 2, | ||
| trailingZeroDisplay: 'stripIfInteger', | ||
| }, | ||
| currency, | ||
| } as const; | ||
| return pollyfilledFormatNumberByParts(value, options); | ||
| } | ||
|
|
||
| default: { | ||
| const options = { | ||
| intlOptions: { | ||
| maximumFractionDigits: 0, | ||
| roundingMode: 'floor', | ||
| }, | ||
| currency, | ||
| } as const; | ||
| return pollyfilledFormatNumberByParts(value, options); | ||
| } | ||
| } | ||
| } catch (err: unknown) { | ||
| return { | ||
| integer: `${value}`, | ||
| currency, | ||
| }; | ||
| } | ||
| }; | ||
|
|
@@ -275,20 +312,11 @@ const _Amount = ({ | |
| color, | ||
| }); | ||
|
|
||
| const renderedValue = getAmountByParts({ suffix, value, currency }); | ||
| const isPrefixSymbol = renderedValue.isPrefixSymbol ?? true; | ||
| const currencySymbol = renderedValue.currency ?? currency; | ||
|
|
||
| const currencyPosition = isPrefixSymbol ? 'left' : 'right'; | ||
| const currencySymbolOrCode = currencyIndicator === 'currency-symbol' ? currencySymbol : currency; | ||
|
|
||
| const currencyFontSize = isAffixSubtle | ||
|
|
@@ -309,6 +337,18 @@ const _Amount = ({ | |
| flexDirection="row" | ||
| position="relative" | ||
| > | ||
| {renderedValue.minusSign ? ( | ||
| <BaseText | ||
| fontSize={normalAmountSizes[type][size]} | ||
| fontWeight={weight} | ||
| lineHeight={amountLineHeights[type][size]} | ||
| color={amountValueColor} | ||
| as={isReactNative ? undefined : 'span'} | ||
| marginX="spacing.2" | ||
| > | ||
| {renderedValue.minusSign} | ||
| </BaseText> | ||
| ) : null} | ||
| {currencyPosition === 'left' && ( | ||
| <BaseText | ||
| marginRight="spacing.1" | ||
|
|
||
This file contains 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this come from i18nify library itself then instead of being in blade repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did suggest them this but they are saying they'll just document it on their end in documentation and consumers will have to add it. Can discuss it later separately as well. Wanted to get it resolved earlier for negative amount thing. But yup overall I too feel this should be in their repo