renatomedina / currencytext Goto Github PK

⭐️ Star me to follow the project ⭐️

CurrencyText is a lightweight library that allows to format text field inputs as currency. It provides a easy to use and extendable UITextFieldDelegate, so there's no need to use a specific UITextField subclass. You can keep your text field subclasses and just make use of this nice custom delegate.

Its main core, the CurrencyFormatter class, can also be used a part from text fields to format any value that can be monetary represented.

If you need to present currency text or allow users to input currency data, CurrencyText help you do it in a highly readable and configurable matter.

• Introduction to CurrencyFormatter
  • Basic Setup
  • Currency and locale - easily defining style
  • Locale - setting currency's locale
  • Currency - how to choose a specific currency from it's name
  • Advanced setup
• The CurrencyTextFieldDelegate
  • Setting your text field to format the inputs
  • Allowing users to input negative values
• All properties of CurrencyFormatter
• Requirements
• Installation
• Contributing
• Copyright

CurrencyText is made upon CurrencyFormatter, which is an abstraction of number formatter with currency number style. It can be used alone or injected into a CurrencyTextFieldDelegate to auto format text field's inputs.

The CurrencyFormatter encapsulates number formatter's currency properties.

Creating a CurrencyFormatter instance is pretty simple; you can use the readable builder pattern approach where the init class require a callback in which the self instance is passed, allowing you to configure your properties by keeping the code clean and readable (Inspired by SwiftRichString):

let formatter = CurrencyFormatter {
  $0.currency = .euro
  // ... set any other attribute
}

let formattedString = formatter.string(from: 30.0) //€30.00

To define the currency style (symbol, formatting, separators) you must make use of currency and locale properties. It's important to say that when these are not defined, the current user locale is automatically set, and so is the curency formatting. For example if the user Locale's is set to pt_BR (indentifier), the amount of 100 would be shown as R$ 100,00. What can be made by setting currency to brazilianReal and locale to portugueseBrazil when needed.

The CurrencyLocale type wraps all available Locale identifiers in an enum type. Formatter's locale property can be set passing a common system Locale or one of CurrencyLocale's cases, such as .italian, .danish or .chinese. Note that you can define locale and compose it with a different currency of your choice, what is going to change generally only the currency symbol.

public enum CurrencyLocale: String, LocaleConvertible {
    
    case current = "current"
    case autoUpdating = "currentAutoUpdating"
    
    case afrikaans = "af"
    case afrikaansNamibia = "af_NA"
    case afrikaansSouthAfrica = "af_ZA"
    //...
}

The Currency type contains the currency codes as enum cases raw values, what makes it easier to set up the formatter with the currency that you want, such as .euro, .dollar, .brazilianReal.

public enum Currency: String {
    case afghani = "AFN",
    algerianDinar = "DZD",
    argentinePeso = "ARS"
    //...
}

Note that defining currency does not always goes as planned, because the most part of the format generally changes accordingly to user locale. For example, setting .euro as currency but with default user locale (Brazil), has the euro's currency symbol with separators and remaining style as used in Brazil.

let formatter = CurrencyFormatter {
  $0.currency = .dollar
  $0.locale = CurrencyLocale.englishUnitedStates
}

let formattedString = formatter.string(from: 30.0) //$30.00

For those cases where your design requires a custom presentation you are able to heavily customize the formatter. We can remove decimals, set a maximum allowed value, customize grouping size or even set a hole new currency symbol. It is all up to you.

let formatter = CurrencyFormatter {
  $0.hasDecimals = false
  $0.maxValue = 999999
  $0.groupingSize = 2
  $0.groupingSeparator = ";"
  $0.currencySymbol = "💶"
}

let formattedString = formatter.string(from: 100000000) //💶99;99;99

This project started as a way to format user inputs as currency. In the old days it used to be a custom UITextField class, but we changed it to work acting only as a custom delegate, without needing to force users to use an specific UITextField class. CurrencyTextFieldDelegate class comes in hand to act formatting inputs respecting the setup of its currency formatter.

To start formatting your user's numeric text as currency you need to initialize a CurrencyTextFieldDelegate, configure it with a formatter with you want to, and then set it as the text field's delegate.

let currencyFormatter = CurrencyFormatter()
textFieldDelegate = CurrencyUITextFieldDelegate(formatter: currencyFormatter)
textFieldDelegate.clearsWhenValueIsZero = true

textField.delegate = textFieldDelegate

Just by setting a currency text field delegate object to your text field, with given formatter behaviour, the user inputs are going to be formatted as expected.

If you want your users to be able to input negative values just set textField's keyboardType to .numbersAndPunctuation, so whenever users tap the negative symbol it will be correctly presented and handled.

textField.keyboardType = .numbersAndPunctuation

// users inputs "-3456"
// -R$ 34.56

The following properties are available:

CurrencyText is compatible with Swift 3.x. Only iOS 8.0+ is supported. But we are planning to support other apple OS's soon.

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 57 thousand libraries and is used in over 3 million apps. CocoaPods can help you scale your projects elegantly.

$ sudo gem install cocoapods

To integrate CurrencyText into your Xcode project using CocoaPods, specify it in your Podfile:

Tested with pod --version: 2.0.2

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
pod 'CurrencyText'
end

Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:

$ pod install

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. Carthage support is comming soon. If you want to help, please contribute :smile.

Contributions and feedbacks are always welcome. Please feel free to fork, follow, open issues and pull requests. The issues, milestones, and what we are currently working on can be seen in the main Project.

To @malcommac for his awesome work with SwiftRichString and SwfitDate, that inspired some readme details, "CurrencyLocale" enum and the init with handler callback. Also to myanalysis for contributing so much by finding issues and giving nice suggestions.

CurrencyText is released under the MIT license. See LICENSE for details.

Felipe Marino: [email protected], @_marinofelipe