NEW! Check out my latest book, Testing Swift! >>

How to use UISearchController to let users enter search words

Paul Hudson       @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!

Other people are reading…

About the Swift Knowledge Base

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

Learn Server-Side Swift now!

Take your Swift code to the server and become a full-stack developer with my latest book: Server-Side Swift!

MASTER SWIFT NOW
Buy Testing Swift Buy Practical iOS 12 Buy Pro Swift Buy Swift Design Patterns Buy Swift Coding Challenges Buy Server-Side Swift (Vapor Edition) Buy Server-Side Swift (Kitura Edition) Buy Hacking with macOS Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with Swift Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let me know!

Click here to visit the Hacking with Swift store >>