Currency Input Component For React Native

A simple currency input component for React Native powered mobile apps. Supports both iOS and Android.

The goal of the component is to offer a simple and effective way to handle number inputs with custom format, usually a currency input case, but it can actually be used for other purposes.

How to use it:

1. Install & Import.

# Yarn
$ yarn add react-native-currency-input

# NPM
$ npm i react-native-currency-input --save
import CurrencyInput from 'react-native-currency-input';

2. Add the currency input component to your app.

<CurrencyInput
  value={value}
  onChangeValue={setValue}
  unit="$"
  delimiter=","
  separator="."
  precision={2}
  onChangeText={(formattedValue) => {
    console.log(formattedValue); // $2,310.46
  }}
/>

3. Available component props.

export interface FormatNumberOptions {
  /**
   * Character for thousands delimiter.
   */
  delimiter?: string;

  /**
   * Set this to true to disable negative values.
   */
  ignoreNegative?: boolean;

  /**
   * Decimal precision. Defaults to 2.
   */
  precision?: number;

  /**
   * Decimal separator character.
   */
  separator?: string;

  /**
   * Character to be prefixed on the value.
   */
  unit?: string;
}

export interface CurrencyInputProps extends Omit<TextInputProps, 'value'> {
  /**
   * Character for thousands delimiter.
   */
  delimiter?: string;

  /**
   * Set this to true to disable negative values.
   */
  ignoreNegative?: boolean;

  /**
   * Max value allowed on input.
   * Notice that this might cause unexpected behavior if you pass a value higher than this direct to the input. In that case, consider do your own validation instead of using this property
   */
  maxValue?: number;

  /**
   * Min value allowed on input.
   * Notice that this might cause unexpected behavior if you pass a value lower than this direct to the input. In that case, consider do your own validation instead of using this property
   */
  minValue?: number;

  /**
   * Callback that is called when the input's value changes.
   * @param value The changed number value.
   */
  onChangeValue?(value: number | null): void;

  /**
   * Decimal precision. Defaults to 2.
   */
  precision?: number;

  /**
   * Decimal separator character.
   */
  separator?: string;

  /**
   * Character to be prefixed on the value.
   */
  unit?: string;

  /**
   * The number value of the input.
   * IMPORTANT: this is not the input's text value, the input is controlled by it's number value.
   */
  value: number | null;
}

export interface FakeCurrencyInputProps extends CurrencyInputProps {
  /**
   * Style for the container View that wraps the Text
   */
  containerStyle?: StyleProp<ViewStyle>;

  /**
   * Color of the caret. Defaults to #6495ed
   */
  caretColor?: string;
}

export interface TextWithCursorProps extends TextProps {
  children?: React.ReactNode;

  /**
   * Show or hides the cursor. Defaults to false
   */
  cursorVisible?: boolean;

  /**
   * Props for the cursor. Use this to set a custom `style` prop.
   */
  cursorProps?: TextProps;
}

export interface BlinkProps extends ViewProps {
  /**
   * Blink rate in milliseconds. Defaults to 500.
   */
  blinkRate?: number;
}

Preview:

Currency Input Component For React Native

Download Details:

Author: CaioQuirinoMedeiros

Live Demo: View The Demo

Download Link: Download The Source Code

Official Website: https://github.com/CaioQuirinoMedeiros/react-native-currency-input

License: MIT

You Might Be Interested In:

Add Comment