How to add scopes to a UISearchController

Paul Hudson    October 26th 2018    @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.

Available from iOS 8.0

Did this solution work for you? Please pass it on!

Tweet

Other people are reading…

• What is a view’s intrinsic content size?
• How to use UIStepper to let users change number values
• What are the different UIStackView distribution types?
• How to make a background image run under the safe area
• How to pad a UITextView by setting its text container inset

About the Swift Knowledge Base

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