Settings
A scene that presents an interface for viewing and modifying an app’s settings.
Declaration
struct Settings<Content> where Content : ViewMentioned in
Overview
Use a settings scene to have SwiftUI manage views with controls for your app’s settings when you declare your app using the App protocol. When you use an App declaration for multiple platforms, compile the settings scene only in macOS:
@main
struct MyApp: App {
var body: some Scene {
WindowGroup {
ContentView()
}
#if os(macOS)
Settings {
SettingsView()
}
#endif
}
}Passing a view as the argument to a settings scene in the App declaration causes SwiftUI to enable the app’s Settings menu item. SwiftUI manages displaying and removing the settings view when the user selects the Settings item from the application menu or the equivalent keyboard shortcut:
[Image]
The contents of your settings view are controls that modify bindings to UserDefaults values that SwiftUI manages using the AppStorage property wrapper:
struct GeneralSettingsView: View {
@AppStorage("showPreview") private var showPreview = true
@AppStorage("fontSize") private var fontSize = 12.0
var body: some View {
Form {
Toggle("Show Previews", isOn: $showPreview)
Slider(value: $fontSize, in: 9...96) {
Text("Font Size (\(fontSize, specifier: "%.0f") pts)")
}
}
}
}You can define your settings in a single view, or you can use a TabView to group settings into different collections:
struct SettingsView: View {
var body: some View {
TabView {
Tab("General", systemImage: "gear") {
GeneralSettingsView()
}
Tab("Advanced", systemImage: "star") {
AdvancedSettingsView()
}
}
.scenePadding()
.frame(maxWidth: 350, minHeight: 100)
}
}[Image]