Installation

npm install --save @types/react-currency-format

Summary

This package contains type definitions for react-currency-format (https://github.com/mohitgupta8888/react-currency-format#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-currency-format.

index.d.ts

1import { Component, ComponentType, HTMLAttributes, InputHTMLAttributes, JSX } from "react";
2
3declare namespace CurrencyFormat {
4    /**
5     * Available input type attributes which the component supports.
6     */
7    type InputType = "text" | "tel";
8
9    /**
10     * A value object containing the formatted value, the original value and the float value.
11     * @see {@link https://github.com/mohitgupta8888/react-currency-format#values-object}
12     */
13    interface Values {
14        formattedValue: string;
15        value: string;
16        floatValue: number;
17    }
18
19    // The component accepts all the props which can be given to a input or span based on displayType selected.
20    type DisplayTypeInput = InputHTMLAttributes<HTMLInputElement> & {
21        displayType?: "input";
22        customInput?: ComponentType<any>;
23    };
24
25    type DisplayTypeText = HTMLAttributes<HTMLSpanElement> & {
26        displayType?: "text";
27        customInput?: never;
28    };
29
30    /**
31     * Props accepted by the component.
32     * @see {@link https://github.com/mohitgupta8888/react-currency-format#props}
33     */
34    type StrictProps =
35        & Partial<{
36            thousandSeparator: string | boolean;
37            thousandSpacing: "2" | "2s" | "3" | "4";
38            decimalSeparator: string;
39            decimalScale: number;
40            fixedDecimalScale: boolean;
41            allowNegative: boolean;
42            prefix: string;
43            suffix: string;
44            value: number | string | null;
45            isNumericString: boolean;
46            type: InputType;
47            format: string | ((unformatedInput: string) => string);
48            removeFormatting: (formattedValue: string) => string;
49            mask: string | string[];
50            onValueChange: (values: Values) => void;
51            isAllowed: (values: Values) => boolean;
52            renderText: (formattedValue: string) => JSX.Element;
53        }>
54        & (DisplayTypeText | DisplayTypeInput);
55
56    /**
57     * Props accepted by the component and any other prop of the customInput.
58     */
59    type Props = StrictProps & {
60        [key: string]: unknown;
61    };
62}
63
64declare class CurrencyFormat extends Component<CurrencyFormat.Props> {}
65
66export = CurrencyFormat;
67

Additional Details

• Last updated: Wed, 06 Dec 2023 06:08:17 GMT
• Dependencies: @types/react

Credits

These definitions were written by Guilherme Samuel.