https://github.com/cleancocoa/omnibar
Text field component that supports term auto-completion and keyboard navigation
https://github.com/cleancocoa/omnibar
autocomplete components mac search swift view
Last synced: 10 months ago
JSON representation
Text field component that supports term auto-completion and keyboard navigation
- Host: GitHub
- URL: https://github.com/cleancocoa/omnibar
- Owner: CleanCocoa
- License: mit
- Created: 2017-06-03T09:45:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T09:59:49.000Z (over 1 year ago)
- Last Synced: 2025-08-12T19:11:33.921Z (11 months ago)
- Topics: autocomplete, components, mac, search, swift, view
- Language: Swift
- Size: 1.7 MB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Omnibar
[](https://github.com/Carthage/Carthage)
A search field with support for auto-completion of typed strings.
> **Looking for RxSwift compatibility?** The reactive extensions (RxSwift) have moved to after v0.21.
## Overview
Made to satisfy these needs:
1. Quickly filter search results;
2. Change result selection through use of the arrow keys from within the Omnibar;
3. Offer auto-completion of the search term inside the text field itself.
So if you type "aard", the Omnibar will suggest the term "aardvark" in the example app:
## Delegate-based Approach
### Displaying Values
Call `display(content: OmnibarContent)` to change the content of the Omnibar and affect the selection. You can also use the `stringValue` property to change the text and put the insertion point at the end like regular `NSTextField`s do.
```swift
public enum OmnibarContent {
/// Empties the Omnibar.
case empty
/// Display `text` inside the Omnibar and select it all (like ⌘A) for
/// quick overwriting.
case selection(text: String)
/// Display `text` inside the Omnibar and put the insertion point
/// at the end.
case prefix(text: String)
/// Display `text`, followed by `appendix`, putting the insertion point
/// before `appendix` and selecting it so it can be overwritten.
case suggestion(text: String, appendix: String)
}
```
### Reacting to Events
Set `delegate` to be notified of changes. The `OmnibarDelegate` protocol offers these function signatures:
- Optional: `omnibarSelectNext(_ omnibar: Omnibar)` and `omnibarSelectPrevious(_ omnibar: Omnibar)` to change the selected result without unfocusing the Omnibar.
- Required: `omnibar(_ omnibar: Omnibar, contentChange: OmnibarContentChange, method: ChangeMethod)`, notifying the delegate about the last user interaction and typing change.
`ChangeMethod` can be `.deletion`, `.insertion`, or `.appending` to convey what the user did so you can react to all cases differently.
`OmnibarContentChange` is either a `.replacement` of the old stuff, or a `.continuation` of the last suggestion, if there was any; `.continuation` is just like a self-suggested `OmnibarContent.suggestion` waiting for approval.
```swift
enum OmnibarContentChange {
case replacement(text: String)
case continuation(text: String, remainingAppendix: String)
}
```
# Attributions and Contributions
## English Open Word List (EOWL) v1.1.2
The sample app uses a list of 12000+ english words to display and filter.
> The “English Open Word List” (EOWL) was developed by Ken Loge, but is almost entirely derived from the “UK Advanced Cryptics Dictionary” (UKACD) Version 1.6, by J Ross Beresford.
- [English Open Word List](http://dreamsteep.com/projects/the-english-open-word-list.html)
- "UK Advanded Cryptics Dictionary" was formerly available at but is now down
## License
### Omnibar
Copyright (c) 2017 Christian Tietze. Distributed under the MIT License.
### English Open Word List (EOWL)
Copyright © J Ross Beresford 1993-1999. All Rights Reserved. The following restriction is placed on the use of this publication: if the UK Advanced Cryptics Dictionary is used in a software package or redistributed in any form, the copyright notice must be prominently displayed and the text of this document must be included verbatim.