Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/venmo/VENTokenField
Easy-to-use token field that is used in the Venmo app.
https://github.com/venmo/VENTokenField
Last synced: 3 months ago
JSON representation
Easy-to-use token field that is used in the Venmo app.
- Host: GitHub
- URL: https://github.com/venmo/VENTokenField
- Owner: venmo
- License: mit
- Created: 2014-06-19T01:34:44.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T00:33:56.000Z (over 1 year ago)
- Last Synced: 2024-04-24T18:58:18.461Z (6 months ago)
- Language: Objective-C
- Homepage:
- Size: 154 KB
- Stars: 794
- Watchers: 61
- Forks: 195
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - VENTokenField - Easy-to-use token field that is used in the Venmo app. (UI / TextField & TextView)
- awesome-mobile-ui - venmo/VENTokenField
- awesome-ios-star - VENTokenField - Easy-to-use token field that is used in the Venmo app. (UI / TextField & TextView)
README
VENTokenField
=============
[](https://travis-ci.org/venmo/VENTokenField)
```VENTokenField``` is the recipients token field that is used in the Venmo compose screen.
Installation
------------
The easiest way to get started is to use [CocoaPods](http://cocoapods.org/). Just add the following line to your Podfile:
```ruby
pod 'VENTokenField', '~> 2.0'
```
Usage
-----
If you've ever used a ```UITableView```, using ```VENTokenField``` should be a breeze.
Similar to ```UITableView```, ```VENTokenField``` provides two protocols: `````` and ``````.
### VENTokenFieldDelegate
This protocol notifies you when things happen in the token field that you might want to know about.
* ```tokenField:didEnterText:``` is called when a user hits the return key on the input field.
* ```tokenField:didDeleteTokenAtIndex:``` is called when a user deletes a token at a particular index.
* ```tokenField:didChangeText:``` is called when a user changes the text in the input field.
* ```tokenFieldDidBeginEditing:``` is called when the input field becomes first responder.
### VENTokenFieldDataSource
This protocol allows you to provide info about what you want to present in the token field.
Implement...
* ```tokenField:titleForTokenAtIndex:``` to specify what the title for the token at a particular index should be.
* ```numberOfTokensInTokenField:``` to specify how many tokens you have.
* ```tokenFieldCollapsedText:``` to specify what you want the token field to say in the collapsed state.
Sample Project
--------------
Check out the [sample project](https://github.com/venmo/VENTokenField/tree/master/VENTokenFieldSample) in this repo for sample usage.
Contributing
------------
We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a [new GitHub issue](https://github.com/venmo/VENTokenField/issues/new) if you find bugs or have questions. :octocat:
Please make sure to follow our general coding style and add test coverage for new features!