Skip to content

A SwiftUI SDK that lets you type into a searchable text field without having to focus on it first.

License

Notifications You must be signed in to change notification settings

danielsaidi/QuickSearch

Repository files navigation

Project Icon

Version Swift 6.0 Swift UI Documentation MIT License Sponsor my work

QuickSearch

QuickSearch is a SwiftUI SDK that lets you type into a .searchable text field by just typing, without first having to focus on the text field. It's good for content-based views without any other text fields.

QuickSearch works on all Macs and iPads with a physical keyboard. The .searchable text field can be used like a regular text field on devices with no physical keyboard.

Unlike the native .searchable(text: $query, isPresented: .constant(true)) modifier, QuickSearch doesn't show the input cursor, to avoid draving attention to the search field.

Installation

QuickSearch can be installed with the Swift Package Manager:

https://github.com/danielsaidi/QuickSearch.git

Support My Work

You can become a sponsor to help me dedicate more time on my various open-source tools. Every contribution, no matter the size, makes a real difference in keeping these tools free and actively developed.

Getting Started

All you have to do to make QuickSearch work, is to apply quickSearch: true to .searchable:

 struct ContentView: View {
 
     @State var query = ""
     @State var text = ""
 
     @FocusState var isTextFieldFocused
    
     var body: some View {
         NavigationStack {
             VStack {
                TextField("Type here...", text: $text)
             }
             .searchable(text: $query, quickSearch: true)
         }
     }
}

You can also apply the .quickSearch view modifier, to any superview, if you can't access .searchable, use custom focus bindings, etc.

Documentation

The online documentation has more information, articles, code examples, etc.

Demo Application

The Demo folder has an app that lets you try the library on macOS and on iPads with a hardware keyboard.

Contact

Feel free to reach out if you have questions or want to contribute in any way:

License

QuickSearch is available under the MIT license. See the LICENSE file for more info.

About

A SwiftUI SDK that lets you type into a searchable text field without having to focus on it first.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 2

  •  
  •