TabViewCustomization

The customizations a person makes to an adaptable sidebar tab view.

StructureiOS 18.0+macOS 15.0+visionOS 2.0+TabViewCustomization in SwiftUI

Declaration

React
type TabViewCustomization = TabViewCustomizationChain;
Swift
struct TabViewCustomization

Overview

By default, if a person hasn't made customizations, tabs appear according to the default builder visibilities and sections appear in the order you declare in the tab view's tab builder.

You can change the default visibility by using the TabContent.defaultVisibility(_:for:) with a AdaptableTabBarPlacement.sidebar placement.

You can change the default section order by changing the order in the builder. If there's an existing persisted customization, reset the order by calling TabViewCustomization.SectionCustomization.resetTabOrder() when you change the order.

All tabs and tab sections that support customization need to have a customization ID. You can mark a tab as being non-customizable by specifying a TabCustomizationBehavior.disabled behavior in all adaptable tab bar placements using TabContent.customizationBehavior(_:for:)-2u727.

On macOS, a default interaction is provided for reordering sections but not for controlling the visibility of individual tabs. A custom experience should be provided if desired by setting the visibility of the tab on the customization.

The following code example uses @AppStorage to automatically persist any visibility or section order customizations a person makes.

@AppStorage
private var customization: TabViewCustomization

TabView {
    Tab("Home", systemImage: "house") {
        MyHomeView()
    }
    .customizationID("com.myApp.home")

    Tab("Reports", systemImage: "chart.bar") {
        MyReportsView()
    }
    .customizationID("com.myApp.reports")

    TabSection("Categories") {
        Tab("Climate", systemImage: "fan") {
            ClimateView()
        }
        .customizationID("com.myApp.climate")

        Tab("Lights", systemImage: "lightbulb") {
            LightsView()
        }
        .customizationID("com.myApp.lights")
    }
    .customizationID("com.myApp.browse")
}
.tabViewStyle(.sidebarAdaptable)
.tabViewCustomization($customization)

From Apple’s SwiftUI documentation. Code samples there are Swift.

Used by

See also

More in Navigation.