How to place the search bar above a List instead of in the toolbar - macOS

Summary

The issue at hand is about the placement of a search bar in a macOS application built with SwiftUI. By default, the search bar appears in the top toolbar, but the desired behavior is to have it placed above the list, inside the inspector view. This is a common requirement when implementing searchable lists in macOS applications.

Root Cause

The root cause of this issue is due to the default behavior of the .searchable() modifier in SwiftUI, which automatically places the search bar in the toolbar. The reasons for this behavior include:

Default UI guidelines: Following the standard macOS UI guidelines, which recommend placing search bars in the toolbar for consistency and user experience.
Automatic placement: The .searchable() modifier automatically handles the placement of the search bar, making it easier to implement searchable lists, but limiting customization options.

Why This Happens in Real Systems

This issue occurs in real systems because:

SwiftUI’s default behavior: The default behavior of SwiftUI’s .searchable() modifier is to place the search bar in the toolbar, which may not always be the desired behavior.
Limited customization options: The .searchable() modifier has limited customization options, making it difficult to change the default placement of the search bar.
UI guidelines: Following standard UI guidelines can sometimes limit the flexibility of the UI, leading to issues like this.

Real-World Impact

The impact of this issue includes:

Poor user experience: Having the search bar detached from the list can lead to a poor user experience, as users may not immediately understand the connection between the search bar and the list.
Inconsistent UI: The default placement of the search bar can lead to an inconsistent UI, as the search bar may not be placed where users expect it to be.
Difficulty in implementation: Implementing a custom search bar placement can be challenging, especially for developers who are new to SwiftUI.

Example or Code

import SwiftUI

struct ContentView: View {
    @State private var inspectorShown = true
    var body: some View {
        Text("Main View")
            .inspector(isPresented: $inspectorShown) {
                InspectorView()
            }
    }
}

struct InspectorView: View {
    @State private var searchText: String = ""
    var body: some View {
        VStack {
            SearchBar(text: $searchText)
            List {
                Text("One")
                Text("Two")
                Text("Three")
            }
            .listStyle(.sidebar)
        }
    }
}

struct SearchBar: View {
    @Binding var text: String
    var body: some View {
        HStack {
            Image(systemName: "magnifyingglass")
            TextField("Search", text: $text)
        }
        .padding()
        .background(Color.gray.opacity(0.2))
        .cornerRadius(5)
    }
}

How Senior Engineers Fix It

Senior engineers fix this issue by:

Creating a custom search bar: Instead of using the default .searchable() modifier, senior engineers create a custom search bar using a TextField and a Image for the magnifying glass.
Placing the search bar manually: Senior engineers manually place the custom search bar above the list, using a VStack or another layout view.
Implementing search functionality: Senior engineers implement the search functionality manually, using the @State variable to filter the list.

Why Juniors Miss It

Juniors may miss this issue because:

Lack of experience: Juniors may not have enough experience with SwiftUI to know about the default behavior of the .searchable() modifier.
Limited knowledge of UI guidelines: Juniors may not be familiar with the standard UI guidelines for macOS, which can lead to inconsistent UI design.
Overreliance on default behavior: Juniors may rely too heavily on the default behavior of SwiftUI’s modifiers, without exploring customization options.

How to place the search bar above a List instead of in the toolbar – macOS