Add tokenField(_:subsequentDelimiterForCompletedText:) to display customized delimiter strings

Author: bcylin

CHANGELOG.md

@@ -5,6 +5,7 @@
   ```swift
 @objc optional func tokenField(_ tokenField: ICTokenField, didChangeInputText text: String)
 @objc optional func tokenField(_ tokenField: ICTokenField, shouldCompleteText text: String) -> Bool
+@objc optional func tokenField(_ tokenField: ICTokenField, subsequentDelimiterForCompletedText text: String) -> String
 ```
 
 * Changed delegate method:

Example/CustomizedTokenViewController.swift

@@ -37,6 +37,8 @@ class CustomizedTokenViewController: UIViewController, ICTokenFieldDelegate {
   override func loadView() {
     super.loadView()
     view.backgroundColor = UIColor.white
+    textView.isEditable = false
+    textView.isSelectable = false
     textView.text = "[\n\n]"
     textView.font = UIFont.preferredFont(forTextStyle: .subheadline)
     textView.frame = view.bounds.insetBy(dx: 10, dy: 10)
@@ -102,6 +104,10 @@ class CustomizedTokenViewController: UIViewController, ICTokenFieldDelegate {
     updateTexts()
   }
 
+  func tokenField(_ tokenField: ICTokenField, subsequentDelimiterForCompletedText text: String) -> String {
+    return " ,"
+  }
+
   // MARK: - UIResponder Callbacks
 
   @objc fileprivate func dismiss(_ sender: UIBarButtonItem) {

README.md

@@ -132,13 +132,21 @@ See `Example/CustomizedTokenField.swift` for more details.
 
 `ICTokenField` currently notifies its delegate the following events:
 
-* `tokenFieldDidBeginEditing(_:)`
-* `tokenFieldDidEndEditing(_:)`
-* `tokenFieldWillReturn(_:)`
-* `tokenField(_:didChangeInputText:)`
-* `tokenField(_:shouldCompleteText:)`
-* `tokenField(_:didCompleteText:)`
-* `tokenField(_:didDeleteText:atIndex:)`
+```swift
+@objc optional func tokenFieldDidBeginEditing(_ tokenField: ICTokenField)
+@objc optional func tokenFieldDidEndEditing(_ tokenField: ICTokenField)
+@objc optional func tokenFieldWillReturn(_ tokenField: ICTokenField)
+@objc optional func tokenField(_ tokenField: ICTokenField, didChangeInputText text: String)
+@objc optional func tokenField(_ tokenField: ICTokenField, shouldCompleteText text: String) -> Bool
+@objc optional func tokenField(_ tokenField: ICTokenField, didCompleteText text: String)
+@objc optional func tokenField(_ tokenField: ICTokenField, didDeleteText text: String, atIndex index: Int)
+```
+
+The displayed delimiter string can be customized by:
+
+```swift
+@objc optional func tokenField(_ tokenField: ICTokenField, subsequentDelimiterForCompletedText text: String) -> String
+```
 
 ## Development
 

Source/TokenField/ICToken.swift

@@ -63,10 +63,10 @@ class ICToken: UIView {
   // MARK: - Private Properties
 
   private(set) lazy var delimiterLabel: UILabel = {
-    let _delimiter = UILabel()
-    _delimiter.text = " , "
-    _delimiter.textColor = self.normalTextAttributes[NSForegroundColorAttributeName] as? UIColor
-    return _delimiter
+    let _label = UILabel()
+    _label.textColor = self.normalTextAttributes[NSForegroundColorAttributeName] as? UIColor
+    _label.textAlignment = .right
+    return _label
   }()
 
   private(set) lazy var textLabel: UILabel = {
@@ -90,10 +90,11 @@ class ICToken: UIView {
     setUpSubviews()
   }
 
-  convenience init(text: String, normalAttributes: [String: NSObject]? = nil, highlightedAttributes: [String: NSObject]? = nil) {
+  convenience init(text: String, delimiter: String = ",", normalAttributes: [String: NSObject]? = nil, highlightedAttributes: [String: NSObject]? = nil) {
     self.init()
     if let attributes = normalAttributes { normalTextAttributes = attributes }
     if let attributes = highlightedAttributes { highlightedTextAttributes = attributes }
+    delimiterLabel.text = delimiter
     ({
       // Workaround to trigger didSet inside the initializer
       self.text = text
@@ -125,7 +126,7 @@ class ICToken: UIView {
       "text": textLabel,
       "delimiter": delimiterLabel
     ]
-    addConstraints(NSLayoutConstraint.constraints(withVisualFormat: "H:|[text][delimiter]|",
+    addConstraints(NSLayoutConstraint.constraints(withVisualFormat: "H:|[text][delimiter]-5-|",
       options: [.alignAllCenterY],
       metrics: nil,
       views: views

Source/TokenField/ICTokenField.swift

@@ -42,6 +42,8 @@ import UIKit
   @objc optional func tokenField(_ tokenField: ICTokenField, didCompleteText text: String)
   /// Tells the delegate that the token at certain index is removed from the token field.
   @objc optional func tokenField(_ tokenField: ICTokenField, didDeleteText text: String, atIndex index: Int)
+  /// Asks the delegate for the subsequent delimiter string for a completed text in the token field.
+  @objc optional func tokenField(_ tokenField: ICTokenField, subsequentDelimiterForCompletedText text: String) -> String
 }
 
 
@@ -299,12 +301,12 @@ open class ICTokenField: UIView, UITextFieldDelegate, ICBackspaceTextFieldDelega
       }
 
       let index = text.index(text.endIndex, offsetBy: -delimiter.characters.count)
-      let newToken = text.substring(to: index)
+      let newText = text.substring(to: index)
 
-      if !newToken.isEmpty && newToken != delimiter && (delegate?.tokenField?(self, shouldCompleteText: newToken) ?? true) {
-        tokens.append(ICToken(text: newToken, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes))
+      if !newText.isEmpty && newText != delimiter && (delegate?.tokenField?(self, shouldCompleteText: newText) ?? true) {
+        tokens.append(customizedToken(with: newText))
         layoutTokenTextField()
-        delegate?.tokenField?(self, didCompleteText: newToken)
+        delegate?.tokenField?(self, didCompleteText: newText)
       }
 
       textField.text = nil
@@ -373,6 +375,14 @@ open class ICTokenField: UIView, UITextFieldDelegate, ICBackspaceTextFieldDelega
 
   // MARK: - Private Methods
 
+  private func customizedToken(with text: String) -> ICToken {
+    if let string = delegate?.tokenField?(self, subsequentDelimiterForCompletedText: text) {
+      return ICToken(text: text, delimiter: string, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes)
+    } else {
+      return ICToken(text: text, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes)
+    }
+  }
+
   /// Returns true if any highlighted token is found and removed, otherwise false.
   private func removeHighlightedToken() -> Bool {
     for (index, token) in tokens.enumerated() {
@@ -452,7 +462,7 @@ open class ICTokenField: UIView, UITextFieldDelegate, ICBackspaceTextFieldDelega
     }
 
     inputTextField.text = nil
-    tokens.append(ICToken(text: text, normalAttributes: normalTokenAttributes, highlightedAttributes: highlightedTokenAttributes))
+    tokens.append(customizedToken(with: text))
     layoutTokenTextField()
     delegate?.tokenField?(self, didCompleteText: text)
   }