Text formatting framework written on Swift 5.0.
Features
Features | |
---|---|
Convert string into formatted string and vice versa | |
Formatting text during typing | |
Set format using '#' characters like '### ##-###' | |
Supporting emojis | |
Formatting money amount | |
Formatting with placeholders | |
UITextField and UITextView support |
Example
To run the example project, clone the repo and run pod install
from the Example directory first.
Demo
Requirements
- iOS 8.0+
- Swift 4.0+
- Xcode 9.0+
SwiftUI
AnyFormatKit has SwiftUI version, that exists as separate framework AnyFormatKitSwiftUI
Migration Guides
- AnyFormatKit 0.2.0 MigrationGuide
- AnyFormatKit 1.0.0 MigrationGuide
- AnyFormatKit 2.4.0 MigrationGuide
Installation
CocoaPods
AnyFormatKit is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'AnyFormatKit', '~> 2.5.2'
Then, run the following command:
$ pod install
Swift Package Manager
AnyFormatKit is available with Swift Package Manager.
Once you have your Swift package set up, than simply add AnyFormatKit to the dependencies
value of your Package.swift
dependencies: [
.package(url: "https://github.com/luximetr/AnyFormatKit.git", .upToNextMajor(from: "2.5.2"))
]
Usage
Import
import AnyFormatKit
Formatting with TextFormatter
let phoneFormatter = DefaultTextInputFormatter(textPattern: "### (###) ###-##-##")
let phoneInputController = TextFieldInputController()
textField.delegate = phoneInputController
phoneInputController.formatter = phoneFormatter
Get only your input
phoneNumberFormatter.unformat("+51 (013) 442-55-11") // +51013442551
textField.delegate
by yourself
In case you want to use let phoneFormatter = DefaultTextInputFormatter(textPattern: "### (###) ###-##-##")
// inside of UITextFieldDelegate shouldChangeTextIn method
let result = formatter.formatInput(currentText: textField.text ?? "", range: range, replacementString: string)
textField.text = result.formattedText
textField.setCursorLocation(result.caretBeginOffset)
You can find example of
setCursorLocation
here
Formatter kinds
DefaultTextInputFormatter
- formatting symbol by symbolSumTextInputFormatter
- formatting like a money formatPlaceholderTextInputFormatter
- formatting with all textPattern as placeholder
Author
luximetr, [email protected]
Say thank you
License
AnyFormatKit is available under the MIT license. See the LICENSE file for more info.