@inkindcards/react-native-money
v1.0.6
Published
A fully native TextInput component that allows currency input with a right to left text aligment
Downloads
1,807
Maintainers
Readme
What is this?
React Native Money is a simple component library that exposes a fully native TextInput component that uses currency formatting libraries provided with Android and iOS,
so as well as being performant it is also lightweight on your binary sizes. The component has an identitical prop signature and API to the default TextInput provided
with React Native, The only difference is that the value
prop accepts a Number
type and onChangeText
returns a number value and formatted string.
npm install @inkindcards/react-native-money
iOS Installation:
Make sure to add the following to your Podfile
before running npx pod-install
:
pod 'React-RCTText', :path => '../node_modules/react-native/Libraries/Text', :modular_headers => true
Manual Installation
iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-money
and addRNMoneyInput.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNMoneyInput.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)
Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.inkind.RNMoneyInput.RNMoneyInputPackage;
to the imports at the top of the file - Add
new RNMoneyInputPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':inkindcards_react-native-money' project(':inkindcards_react-native-money').projectDir = new File(rootProject.projectDir, '../node_modules/@inkindcards/react-native-money/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:compile project(':react-native-money')
Usage
You use the MoneyInput component like a normal TextInput from the React Native library with the exception that you pass a number to the value
prop.
You can also pass a locale idenitifer which is composed of the language along with the country, this in turn will change the how the currency is formatted, All possible locales can be read about here: Currency Locale Reference.
import {useState} from 'react'
import MoneyInput from '@inkindcards/react-native-money'
const App = () => {
const [bill, setBill] = useState<number>()
return (
<MoneyInput
value={bill}
locale='en_US'
placeholder='$0.00'
onChangeText={(value: number, label: string) => {
setBill(value)
}}
/>
)
}
Testing
Make sure to mock the following to jest.setup.js
:
jest.mock('react-native-money', () => ({
default: jest.fn(),
}))
Inspiration
We'd like to express thanks to the developers of react-native-text-input-mask as this project started as a fork of that repo as their approach in monkeypatching the TextInput delegate was exactly what we needed.
Versioning
This project uses semantic versioning: MAJOR.MINOR.PATCH. This means that releases within the same MAJOR version are always backwards compatible. For more info see semver.org.