badge(_:)

Declaration

nonisolated func badge(_ key: LocalizedStringKey?) -> some View

Parameters

• key:

  An optional string key to display as a badge. Set the value to nil to hide the badge.

Discussion

Use a badge to convey optional, supplementary information about a view. Keep the contents of the badge as short as possible. Badges appear in list rows, tab bars, toolbar items, and menus.

This modifier creates a Text view on your behalf, and treats the localized key similar to init(_:tableName:bundle:comment:). For more information about localizing strings, see Text. The following example shows a list with a “Default” badge on one of its rows.

NavigationView {
    List(servers) { server in
        Text(server.name)
            .badge(server.isDefault ? "Default" : nil)
    }
    .navigationTitle("Servers")
}

[Image]