KeyboardToolbar
👀
Overview
Use KeyboardToolbar to add tools as an input accessory view to a UITextField, UITextView, or any other view conforming to UITextInput.
KeyboardToolbar creates buttons with an iOS-like appearance and behavior.
📖
Documentation
The public interface is documented in the Swift files and can be found in KeyboardToolbar/Sources/KeyboardToolbar. You can also read the documention on Swift Package Index.
Lastly, you can also build the documentation yourself by opening the Swift package in Xcode and selecting Product > Build Documentation in the menu bar.
📦
Adding the Package
KeyboardToolbar is distributed using the Swift Package Manager. Install it in a project by adding it as a dependency in your Package.swift manifest or through “Package Dependencies” in project settings.
let package = Package(
dependencies: [
.package(url: "[email protected]:simonbs/KeyboardToolbar.git", from: "0.1.0")
]
)
🚀
Getting Started
The best way to understand how KeyboardToolbar is integrated into your project is by having a look at the Example project in this repository.
At a high level there are two steps required to setting up the keyboard toolbar.
- Create an instance of KeyboardToolbarView and assign it to inputAccessoryView on a UITextField, UITextView, or any other view that conforms to the UITextInput protocol.
- Assign an array of KeyboardToolGroup items to the
groupsproperty on your instance of KeyboardToolbarView.
The below code snippet shows how the two steps can be performed.
", textView: textView)
]),
KeyboardToolGroupItem(representativeTool: InsertTextKeyboardTool(text: "#", textView: textView), tools: [
InsertTextKeyboardTool(text: "#", textView: textView),
InsertTextKeyboardTool(text: "\"", textView: textView),
InsertTextKeyboardTool(text: "'", textView: textView),
InsertTextKeyboardTool(text: "$", textView: textView),
InsertTextKeyboardTool(text: "\\", textView: textView),
InsertTextKeyboardTool(text: "@", textView: textView),
InsertTextKeyboardTool(text: "%", textView: textView),
InsertTextKeyboardTool(text: "~", textView: textView)
])
]),
KeyboardToolGroup(items: [
// Tool to present the find navigator.
KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "magnifyingglass") { [weak self] in
self?.textView.findInteraction?.presentFindNavigator(showingReplace: false)
}),
// Tool to dismiss the keyboard.
KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "keyboard.chevron.compact.down") { [weak self] in
self?.textView.resignFirstResponder()
})
])
]">
/// Create our instance of KeyboardToolbarView and pass it to an instance of UITextView. let keyboardToolbarView = KeyboardToolbarView() textView.inputAccessoryView = keyboardToolbarView // Setup our tool groups. let canUndo = textView.undoManager?.canUndo ?? false let canRedo = textView.undoManager?.canRedo ?? false keyboardToolbarView.groups = [ // Tools for undoing and redoing text in the text view. KeyboardToolGroup(items: [ KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "arrow.uturn.backward") { [weak self] in self?.textView.undoManager?.undo() self?.setupKeyboardTools() }, isEnabled: canUndo), KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "arrow.uturn.forward") { [weak self] in self?.textView.undoManager?.redo() self?.setupKeyboardTools() }, isEnabled: canRedo) ]), // Tools for inserting characters into our text view. KeyboardToolGroup(items: [ KeyboardToolGroupItem(representativeTool: InsertTextKeyboardTool(text: "(", textView: textView), tools: [ InsertTextKeyboardTool(text: "(", textView: textView), InsertTextKeyboardTool(text: "{", textView: textView), InsertTextKeyboardTool(text: "[", textView: textView), InsertTextKeyboardTool(text: "]", textView: textView), InsertTextKeyboardTool(text: "}", textView: textView), InsertTextKeyboardTool(text: ")", textView: textView) ]), KeyboardToolGroupItem(representativeTool: InsertTextKeyboardTool(text: ".", textView: textView), tools: [ InsertTextKeyboardTool(text: ".", textView: textView), InsertTextKeyboardTool(text: ",", textView: textView), InsertTextKeyboardTool(text: ";", textView: textView), InsertTextKeyboardTool(text: "!", textView: textView), InsertTextKeyboardTool(text: "&", textView: textView), InsertTextKeyboardTool(text: "|", textView: textView) ]), KeyboardToolGroupItem(representativeTool: InsertTextKeyboardTool(text: "=", textView: textView), tools: [ InsertTextKeyboardTool(text: "=", textView: textView), InsertTextKeyboardTool(text: "+", textView: textView), InsertTextKeyboardTool(text: "-", textView: textView), InsertTextKeyboardTool(text: "/", textView: textView), InsertTextKeyboardTool(text: "*", textView: textView), InsertTextKeyboardTool(text: "<", textView: textView), InsertTextKeyboardTool(text: ">", textView: textView) ]), KeyboardToolGroupItem(representativeTool: InsertTextKeyboardTool(text: "#", textView: textView), tools: [ InsertTextKeyboardTool(text: "#", textView: textView), InsertTextKeyboardTool(text: "\"", textView: textView), InsertTextKeyboardTool(text: "'", textView: textView), InsertTextKeyboardTool(text: "$", textView: textView), InsertTextKeyboardTool(text: "\\", textView: textView), InsertTextKeyboardTool(text: "@", textView: textView), InsertTextKeyboardTool(text: "%", textView: textView), InsertTextKeyboardTool(text: "~", textView: textView) ]) ]), KeyboardToolGroup(items: [ // Tool to present the find navigator. KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "magnifyingglass") { [weak self] in self?.textView.findInteraction?.presentFindNavigator(showingReplace: false) }), // Tool to dismiss the keyboard. KeyboardToolGroupItem(style: .secondary, representativeTool: BlockKeyboardTool(symbolName: "keyboard.chevron.compact.down") { [weak self] in self?.textView.resignFirstResponder() }) ]) ]
630 Dec 13, 2022
88 Dec 27, 2022
0 Dec 29, 2021
2 Jun 10, 2022
1 Jan 4, 2022
12 Jan 2, 2023
2 Jun 6, 2022
15.8k Dec 31, 2022
4 Aug 18, 2022
0 Jun 9, 2022
2 Jul 8, 2022
84 Dec 16, 2022
34 Dec 22, 2022
0 Jan 8, 2022
491 Sep 9, 2022
1 Jan 8, 2022
1 Jan 10, 2022
8 May 13, 2022
0 Dec 25, 2021