toolbarBackground

Specifies the preferred shape style of the background of a bar managed by SwiftUI.

View ModifieriOS 16.0+macOS 13.0+tvOS 16.0+watchOS 9.0+toolbarBackground(_:for:) in SwiftUI

Declaration

React
compose().toolbarBackground(
  style: SwiftUI.ShapeStyle,
  options: {
    for: SwiftUI.ToolbarPlacement[];
  }
)
Swift
nonisolated func toolbarBackground<S>(
    _ style: S,
    for bars: ToolbarPlacement...
) -> some View
where S : ShapeStyle

Parameters

Discussion

The preferred style flows up to the nearest container that renders a bar. This could be a NavigationView or TabView in iOS, or the root view of a WindowGroup in macOS. This example shows a view that renders the navigation bar with a blue background and dark color scheme.

NavigationView {
    ContentView()
        .toolbarBackground(.white)
        .toolbarColorScheme(.dark)
}

You can provide multiple ToolbarPlacement instances to customize multiple bars at once.

TabView {
    NavigationView {
        ContentView()
            .toolbarBackground(
                .blue, for: .navigationBar, .tabBar)
            .toolbarColorScheme(
                .dark, for: .navigationBar, .tabBar)
    }
}

When used within a TabView, the specified style will be preferred while the tab is currently active. You can use a Group to specify the same preferred background for every tab.

TabView {
    Group {
        MainView()
        SettingsView()
    }
    .toolbarBackground(.blue, for: .tabBar)
}

Depending on the specified bars, the requested style may not be able to be fullfilled.

See also

More in Navigation.