https://github.com/cleancocoa/rxomnibar

Reactive extensions to CleanCocoa/Omnibar: a text field with auto-completion and keyboard navigation
https://github.com/cleancocoa/rxomnibar

Last synced: 4 months ago
JSON representation

Reactive extensions to CleanCocoa/Omnibar: a text field with auto-completion and keyboard navigation

• Host: GitHub
• URL: https://github.com/cleancocoa/rxomnibar
• Owner: CleanCocoa
• License: mit
• Created: 2025-01-04T08:38:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-04T11:09:08.000Z (over 1 year ago)
• Last Synced: 2025-11-18T09:25:26.494Z (7 months ago)
• Language: Swift
• Size: 673 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RxOmnibar

![Swift 5.7](https://img.shields.io/badge/Swift-5.7-blue.svg?style=flat)

![Version](https://img.shields.io/github/tag/CleanCocoa/Omnibar.svg?style=flat)

![Platform](https://img.shields.io/badge/platform-macOS-lightgrey.svg?style=flat)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

Reactive extensions for [Omnibar](https://github.com/CleanCocoa/Omnibar), a search field with support for auto-completion of typed strings.

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



    



## Reactive Extension

Once you have a reference to `omnibar: Omnibar`, the reactive extension `.rx` offers this:

- `omnibar.rx.text` which behaves just like `NSTextField().rx.text` and sends the whole contents while the user is typing -- it's like a stream of `stringValue` property changes;

- `omnibar.rx.contentChange` emits the changed content, either a `.replacement` or `.continuation`;

- `omnibar.rx.moveSelection` emits either `.previous` (up arrow key) or `.next` (down arrow key);

- `omnibar.rx.content` takes in any `OmnibarContent` value to change the text being displayed.

# 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.