Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giginet/customkeyboardtextfield
Provides easy way to make type safety TextField with custom keyboards
https://github.com/giginet/customkeyboardtextfield
Last synced: 3 months ago
JSON representation
Provides easy way to make type safety TextField with custom keyboards
- Host: GitHub
- URL: https://github.com/giginet/customkeyboardtextfield
- Owner: giginet
- License: mit
- Created: 2016-08-05T18:12:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-10T22:05:12.000Z (about 8 years ago)
- Last Synced: 2024-09-15T19:31:41.180Z (4 months ago)
- Language: Swift
- Homepage:
- Size: 1.82 MB
- Stars: 20
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CustomKeyboardTextField
[](https://travis-ci.org/giginet/CustomKeyboardTextField)
[](https://codecov.io/gh/giginet/CustomKeyboardTextField)
[](https://swift.org)
[](http://cocoadocs.org/docsets/CustomKeyboardTextField)
[](https://img.shields.io/cocoapods/v/CustomKeyboardTextField.svg)
[](https://github.com/Carthage/Carthage)
[](https://github.com/giginet/CustomKeyboardTextField/blob/master/LICENSE.md)
CustomKeyboardTextField provides easy way to make TextField with custom keyboards.
This library is under development so interfaces might change.
# Demo
[Demo application](https://appetize.io/app/jv8ddk9ff2uwnf7hr508kbrkwg?device=iphone5s&scale=100&orientation=portrait&osVersion=9.3) is available on Appetize.io.
# Usage
## Simple Picker
```swift
import CustomKeyboardTextField
struct SimplePickerKeyboardDataSource: UIPickerViewKeyboardDataSource {
let elements = ["Bulbasaur", "Charmander", "Squirtle"]
}
typealias SimplePickerTextField = PickerKeyboardTextField
let pickerTextField = SimplePickerTextField()
addSubView(pickerTextField)
```
If you'd like to change input text, override `inputText(for row: Int)`.
You can also implement rich picker views. See [sample implementation](https://github.com/giginet/CustomKeyboardTextField/blob/master/CustomKeyboardTextFieldDemo/CustomKeyboard.swift#L10) for detail.
## Date Picker
```swift
import CustomKeyboardTextField
struct DatePickerKeyboardDataSource: UIDatePickerKeyboardDataSource {
let datePickerMode: UIDatePickerMode = .Date
let timeFormat: String = "yyyy/MM/dd"
}
typealias DatePickerTextField = UIDatePickerKeyboardTextField
```
You can configure some parameters in `UIDatePickerKeyboardDataSource`.
## Custom Keyboard
You can implement own custom keyboard easily.
### 1. Implement the custom keyboard view
```swift
// Your custom view
class MyCustomKeyboardView: UIView, CustomKeyboardView {
weak var textField: UITextField?
// current input text
var inputText: String = "input text"
// do something when keyboards are restored to default (optional)
func reset() {
}
}
```
You can put some controls on your keyboard (button, switch, text fields etc...).
When these are interacted, you execute `updateTextField()` then `inputText` is reflected in the text field.
### 2. Define `CustomKeyboardProvider`
```swift
struct MyKeyboardProvider: CustomKeyboardProvider {
weak var textField: UITextField!
init(with textField: UITextField) {
self.textField = textField
}
func inputView(with textField: UITextField) -> CustomKeyboardView? {
// Return keyboard view
let myKeyboardView = MyCustomKeyboardView()
myKeyboardView.textField = textField
return myKeyboardView
}
func inputAccessoryView(with textField: UITextField) -> CustomKeyboardAccessoryView? {
// Return CustomKeyboardAccessoryView or nil
// ToolbarKeyboardAccessoryView is built-in
// Of cource, you can implement your own toolbars
// CustomKeyboardAccessoryView has same interface with CustomKeyboardView
let accessoryView = ToolbarKeyboardAccessoryView(with: textField)
return accessoryView
}
}
```
### 3. Define `CustomKeyboardTextField`
```swift
typealias MyKeyboardTextField = CustomKeyboardTextField
```
See [sample implementation](https://github.com/giginet/CustomKeyboardTextField/blob/master/CustomKeyboardTextFieldDemo/CustomKeyboard.swift#L58) for detail.
# Installation
## Carthage
```
github "giginet/CustomKeyboardTextField"
```
## CocoaPods
```ruby
use_frameworks!
pod "CustomKeyboardTextField"
```
# Requirements
- iOS 8 or above
- Swift 3.0
# Author
giginet <>
# LICENSE
MIT License