README.md

ICInputAccessory

Customized text fields used in the iCook app.

ICKeyboardDismissTextField

• A text field that has a button to dismiss keyboard on the input accessory view.

ICTokenField

• A horizontal scrolling UI that groups input texts.
• Easy to add, select and delete tokens.
• Customizable icon and colors.
• Supports storyboard.

Requirements

ICInputAccessory	iOS	Xcode	Swift
~> 1.0.0	8.0+	7.2
~> 1.1.0	8.0+	7.3
~> 1.2.0	8.0+	8.0
~> 1.3.0	8.0+	8.0
~> 1.4.0	8.0+	8.3
~> 1.5.0	8.0+	9.3

Installation

Use Carthage

Create a Cartfile with the following specification and run carthage update ICInputAccessory. Follow the instructions to add the framework to an iOS project.

github "polydice/ICInputAccessory"

Use CocoaPods

ICInputAccessory supports subspecs. Create a Podfile with the following specification and run pod install.

platform :ios, '8.0'
use_frameworks!

pod 'ICInputAccessory/TokenField'
pod 'ICInputAccessory/KeyboardDismissTextField'

Use Git Submodule

git submodule add -b master [email protected]:polydice/ICInputAccessory.git Dependencies/ICInputAccessory

• Everything you need resides in the Source directory. Add those files to your project.
• Alternatively, drag ICInputAccessory.xcodeproj to your app project as a subproject. Add ICInputAccessory-iOS to the Target Dependencies in the application target's Build Phases settings.

Usage

ICKeyboardDismissTextField

let textField = ICKeyboardDismissTextField(frame: rect)

ICTokenField

let tokenField = ICTokenField(frame: rect)
tokenField.delegate = self as? ICTokenFieldDelegate

• The characters that complete a token:

/// Characters that complete a new token, defaults are whitespace and commas.
public var delimiters: [String]

• Tokens:

/// Texts of each created token.
public var texts: [String] { get }

/// Creates a token with the current input text.
public func completeCurrentInputText()

/// Removes the input text and all displayed tokens.
public func resetTokens()

• UI customization:

/// The image on the left of text field.
public var icon: UIImage? { get set }

/// The placeholder with the default color and font.
public var placeholder: String? { get set }

/// The placeholder with customized attributes.
public var attributedPlaceholder: NSAttributedString? { get set }

/// Customized attributes for tokens in the normal state, e.g. NSFontAttributeName and NSForegroundColorAttributeName.
public var normalTokenAttributes: [String : NSObject]? { get set }

/// Customized attributes for tokens in the highlighted state.
public var highlightedTokenAttributes: [String : NSObject]? { get set }

• Customizable properties in storyboard:

@IBInspectable var icon: UIImage?
@IBInspectable var placeholder: String?
@IBInspectable var textColor: UIColor?
@IBInspectable var cornerRadius: CGFloat

See Example/CustomizedTokenField.swift for more details.

ICTokenFieldDelegate

ICTokenField currently notifies its delegate the following events:

@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:

@objc optional func tokenField(_ tokenField: ICTokenField, subsequentDelimiterForCompletedText text: String) -> String

Documentation

• ICInputAccessory Reference
• Example Project

Development

• Set up dependencies by running the following command in the project root:

  make bootstrap
  

• Open ICInputAccessory.xcworkspace and run the demo app with the Example scheme.

• See more tasks for building and testing:

  rake -T
  

Contributing

Thank you for being interested in contributing to this project. We'd love to hear your ideas!

Please fork this repository, create a branch named like feature/some-new-feature and send us a pull request to make this project better.

Contact

License

Copyright (c) 2016 Polydice, Inc.

ICInputAccessory is released under the MIT license. See LICENSE for details.