toolbar

Populates the toolbar or navigation bar with the specified items.

View ModifieriOS 14.0+macOS 11.0+tvOS 14.0+watchOS 7.0+

Overloads

3 ways to call compose().toolbar(). Each is one SwiftUI overload, picked by the arguments you pass.

React
compose().toolbar({
  content: ReactNode,
})
Swift
nonisolated func toolbar<Content>(
    @ContentBuilder content: () -> Content
) -> some View
where Content : ToolbarContent

Parameters

  • options.content*ReactNode

    The items representing the content of the toolbar.

Discussion

Use this method to populate a toolbar with a collection of views that you provide to a toolbar content builder.

The toolbar modifier expects a collection of toolbar items which you can provide either by supplying a collection of views with each view wrapped in a ToolbarItem, or by providing a collection of views as a ToolbarItemGroup. The example below uses a collection of ToolbarItem views to create a macOS toolbar that supports text editing features:

struct StructToolbarItemGroupView: View {
    @State private var text = ""
    @State private var bold = false
    @State private var italic = false
    @State private var fontSize = 12.0

    var displayFont: Font {
        let font = Font.system(size: CGFloat(fontSize),
                               weight: bold == true ? .bold : .regular)
        return italic == true ? font.italic() : font
    }

    var body: some View {
        TextEditor(text: $text)
            .font(displayFont)
            .toolbar {
                ToolbarItemGroup {
                    Slider(
                        value: $fontSize,
                        in: 8...120,
                        minimumValueLabel:
                            Text("A").font(.system(size: 8)),
                        maximumValueLabel:
                            Text("A").font(.system(size: 16))
                    ) {
                        Text("Font Size (\(Int(fontSize)))")
                    }
                    .frame(width: 150)
                    Toggle(isOn: $bold) {
                        Image(systemName: "bold")
                    }
                    Toggle(isOn: $italic) {
                        Image(systemName: "italic")
                    }
                }
            }
            .navigationTitle("My Note")
    }
}

Although it's not mandatory, wrapping a related group of toolbar items together in a ToolbarItemGroup provides a one-to-one mapping between controls and toolbar items which results in the correct layout and spacing on each platform. For design guidance on toolbars, see doc://com.apple.documentation/design/human-interface-guidelines/toolbars in the Human Interface Guidelines.

See also

More in Navigation.