Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filipstefansson/AutocompleteField
Subclass of UITextField that shows inline suggestions while typing.
https://github.com/filipstefansson/AutocompleteField
autocomplete input suggestions textfield uitextfield
Last synced: 3 months ago
JSON representation
Subclass of UITextField that shows inline suggestions while typing.
- Host: GitHub
- URL: https://github.com/filipstefansson/AutocompleteField
- Owner: filipstefansson
- License: mit
- Created: 2015-11-08T14:42:20.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-10-13T08:59:57.000Z (about 4 years ago)
- Last Synced: 2024-08-05T17:19:12.733Z (3 months ago)
- Topics: autocomplete, input, suggestions, textfield, uitextfield
- Language: Swift
- Homepage:
- Size: 428 KB
- Stars: 665
- Watchers: 15
- Forks: 41
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ios - AutocompleteField - Add word completion to your UITextFields. (UI / TextField & TextView)
- awesome-ios-star - AutocompleteField - Add word completion to your UITextFields. (UI / TextField & TextView)
README
# AutocompleteField
[](https://img.shields.io/cocoapods/v/AutocompleteField.svg)
[](https://AutocompleteField.github.io/AutocompleteField)
Subclass of `UITextField` that shows inline suggestions while typing.
- Plug and play replacement for `UITextField`.
- [Delimiter support](#delimiter). Perfect when autocompleting email addresses.
- Two suggestion modes (word and sentence, see [API](#api) below).
- Works with custom fonts, borders etc.
- Super lightweight and zero dependencies.
---
# Requirements
- iOS 10.0+
- Swift 4.2+
# Installation
## CocoaPods
Add the following to your `Podfile`:
```ruby
target 'MyApp' do
pod 'AutocompleteField', '~> 2.0'
end
```
## Swift Package Manager
- Select **File > Swift Packages > Add Package Dependency**.
- Enter `https://github.com/filipstefansson/AutocompleteField.git` in the **Choose Package Repository** dialog.
See [Apple docs](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app) for more information.
## Manually
- Copy `/Sources/AutocompleteField.swift` to your project. There are no other dependencies.
# Usage
You use this textfield in the same way as the regular `UITextField`, through Storyboards or programmatically.
## Basic
```swift
import AutocompleteField
...
let textfield = AutocompleteField(frame: CGRect(x: 20, y: 20, width: 200, height: 40))
textfield.placeholder = "Name"
textfield.suggestions = [
"George Washington",
"Thomas Jefferson",
"John Adams",
"Theodore Roosevelt",
"John F. Kennedy",
"George W. Bush",
]
self.view.addSubview(textfield)
```
## Delimiter
The delimiter can be used to only suggest an autocompletion after a specific character is found in the string. In this example we look for the `@` character, and then provide suggestions for email providers.
```swift
import AutocompleteField
...
// email textfield autocompleting email providers
let textfield = AutocompleteField(frame: CGRect(x: 20, y: 20, width: 200, height: 40))
textfield.placeholder = "Email"
textfield.keyboardType = .emailAddress
textfield.suggestions = [
"gmail.com",
"icloud.com",
"outlook.com",
]
// add the delimiter
textfield.delimiter = "@"
self.view.addSubview(textfield)
```
# API
| Property | Type | Description |
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `suggestionColor` | `UIColor` | The color of the suggestion. Defaults to the default placeholder color. |
| `suggestion` | `String` | The current suggestion shown. Read only. |
| `suggestions` | `[String]` | Array of suggestions. |
| `suggestionType` | `SuggestionType` | The type of suggestion that should be used. `.Word` will only hint the the next word in the suggestion and `.Sentence` will show the whole suggestion. Defaults to `.Sentence`. |
| `pixelCorrections` | `CGPoint` | Move the suggestion label up/down left/right. Use this to correct any differences if the suggestion doesn't match the input value for some reason. |
| `horizontalPadding` | `CGFloat` | Add padding to your textfield. Automatically set when using a `borderStyle` that has padding. |
| `delimiter` | `String` | Add a delimiter to only show a suggestion if there's more than one occurance of the delimiter. Perfect for autocompleting email providers. |
# Demo
Check out the [example project](/Example).
# License
`AutocompleteField` is provided under the [MIT License](http://http//opensource.org/licenses/mit-license.php). See LICENSE for details.