How to use UISearchController to let users enter search words

Paul Hudson    February 13th 2018    @twostraws

UISearchController is a small component designed to make it easy and consistent to add searching to any view controller. Adding it only takes a few small steps:

1. Embed your view controller in a navigation controller.
2. Add a conformance to UISearchResultsUpdating.
3. Create the search controller and assign it to your view controller.
4. Implement its sole required method: updateSearchResults().

Let’s go through them here. First, open Main.storyboard, select your view controller, then embed it in a navigation controller – go to the Editor menu and choose Embed In > Navigation Controller.

Second, modify your view controller’s definition so that it includes a conformance for UISearchResultsUpdating:

class ViewController: UIViewController, UISearchResultsUpdating {

Third, add some code to viewDidLoad() to create the search controller and assign it to the current view controller. The search controller actually belongs as a property of the navigation item of the view controller, which automatically places it inside your navigation bar when the view controller is displayed.

let search = UISearchController(searchResultsController: nil)
search.searchResultsUpdater = self
search.obscuresBackgroundDuringPresentation = false
search.searchBar.placeholder = "Type something here to search"
navigationItem.searchController = search

Finally, implement the updateSearchResults() method to update your search results. This method gets called every time the user types anything into the search bar, so it’s your job to use their new text to filter your data however you want:

func updateSearchResults(for searchController: UISearchController) {
    guard let text = searchController.searchBar.text else { return }
    print(text)
}

That’s it!

Available from iOS 8.0

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

Tweet

Other people are reading…

• How to add a bar button to a navigation bar
• What are the different UIStackView distribution types?
• How to set the tabs in a UITabBarController
• How to hide the navigation bar using hidesBarsOnTap
• How to detect long presses using UILongPressGestureRecognizer

About the Swift Knowledge Base

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