Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxkupetskii/shsphonecomponentswift
A Swift version of SHSPhoneComponent framework
https://github.com/maxkupetskii/shsphonecomponentswift
formatter ios phone-format phone-formatting phone-number swift swift-3 uitextfield
Last synced: about 1 month ago
JSON representation
A Swift version of SHSPhoneComponent framework
- Host: GitHub
- URL: https://github.com/maxkupetskii/shsphonecomponentswift
- Owner: maxkupetskii
- License: mit
- Created: 2017-09-12T07:32:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-09T07:59:42.000Z (about 5 years ago)
- Last Synced: 2024-12-02T03:40:55.395Z (about 1 month ago)
- Topics: formatter, ios, phone-format, phone-formatting, phone-number, swift, swift-3, uitextfield
- Language: Swift
- Size: 1.06 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SHSPhoneComponentSwift
A Swift version of [SHSPhoneComponent](https://github.com/Serheo/SHSPhoneComponent) framework.
UITextField and Formatter subclasses for formatting phone numbers. Allows to use different formats for different countries (patterns). The caret positioning works excellent.
# Installation
## CocoaPods
To install SHSPhoneComponentSwift using CocoaPods just add the following line to your Podfile
```
pod 'SHSPhoneComponentSwift'
```
## Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [HomeBrew](https://brew.sh/) using the following command:
```
$ brew update
$ brew install carthage
```
To integrate SHSPhoneComponentSwift into your Xcode project using Carthage, specify it in your `Cartfile`:
```
github "alucarders/SHSPhoneComponentSwift"
```
Run `carthage update` to build the framework and drag the built `SHSPhoneComponentSwift.framework` into your Xcode project.
# How To
After adding the framework to your project, you need to import the module
```swift
import SHSPhoneComponentSwift
```
After this you can start using `SHSPhoneTextField` type for displaying phone numbers
## Default format
```swift
phoneField.formatter.setDefaultOutputPattern("+# (###) ###-##-##")
```
All input strings will be parsed in that way. Example: +7 (920) 123-45-67
## Prefix Format
You can set prefix for all inputs:
```swift
phoneField.formatter.setDefaultOutputPattern("(###) ###-##-##")
phoneField.formatter.prefix = "+7 "
```
## Multiple Formats
```swift
phoneField.formatter.prefix = nil
phoneField.formatter.addOutputPattern("+# (###) ###-##-##",
forRegExp: "^7[0-689]\\d*$",
imagePath: "flag_ru")
phoneField.formatter.addOutputPattern("+### ###-##-##",
forRegExp: "^380\\d*$",
imagePath: "flag_ua")
```
## Multiple Formats with prefix
```swift
phoneField.formatter.setDefaultOutputPattern("### ### ###")
phoneField.formatter.prefix = "+7 "
phoneField.formatter.addOutputPattern("(###) ###-##-##",
forRegExp: "^1\\d*$",
imagePath:"flag_ru")
phoneField.formatter.addOutputPattern("(###) ###-###",
forRegExp: "^2\\d*$",
imagePath:"flag_ua")
```
## Specific Formats
If you want to format some numbers in a specific way just do
```swift
phoneField.formatter.addOutputPattern("+# (###) ###-##-##",
forRegExp: "^7[0-689]\\d*$",
imagePath: "flag_ru")
phoneField.formatter.addOutputPattern("+### (##) ###-###",
forRegExp: "^374\\d*$",
imagePath: "flag_am")
```
# Formatting
If you need only formatting function you can use SHSPhoneNumberFormatter class.
# Requirements
iOS 9.3+
# License
SHSPhoneComponentSwift is available under the MIT license. See the LICENSE file for more info.
All credits go to the author of the original framework [SHSPhoneComponent](https://github.com/Serheo/SHSPhoneComponent).