Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #108

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ Usage

If you've ever used a ```UITableView```, using ```VENTokenField``` should be a breeze.

Similar to ```UITableView```, ```VENTokenField``` provides two protocols: ```<VENTokenFieldDelegate>``` and ```<VENTokenFieldDataSource>```.
Similar to ```UITableView```, ```VENTokenField``` provides three protocols: ```<VENTokenFieldDelegate>```, ```<VENTokenFieldDataSource>``` and ```<VENTokenSuggestionDataSource>```.

### 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:didEnterText:``` is called when a user hits the return key on the input field or after a suggestion is tapped..
* ```tokenField:didSelectSuggestion:forPartialText:atIndex:``` is called when a user taps on a suggested value in the suggestion list.
* ```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.
Expand All @@ -35,7 +36,15 @@ This protocol allows you to provide info about what you want to present in the t
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.
* ```tokenFieldCollapsedText:``` to specify what you want the token field should say in the collapsed state.

### VENTokenSuggestionDataSource
This entirely optional protocol allows you to provide info for any suggestions presented to the user.

Implement...
* ```tokenFieldShouldPresentSuggestions:``` to specify that you want to present suggested values for tokens.
* ```tokenField:numberOfSuggestionsForPartialText:``` to specify the number of suggestions for a given input.
* ```tokenField:suggestionTitleForPartialText:atIndex:``` to specify what the title for a suggestion at a particular index should be.

Sample Project
--------------
Expand All @@ -44,6 +53,6 @@ Check out the [sample project](https://github.com/venmo/VENTokenField/tree/maste
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:
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!