Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulsumit1993/contactssuggestiontextfield
Contact Picker UITextField
https://github.com/paulsumit1993/contactssuggestiontextfield
autocomplete autocomplete-suggestions carthage interface-builder ios ios-contacts keyboard search storyboard swift4 textfield ui-components uicontrol uikit uitextfield xcode10
Last synced: 2 days ago
JSON representation
Contact Picker UITextField
- Host: GitHub
- URL: https://github.com/paulsumit1993/contactssuggestiontextfield
- Owner: paulsumit1993
- License: mit
- Created: 2018-12-02T12:00:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-30T15:33:41.000Z (almost 5 years ago)
- Last Synced: 2024-09-30T16:50:40.448Z (2 days ago)
- Topics: autocomplete, autocomplete-suggestions, carthage, interface-builder, ios, ios-contacts, keyboard, search, storyboard, swift4, textfield, ui-components, uicontrol, uikit, uitextfield, xcode10
- Language: Swift
- Homepage:
- Size: 20.3 MB
- Stars: 13
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ContactsSuggestionTextField
[](https://paulsumit1993.github.io/ContactsSuggestionTextField/) [](https://developer.apple.com/ios/) [](https://swift.org) [](https://github.com/Carthage/Carthage) [](https://opensource.org/licenses/MIT)
A simple and adaptive UITextField subclass which attaches a contact picker to the textfield's input accessory view for seamless contact access.
#### Keyboard Appearance - Dark / Light
##### Note: This Library uses Contacts.framework and hence one needs to provide `NSContactsUsageDescription` in the app's `Info.plist` specifying an appropriate reason.
## Features
* Integrated Contacts Access and Permission Handling.
* Choose between phone number and e-mail address.
* Adaptable UI.
## Docs
Documentation can be found [here](https://paulsumit1993.github.io/ContactsSuggestionTextField/).
## Usage
To start using the component add it to your project using Carthage or manually as per the [Installation](#installation) section.
The UI component can be used via the `ContactsSuggestionTextField` class. This control can be used very similar to `UITextField` - both from Interface Builder, or from code.
To create an instance of the class, use Interface builder, or do it from code. This example will create a field which shows a short name and email address of a contact:
```swift
let textField = ContactsSuggestionTextField(frame: CGRect(x: 10, y: 10, width: 200, height: 45))
/// customize the textfield.
/// For Interface Builder, an IBOutlet can be created and the customization can be done as illustrated below.
textField.customize = { builder in
builder.contactNameStyle = .short
builder.contactType = .emailAddress
}
self.view.addSubview(textField)
```
Do something when the user selects a contact like the following:
```swift
tf.contactSelectedHandler = { [weak self] contact: String in
// do something with contact
}
```
# Installation
#### CocoaPods
The control is available through [CocoaPods](https://cocoapods.org/). CocoaPods can be installed using [Ruby gems](https://rubygems.org/):
```shell
$ gem install cocoapods
```
Then simply add `ContactsSuggestionTextField` to your Podfile:
```
pod 'ContactsSuggestionTextField', '~> 0.0.3'
```
Lastly, let CocoaPods fetch the latest version of the component by running:
```shell
$ pod update
```
#### Carthage
The component supports [Carthage](https://github.com/Carthage/Carthage). Start by making sure you have the latest version of Carthage installed. Using [Homebrew](http://brew.sh/) run this:
```shell
$ brew update
$ brew install carthage
```
Then add `ContactsSuggestionTextField` to your `Cartfile`:
```
github "paulsumit1993/ContactsSuggestionTextField"
```
Finally, add the framework to the Xcode project of your App. Link the framework to your App and copy it to the App’s Frameworks directory via the “Build Phases” section.
#### Manual
You can download the latest files from our [Releases page](https://github.com/paulsumit1993/ContactsSuggestionTextField/releases). After doing so, copy the files in the `ContactsSuggestionTextField` folder to your project.
## Contributing
We welcome all contributions. Just open an issue or submit pull requests, and we will take it forward.