Add tokenField(_:shouldCompleteText:)

Author: bcylin

Example/CustomizedTokenViewController.swift

@@ -83,13 +83,18 @@ class CustomizedTokenViewController: UIViewController, ICTokenFieldDelegate {
     print(#function)
   }
 
+  func tokenField(_ tokenField: ICTokenField, shouldCompleteText text: String) -> Bool {
+    print("Should add \"\(text)\"?")
+    return text != "42"
+  }
+
   func tokenField(_ tokenField: ICTokenField, didCompleteText text: String) {
-    print("Add: \"\(text)\"")
+    print("Added \"\(text)\"")
     updateTexts()
   }
 
   func tokenField(_ tokenField: ICTokenField, didDeleteText text: String, atIndex index: Int) {
-    print("Delete: \"\(text)\"")
+    print("Deleted \"\(text)\"")
     updateTexts()
   }
 

README.md

@@ -135,6 +135,7 @@ See `Example/CustomizedTokenField.swift` for more details.
 * `tokenFieldDidBeginEditing(_:)`
 * `tokenFieldDidEndEditing(_:)`
 * `tokenFieldWillReturn(_:)`
+* `tokenField(_:shouldCompleteText:)`
 * `tokenField(_:didCompleteText:)`
 * `tokenField(_:didDeleteText:atIndex:)`
 

Source/TokenField/ICTokenField.swift

@@ -34,6 +34,8 @@ import UIKit
   @objc optional func tokenFieldDidEndEditing(_ tokenField: ICTokenField)
   /// Tells the delegate that the token field will process the pressing of the return button.
   @objc optional func tokenFieldWillReturn(_ tokenField: ICTokenField)
+  /// Asks the delegate if the text should become a token in the token field.
+  @objc optional func tokenField(_ tokenField: ICTokenField, shouldCompleteText text: String) -> Bool
   /// Tells the delegate that the text becomes a token in the token field.
   @objc optional func tokenField(_ tokenField: ICTokenField, didCompleteText text: String)
   /// Tells the delegate that the token at certain index is removed from the token field.
@@ -289,21 +291,25 @@ open class ICTokenField: UIView, UITextFieldDelegate, ICBackspaceTextFieldDelega
     let text = (input as NSString).replacingCharacters(in: range, with: string)
 
     for delimiter in delimiters {
-      if text.hasSuffix(delimiter) {
-        let index = text.index(text.endIndex, offsetBy: -delimiter.characters.count)
-        let newToken = text.substring(to: index)
-        textField.text = nil
-
-        if !newToken.isEmpty && newToken != delimiter {
-          tokens.append(ICToken(text: newToken, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes))
-          layoutTokenTextField()
-          delegate?.tokenField?(self, didCompleteText: newToken)
-        }
-        togglePlaceholderIfNeeded()
+      guard text.hasSuffix(delimiter) else {
+        continue
+      }
+
+      let index = text.index(text.endIndex, offsetBy: -delimiter.characters.count)
+      let newToken = text.substring(to: index)
 
-        return false
+      if !newToken.isEmpty && newToken != delimiter && (delegate?.tokenField?(self, shouldCompleteText: newToken) ?? true) {
+        tokens.append(ICToken(text: newToken, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes))
+        layoutTokenTextField()
+        delegate?.tokenField?(self, didCompleteText: newToken)
       }
+
+      textField.text = nil
+      togglePlaceholderIfNeeded()
+
+      return false
     }
+
     return true
   }
 
@@ -436,6 +442,12 @@ open class ICTokenField: UIView, UITextFieldDelegate, ICBackspaceTextFieldDelega
     guard let text = inputTextField.text, !text.isEmpty else {
       return
     }
+
+    let shouldCompleteText = delegate?.tokenField?(self, shouldCompleteText: text) ?? true
+    guard shouldCompleteText else {
+      return
+    }
+
     inputTextField.text = nil
     tokens.append(ICToken(text: text, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes))
     layoutTokenTextField()