BLACK FRIDAY: Save 50% on all books and bundles! >>

How to add scopes to a UISearchController

Swift version: 5.2

Paul Hudson    @twostraws   

By default a UISearchController provides just a text input field, but with a few small changes you can make it add scopes buttons underneath to let the user control how their search happens.

First, make your view controller conform to UISearchBarDelegate as well as UISearchResultsUpdating.

You need to add two new lines where you create your search controller: one to add the scope button titles you want to use, and one to tell the search bar to report changes back to the view controller:

search.searchBar.scopeButtonTitles = ["Friends", "Everyone"]
search.searchBar.delegate = self

Finally, implement the selectedScopeButtonIndexDidChange method so you get notified when the user tapped a scope button:

func searchBar(_ searchBar: UISearchBar, selectedScopeButtonIndexDidChange selectedScope: Int) {
    print("New scope index is now \(selectedScope)")
}

You can read the selected index at any time by using the searchController.searchBar.selectedScopeButtonIndex property.

Save 50% in my Black Friday sale.

Sponsor Hacking with Swift and reach the world's largest Swift community!

Available from iOS 8.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

BUY OUR BOOKS
Buy Pro Swift Buy Swift Design Patterns Buy Testing Swift Buy Hacking with iOS Buy Swift Coding Challenges Buy Swift on Sundays Volume One Buy Server-Side Swift (Vapor Edition) Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Advanced iOS Volume Three Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with macOS Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Server-Side Swift (Kitura Edition) Buy Beyond Code

Was this page useful? Let us know!

Average rating: 2.3/5

Link copied to your pasteboard.