How To Create A Swift UI Search Bar: Step-by-Step Guide

The Swift UI Search Bar is a vital component in any modern app, offering users an efficient way to find information. Whether you’re building an app for managing your tasks, browsing through a catalog, or keeping track of your next meal plans, an intuitive search interface can make all the difference.

In this blog, you’ll learn how to add a search bar to your app using SwiftUI, along with best practices for enhancing the search experience.

Let’s dive into a technical, step-by-step walkthrough, complete with examples and explanations of how to use searchable features in SwiftUI.

What Makes a Great Search Bar?

A well-designed search bar enhances usability by providing seamless navigation. Key features include a search text field for input, search suggestions to guide users, and the ability to filter data dynamically as the user types. Thanks to the SwiftUI framework, implementing these functionalities is both straightforward and efficient.

Step 1: Setting Up the Basics in SwiftUI

Start by creating a SwiftUI struct ContentView. To make the search field functional, you'll need a @State private var to track the user's search query. Here’s how you can set up the basic structure:

Copy
import SwiftUI

struct ContentView: View {
    @State private var searchText: String = "" // State variable for search input

    var body: some View {
        NavigationView {
            List {
                // Placeholder for list content
                Text("Example Item 1")
                Text("Example Item 2")
            }
            .navigationTitle("Search Example")
            .searchable(text: $searchText, placement: .navigationBarDrawer(displayMode: .automatic))
        }
    }
}

Key Points:

• The @State private var searchText serves as the state private variable for tracking input.
• The .searchable view modifier adds the search field to your navigation view.
• The .placement parameter customizes where the search bar appears.

Step 2: Using the Searchable Modifier to Add a Search Bar

The searchable view modifier is at the heart of implementing a search bar. By attaching it to a SwiftUI List or any view inside a navigation view, you enable users to search effectively.

Adding Search Suggestions

Search suggestions can make your search interface more user-friendly by predicting what the user types. You can achieve this by leveraging the suggestions parameter:

Copy
.searchable(text: $searchText, placement: .navigationBarDrawer) {
    ForEach(["Apple", "Banana", "Cherry"], id: \.self) { suggestion in
        Text(suggestion).searchCompletion(suggestion)
    }
}

Here’s what happens:

• Searchable text is dynamically updated based on search suggestions.
• .searchCompletion helps filter data as the user taps a suggestion.

Step 3: Filtering Data with the User’s Search Query

To make the search bar functional, you’ll filter the displayed data based on the user's search query. Use a computed property to update the list dynamically:

Copy
var filteredData: [String] {
    let items = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
    return searchText.isEmpty ? items : items.filter { $0.contains(searchText) }
}

var body: some View {
    List(filteredData, id: \.self) { item in
        Text(item)
    }
    .searchable(text: $searchText)
}

Key Points:

• The filteredData property filters the array of items based on the search text.
• The search field automatically updates as the user types, enhancing the search experience.

Step 4: Enhancing the Search Experience with Placement and Suggestions

Using the parameter, you can refine the position of the search bar. For instance, in a split view app, you might place it in the placement:

Incorporating search suggestions not only improves usability but also allows for a more intuitive search interface.

Step 5: Adding a Cancel Button and Clear Button

To ensure users have full control over the search experience, add a cancel button and a clear button:

This enhances the usability by allowing users to reset their search quickly.

Complete Example Code

Here’s a complete implementation of a Swift UI Search Bar with searchable text, suggestions, and data filtering:

This source code demonstrates how to use SwiftUI to create a functional and user-friendly search bar.

The Bottom Line!

Integrating a Swift UI Search Bar into your app is both simple and powerful with the view modifier and SwiftUI framework. By leveraging tools like searchable text, search suggestions, and filtering, you can significantly enhance the search experience for your users. Remember to test your search interface thoroughly to ensure it meets your app's requirements. Follow this guide, and you'll have a fully functional search bar ready to elevate your app.

.searchable(text: $searchText, placement: .sidebar)

.searchable(text: $searchText, prompt: "Search for items")
.toolbar {
    Button("Cancel") {
        searchText = "" // Reset search text
    }
}

import SwiftUI

struct ContentView: View {
    @State private var searchText: String = ""

    var filteredData: [String] {
        let items = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
        return searchText.isEmpty ? items : items.filter { $0.contains(searchText) }
    }

    var body: some View {
        NavigationView {
            List(filteredData, id: \.self) { item in
                Text(item)
            }
            .searchable(text: $searchText, placement: .navigationBarDrawer(displayMode: .automatic)) {
                ForEach(["Apple", "Banana", "Cherry"], id: \.self) { suggestion in
                    Text(suggestion).searchCompletion(suggestion)
                }
            }
            .navigationTitle("Fruit Search")
            .toolbar {
                Button("Cancel") {
                    searchText = ""
                }
            }
        }
    }
}