ARAutocompleteTextView is a subclass of UITextView that automatically displays text suggestions in real-time. This is perfect for automatically suggesting the domain as a user types an email address, #hashtag or @handle.
Add the following files to your project:
ARAutocompleteTextView instance exactly as as you would
UITextView. You can do eith either programmitcally or in Interface Builder. Programmatically, this looks like:
ARAutocompleteTextView* textField = [[ARAutocompleteTextView alloc] initWithFrame:CGRectMake(0,0,100,31)];
let textField = ARAutocompleteTextView(frame: CGRectMake(0, 0, 100, 31))
The data source is the brains of the autocomplete logic. If you just want to autocomplete email addresses, #hashtags or @handles, use
ARAutocompleteManager from the example project as follows:
textField.autocompleteDataSource = [ARAutocompleteManager sharedManager]; textField.autocompleteType = ARAutocompleteTypeEmail;
textField.autocompleteDataSource = ARAutocompleteManager.sharedManager() textField.autocompleteType = ARAutocompleteType.Mail
Autocompletion Data Source
ARAutocompleteManager (included in the example project) provides email address autocompletion out of the box. It comes with a list of the top email domains. You may want to tailor this list of email domains to match your own customers, or you may want to write autocomplete logic for a different type of text view (in the demo, names of colors are autocompleted).
Alternatively, you may wish to create your own data source class and user the
autocompleteType property to differentiate between textviews with different data types. A
ARAutocompleteTextView's data source must implement the following method, as part of the
- (NSString *)textField:(ARAutocompleteTextView*)textField completionForPrefix:(NSString *)prefix
You may also set a default
dataSource for all instances of
ARAutocompleteTextView. In the example project, we use a
[autocompleteTextOffset setDefaultAutocompleteDataSource:[ARAutocompleteManager sharedManager]];
Positioning and Formatting
To adjust the position of the autocomplete label by a fixed amount, set
textField.autocompleteTextOffset = CGPointMake(10.0, 10.0);
For more dynamic positioning of the autocomplete label, subclass
ARAutocompleteTextView and override
To adjust the properties (i.e.
textColor) of the autocomplete label, do so via the `[AutocompleteTextField autocompleteLabel] property.
textField.autocompleteLabel.textColor = [UIColor grayColor];
In addition to observing the standard
UITextView notifications (i.e.
UITextViewTextDidChangeNotification and friends), you can use
[ARAutocompleteTextView autoCompleteTextFieldDelegate] to listen for certain events. This is particularly useful if you are collecting analytics.
- Use this in your apps whenever you can, particularly email addresses -- your users will appreciate it!
- Contributions are very welcome.
- Attribution is appreciated (let's spread the word!), but not mandatory.
Use it? Love/hate it?
Tweet the author @alexruperez, and check out alexruperez's blog: http://alexruperez.com