diff --git a/README.md b/README.md index a27bb94..665f1b1 100644 --- a/README.md +++ b/README.md @@ -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: `````` and ``````. +Similar to ```UITableView```, ```VENTokenField``` provides three 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: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. @@ -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 -------------- @@ -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!