@empathyco/x-components 6.3.2 → 7.0.0

package/types/src/components/currency/base-currency.vue.d.ts

@@ -1,40 +1,4 @@
-/**
- * Renders the value received as a property which always must be a JavaScript number, with the
- * proper format provided as a string property or by injection. The rendered tag is a span in
- * order to render a default inline HTML element.
- *
- * Regarding the format or mask to be defined as string:
- * - Use 'i' to define integer numbers.
- * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
- * format doesn't include decimals, it is filled with zeros until reach the length defined with
- * 'd's.
- * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
- * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
- * than one character.
- * - If you want to hide the decimal part if it's zero, you can add the `?` symbol after the
- * decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of `1.234,00`).
- * - Set whatever you need around the integers and decimals marks.
- * - Default mask: 'i.iii,dd' which returns '1.345,67'.
- *
- * @remarks The number of 'd', which is the maximum decimal length, MUST matches with the length
- * of decimals provided from the adapter. Otherwise, when the component truncate the decimal
- * part, it deletes significant digits.
- *
- * Basic example:
- *
- * ```vue
- * <BaseCurrency
- *   :value="123456.789"
- *   format="i.iiii,dddd €"
- * />
- * ```
- *
- * It will render: `123.456,7890 €`.
- *
- * See docs below for more examples.
- *
- * @public
- */
+import type { PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
      * Numeric value to be formatted.
@@ -49,15 +13,24 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * The format as string.
+     * The ISO 4217 currency value. If not specified we use snippetConfig.currency
+     *
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
+     * Note: 'currency' and 'style' options are managed internally.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
 }>, {
-    currency: import("vue").ComputedRef<string>;
+    currencyText: import("vue").ComputedRef<string>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Numeric value to be formatted.
@@ -72,13 +45,24 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * The format as string.
+     * The ISO 4217 currency value. If not specified we use snippetConfig.currency
+     *
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
+     * Note: 'currency' and 'style' options are managed internally.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}>> & Readonly<{}>, {
+    format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;
 //# sourceMappingURL=base-currency.vue?vue&type=script&lang.d.ts.map

package/types/src/components/currency/base-currency.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-currency.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/currency/base-currency.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;;IAGC;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;;;;;;IAjBH;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;;;;AAnBP,wBAuDE"}
+{"version":3,"file":"base-currency.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/currency/base-currency.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;;IAK/B;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;IAEH;;;;;;OAMG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;;;IA3BhF;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;IAEH;;;;;;OAMG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;;;AA7BpF,wBAkDE"}

package/types/src/components/filters/labels/base-price-filter-label.vue.d.ts

@@ -14,10 +14,19 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         }>;
         required: true;
     };
-    /** Configuration for show the label. */
-    format: {
-        type: StringConstructor;
-    };
+    /**
+     * An ISO 4217 currency value.
+     *
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
+     *
+     * @public
+     */
+    format: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
     /**
      * Message shown when the filter hasn't got the min value defined.
      *
@@ -55,10 +64,19 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         }>;
         required: true;
     };
-    /** Configuration for show the label. */
-    format: {
-        type: StringConstructor;
-    };
+    /**
+     * An ISO 4217 currency value.
+     *
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
+     *
+     * @public
+     */
+    format: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
     /**
      * Message shown when the filter hasn't got the min value defined.
      *

package/types/src/components/filters/labels/base-price-filter-label.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-price-filter-label.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../../src/components/filters/labels/base-price-filter-label.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAInC;;;;;GAKG;;IAIC,iDAAiD;;cAE/B,QAAQ,CAAC;YAAE,KAAK,EAAE,UAAU,CAAA;SAAE,CAAC;;;IAGjD,wCAAwC;;;;IAIxC;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;;;;IA/BH,iDAAiD;;cAE/B,QAAQ,CAAC;YAAE,KAAK,EAAE,UAAU,CAAA;SAAE,CAAC;;;IAGjD,wCAAwC;;;;IAIxC;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;;;;AAlCP,wBA4EE"}
+{"version":3,"file":"base-price-filter-label.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../../src/components/filters/labels/base-price-filter-label.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAInC;;;;;GAKG;;IAIC,iDAAiD;;cAE/B,QAAQ,CAAC;YAAE,KAAK,EAAE,UAAU,CAAA;SAAE,CAAC;;;IAGjD;;;;OAIG;;IAEH;;;;;OAKG;YACe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;IAChF;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;;;;IAxCH,iDAAiD;;cAE/B,QAAQ,CAAC;YAAE,KAAK,EAAE,UAAU,CAAA;SAAE,CAAC;;;IAGjD;;;;OAIG;;IAEH;;;;;OAKG;YACe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;IAChF;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;;OAIG;;;;;;;;AA3CP,wBAuFE"}

package/types/src/components/result/base-result-current-price.vue.d.ts

@@ -18,24 +18,20 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * Format or mask to be defined as string.
-     * - Use 'i' to define integer numbers.
-     * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
-     * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
-     * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
-     * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
-     * than one character.
-     * - Set whatever you need around the integers and decimals marks.
-     * - Default mask: 'i.iii,dd' which returns '1.345,67'.
+     * Optional value coming from https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes.
      *
-     * @remarks The number of 'd', which is the maximum decimal length, MUST match with the length
-     * of decimals provided from the adapter. Otherwise, when the component truncate the decimal
-     * part, delete significant digits.
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
 }>, {
     dynamicClasses: import("vue").ComputedRef<VueCSSClasses>;
@@ -50,26 +46,24 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * Format or mask to be defined as string.
-     * - Use 'i' to define integer numbers.
-     * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
-     * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
-     * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
-     * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
-     * than one character.
-     * - Set whatever you need around the integers and decimals marks.
-     * - Default mask: 'i.iii,dd' which returns '1.345,67'.
+     * Optional value coming from https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes.
      *
-     * @remarks The number of 'd', which is the maximum decimal length, MUST match with the length
-     * of decimals provided from the adapter. Otherwise, when the component truncate the decimal
-     * part, delete significant digits.
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
-}>> & Readonly<{}>, {}, {}, {
+}>> & Readonly<{}>, {
+    format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {
     BaseCurrency: import("vue").DefineComponent<{}, {}, any>;
 }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/types/src/components/result/base-result-current-price.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-result-current-price.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/result/base-result-current-price.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AACnC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAItD;;;;;GAKG;;IAIC;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;;;;;;;;;;;;;OAgBG;;;;;;;IAzBH;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;;;;;;;;;;;;;OAgBG;;;;;;;AA5BP,wBAiDE"}
+{"version":3,"file":"base-result-current-price.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/result/base-result-current-price.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AACnC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAItD;;;;;GAKG;;IAIC;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;OAIG;;IAEH;;;;;OAKG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;;;IAtBhF;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;OAIG;;IAEH;;;;;OAKG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;;;;;AAzBpF,wBA6CE"}

package/types/src/components/result/base-result-previous-price.vue.d.ts

@@ -16,23 +16,20 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * Format or mask to be defined as string.
-     * - Use 'i' to define integer numbers.
-     * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
-     * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
-     * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
-     * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
-     * than one character.
-     * - Set whatever you need around the integers and decimals marks.
+     * Optional value coming from https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes.
      *
-     * @remarks The number of 'd', which is the maximum decimal length, MUST match with the length
-     * of decimals provided from the adapter. Otherwise, when the component truncate the decimal
-     * part, delete significant digits.
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
@@ -45,25 +42,24 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         required: true;
     };
     /**
-     * Format or mask to be defined as string.
-     * - Use 'i' to define integer numbers.
-     * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
-     * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
-     * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
-     * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
-     * than one character.
-     * - Set whatever you need around the integers and decimals marks.
+     * Optional value coming from https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes.
      *
-     * @remarks The number of 'd', which is the maximum decimal length, MUST match with the length
-     * of decimals provided from the adapter. Otherwise, when the component truncate the decimal
-     * part, delete significant digits.
+     * @public
+     */
+    currency: StringConstructor;
+    /**
+     * The currency format possibilities from Intl.NumberFormatOptions.
+     * Allows customization of decimal places, grouping, etc.
      *
      * @public
      */
     format: {
-        type: StringConstructor;
+        type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+        default: () => {};
     };
-}>> & Readonly<{}>, {}, {}, {
+}>> & Readonly<{}>, {
+    format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {
     BaseCurrency: import("vue").DefineComponent<{}, {}, any>;
 }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/types/src/components/result/base-result-previous-price.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-result-previous-price.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/result/base-result-previous-price.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAInC;;;;GAIG;;IAIC;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;;;;;;;;;;;;OAeG;;;;;IAxBH;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;;;;;;;;;;;;OAeG;;;;;;;AA3BP,wBAgCE"}
+{"version":3,"file":"base-result-previous-price.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/components/result/base-result-previous-price.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAInC;;;;GAIG;;IAIC;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;OAIG;;IAEH;;;;;OAKG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;IAtBhF;;;;OAIG;;cAEe,QAAQ,CAAC,MAAM,CAAC;;;IAGlC;;;;OAIG;;IAEH;;;;;OAKG;;cAEe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;;;;;;;;AAzBpF,wBA6BE"}

package/types/src/utils/index.d.ts

@@ -1,7 +1,6 @@
 export * from './array';
 export * from './cancellable-promise';
 export * from './clone';
-export * from './currency-formatter';
 export { debounce as debounceFunction } from './debounce';
 export * from './filters';
 export * from './focus';

package/types/src/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,SAAS,CAAA;AACvB,cAAc,sBAAsB,CAAA;AACpC,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACzD,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,sBAAsB,CAAA;AACpC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACzD,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,SAAS,CAAA;AACvB,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACzD,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,sBAAsB,CAAA;AACpC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACzD,cAAc,SAAS,CAAA"}

package/docs/API-reference/api/x-components.currencyformatter.md

@@ -1,76 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [currencyFormatter](./x-components.currencyformatter.md)
-
-## currencyFormatter() function
-
-Format a value with a given format.
-
-**Signature:**
-
-```typescript
-export declare function currencyFormatter(value: number, format?: string): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Numeric value to be formatted.
-
-
-</td></tr>
-<tr><td>
-
-format
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Format or mask to be defined as string.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-Formatted number.
-
-## Remarks
-
-Format: - Use 'i' to define integer numbers. - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the doesn't include decimals, it is filled with zeros until reach the length defined with 'd's. - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group. - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more than one character. - Set whatever you need around the integers and decimals marks. - Default mask: 'i.iii,dd' which returns '1.345,67'. - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of `1.234,00`<!-- -->). It defines the value of `hideIntegerDecimals`<!-- -->: - If true (exists) and the value is an integer without decimals, the decimal non significant zeroes are hidden. - If false, the default behaviour will fill with zeros the remaining length until getting the one defined with the 'd's.
-

package/js/utils/currency-formatter.js

@@ -1,121 +0,0 @@
-/**
- * Regex to detect the format.
- */
-const FORMAT_REGEX = /(i([^id]+))?i+(([^id?]+)(d+)(\?)?)?/;
-/**
- * Format a value with a given format.
- *
- * @param value - Numeric value to be formatted.
- * @param format - Format or mask to be defined as string.
- *
- * @remarks
- * Format:
- * - Use 'i' to define integer numbers.
- * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
- * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
- * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
- * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
- * than one character.
- * - Set whatever you need around the integers and decimals marks.
- * - Default mask: 'i.iii,dd' which returns '1.345,67'.
- * - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol
- * after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of
- * `1.234,00`). It defines the value of `hideIntegerDecimals`:
- * - If true (exists) and the value is an integer without decimals, the decimal non significant
- * zeroes are hidden.
- * - If false, the default behaviour will fill with zeros the remaining length until getting
- * the one defined with the 'd's.
- *
- * @returns Formatted number.
- *
- * @public
- */
-function currencyFormatter(value, format = 'i.iii,dd') {
-    const { integer, decimal } = numberParts(value);
-    const { decimalSeparator, decimalsNumber, integerSeparator, hideIntegerDecimals } = currencyConfig(format);
-    const formattedInteger = formatInteger(integer, integerSeparator);
-    const formattedDecimal = formatDecimal(decimal, {
-        decimalsNumber,
-        hideIntegerDecimals,
-        decimalSeparator,
-    });
-    return format.replace(FORMAT_REGEX, `${formattedInteger}${formattedDecimal}`);
-}
-/**
- * Returns the formatted integer part. This computed returns:
- * - integer part with the integer separator added.
- *
- * @param integer - Integer value as a string.
- * @param integerSeparator - Separator to apply in the integer side.
- *
- * The regexp adds the integer separator for each thousand group (each 3 numbers).
- *
- * @returns Formatted integer.
- *
- * @internal
- */
-function formatInteger(integer, integerSeparator) {
-    return integer.replace(/\B(?=(\d{3})+(?!\d))/g, integerSeparator);
-}
-/**
- * Returns the formatted decimal. This computed returns:
- * - decimal part filled with zeros until complete remaining slots defined with the decimal
- * length in the format.
- * - decimal part truncated. The decimal numbers length, defined with the number of 'd's in the
- * format prop. This must MATCH with the number of decimals provided from the adapter.
- *
- * @param decimal - Decimal part as a string.
- * @param CurrencyConfig - From which the `decimalsNumber`, `decimalsSeparator` and
- * `hideIntegerDecimals` are obtained.
- * @param CurrencyConfig.decimalsNumber - decimalsNumber currency config.
- * @param CurrencyConfig.decimalSeparator - decimalSeparator currency config.
- * @param CurrencyConfig.hideIntegerDecimals - hideIntegerDecimals currency config.
- *
- * @returns Formatted integer.
- *
- * @internal
- */
-function formatDecimal(decimal, { decimalsNumber, decimalSeparator, hideIntegerDecimals, }) {
-    return hideIntegerDecimals && !+decimal
-        ? ''
-        : `${decimalSeparator}${decimal.padEnd(decimalsNumber, '0').substring(0, decimalsNumber)}`;
-}
-/**
- * Function that divide fhe format passed as value for get integerSeparator, decimalSeparator
- * and decimalsNumber.
- *
- * @param format - Format or mask to apply to the value.
- *
- * @returns Object with properties of the currency config.
- *
- * @internal
- */
-function currencyConfig(format) {
-    const [, , integerSeparator = '', , decimalSeparator = '', decimals = '', hideIntegerDecimals = '',] = FORMAT_REGEX.exec(format) ?? [];
-    return {
-        integerSeparator,
-        decimalSeparator,
-        decimalsNumber: decimals.length,
-        hideIntegerDecimals: !!hideIntegerDecimals,
-    };
-}
-/**
- * Divide the number in two parts by separator '.', one of them is the integer number and other
- * the decimals numbers.
- *
- * @param value - Numeric value to be formatted.
- *
- * @returns Parts of number.
- *
- * @internal
- */
-function numberParts(value) {
-    const [integer, decimal = ''] = `${value}`.split('.');
-    return {
-        integer,
-        decimal,
-    };
-}
-
-export { currencyFormatter };
-//# sourceMappingURL=currency-formatter.js.map

package/js/utils/currency-formatter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"currency-formatter.js","sources":["../../../src/utils/currency-formatter.ts"],"sourcesContent":["/**\n * Regex to detect the format.\n */\nconst FORMAT_REGEX = /(i([^id]+))?i+(([^id?]+)(d+)(\\?)?)?/\n\n/**\n * Configuration for format currency.\n */\ninterface CurrencyConfig {\n  /** The character between a group of three integer 'i's and the following one. */\n  integerSeparator: string\n  /**\n   * The character between a group of three integer 'i's and the following one. It also\n   * supports more than one single character.\n   */\n  decimalSeparator: string\n  /** Length of decimals numbers. It counts the number of 'd's after the integer part. */\n  decimalsNumber: number\n  /** Boolean value to hide or show the decimal part when it has 0. */\n  hideIntegerDecimals: boolean\n}\n\n/**\n * Parts of number: integer and decimal.\n */\ninterface NumberParts {\n  /** Integer part of the number as string. */\n  integer: string\n  /** Decimal part of the number as string. */\n  decimal: string\n}\n\n/**\n * Format a value with a given format.\n *\n * @param value - Numeric value to be formatted.\n * @param format - Format or mask to be defined as string.\n *\n * @remarks\n * Format:\n * - Use 'i' to define integer numbers.\n * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the\n * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.\n * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.\n * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more\n * than one character.\n * - Set whatever you need around the integers and decimals marks.\n * - Default mask: 'i.iii,dd' which returns '1.345,67'.\n * - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol\n * after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of\n * `1.234,00`). It defines the value of `hideIntegerDecimals`:\n * - If true (exists) and the value is an integer without decimals, the decimal non significant\n * zeroes are hidden.\n * - If false, the default behaviour will fill with zeros the remaining length until getting\n * the one defined with the 'd's.\n *\n * @returns Formatted number.\n *\n * @public\n */\nexport function currencyFormatter(value: number, format = 'i.iii,dd'): string {\n  const { integer, decimal } = numberParts(value)\n  const { decimalSeparator, decimalsNumber, integerSeparator, hideIntegerDecimals } =\n    currencyConfig(format)\n\n  const formattedInteger = formatInteger(integer, integerSeparator)\n  const formattedDecimal = formatDecimal(decimal, {\n    decimalsNumber,\n    hideIntegerDecimals,\n    decimalSeparator,\n  })\n  return format.replace(FORMAT_REGEX, `${formattedInteger}${formattedDecimal}`)\n}\n\n/**\n * Returns the formatted integer part. This computed returns:\n * - integer part with the integer separator added.\n *\n * @param integer - Integer value as a string.\n * @param integerSeparator - Separator to apply in the integer side.\n *\n * The regexp adds the integer separator for each thousand group (each 3 numbers).\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatInteger(integer: string, integerSeparator: string): string {\n  return integer.replace(/\\B(?=(\\d{3})+(?!\\d))/g, integerSeparator)\n}\n\n/**\n * Returns the formatted decimal. This computed returns:\n * - decimal part filled with zeros until complete remaining slots defined with the decimal\n * length in the format.\n * - decimal part truncated. The decimal numbers length, defined with the number of 'd's in the\n * format prop. This must MATCH with the number of decimals provided from the adapter.\n *\n * @param decimal - Decimal part as a string.\n * @param CurrencyConfig - From which the `decimalsNumber`, `decimalsSeparator` and\n * `hideIntegerDecimals` are obtained.\n * @param CurrencyConfig.decimalsNumber - decimalsNumber currency config.\n * @param CurrencyConfig.decimalSeparator - decimalSeparator currency config.\n * @param CurrencyConfig.hideIntegerDecimals - hideIntegerDecimals currency config.\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatDecimal(\n  decimal: string,\n  {\n    decimalsNumber,\n    decimalSeparator,\n    hideIntegerDecimals,\n  }: Omit<CurrencyConfig, 'integerSeparator'>,\n): string {\n  return hideIntegerDecimals && !+decimal\n    ? ''\n    : `${decimalSeparator}${decimal.padEnd(decimalsNumber, '0').substring(0, decimalsNumber)}`\n}\n\n/**\n * Function that divide fhe format passed as value for get integerSeparator, decimalSeparator\n * and decimalsNumber.\n *\n * @param format - Format or mask to apply to the value.\n *\n * @returns Object with properties of the currency config.\n *\n * @internal\n */\nfunction currencyConfig(format: string): CurrencyConfig {\n  const [\n    ,\n    ,\n    integerSeparator = '',\n    ,\n    decimalSeparator = '',\n    decimals = '',\n    hideIntegerDecimals = '',\n  ] = FORMAT_REGEX.exec(format) ?? []\n  return {\n    integerSeparator,\n    decimalSeparator,\n    decimalsNumber: decimals.length,\n    hideIntegerDecimals: !!hideIntegerDecimals,\n  }\n}\n\n/**\n * Divide the number in two parts by separator '.', one of them is the integer number and other\n * the decimals numbers.\n *\n * @param value - Numeric value to be formatted.\n *\n * @returns Parts of number.\n *\n * @internal\n */\nfunction numberParts(value: number): NumberParts {\n  const [integer, decimal = ''] = `${value}`.split('.')\n  return {\n    integer,\n    decimal,\n  }\n}\n"],"names":[],"mappings":"AAAA;;AAEG;AACH,MAAM,YAAY,GAAG,qCAAqC;AA6B1D;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;SACa,iBAAiB,CAAC,KAAa,EAAE,MAAM,GAAG,UAAU,EAAA;IAClE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC;AAC/C,IAAA,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,GAC/E,cAAc,CAAC,MAAM,CAAC;IAExB,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE,gBAAgB,CAAC;AACjE,IAAA,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE;QAC9C,cAAc;QACd,mBAAmB;QACnB,gBAAgB;AACjB,KAAA,CAAC;AACF,IAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAA,EAAG,gBAAgB,CAAA,EAAG,gBAAgB,CAAA,CAAE,CAAC;AAC/E;AAEA;;;;;;;;;;;;AAYG;AACH,SAAS,aAAa,CAAC,OAAe,EAAE,gBAAwB,EAAA;IAC9D,OAAO,OAAO,CAAC,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;AACnE;AAEA;;;;;;;;;;;;;;;;;AAiBG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,EACE,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACsB,EAAA;AAE3C,IAAA,OAAO,mBAAmB,IAAI,CAAC,CAAC;AAC9B,UAAE;UACA,GAAG,gBAAgB,CAAA,EAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE;AAC9F;AAEA;;;;;;;;;AASG;AACH,SAAS,cAAc,CAAC,MAAc,EAAA;AACpC,IAAA,MAAM,KAGJ,gBAAgB,GAAG,EAAE,IAErB,gBAAgB,GAAG,EAAE,EACrB,QAAQ,GAAG,EAAE,EACb,mBAAmB,GAAG,EAAE,EACzB,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;IACnC,OAAO;QACL,gBAAgB;QAChB,gBAAgB;QAChB,cAAc,EAAE,QAAQ,CAAC,MAAM;QAC/B,mBAAmB,EAAE,CAAC,CAAC,mBAAmB;KAC3C;AACH;AAEA;;;;;;;;;AASG;AACH,SAAS,WAAW,CAAC,KAAa,EAAA;AAChC,IAAA,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,CAAA,EAAG,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;IACrD,OAAO;QACL,OAAO;QACP,OAAO;KACR;AACH;;;;"}

package/types/src/utils/currency-formatter.d.ts

@@ -1,30 +0,0 @@
-/**
- * Format a value with a given format.
- *
- * @param value - Numeric value to be formatted.
- * @param format - Format or mask to be defined as string.
- *
- * @remarks
- * Format:
- * - Use 'i' to define integer numbers.
- * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the
- * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.
- * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.
- * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more
- * than one character.
- * - Set whatever you need around the integers and decimals marks.
- * - Default mask: 'i.iii,dd' which returns '1.345,67'.
- * - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol
- * after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of
- * `1.234,00`). It defines the value of `hideIntegerDecimals`:
- * - If true (exists) and the value is an integer without decimals, the decimal non significant
- * zeroes are hidden.
- * - If false, the default behaviour will fill with zeros the remaining length until getting
- * the one defined with the 'd's.
- *
- * @returns Formatted number.
- *
- * @public
- */
-export declare function currencyFormatter(value: number, format?: string): string;
-//# sourceMappingURL=currency-formatter.d.ts.map

package/types/src/utils/currency-formatter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"currency-formatter.d.ts","sourceRoot":"","sources":["../../../../src/utils/currency-formatter.ts"],"names":[],"mappings":"AAgCA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,SAAa,GAAG,MAAM,CAY5E"}