popoverTip(_:isPresented:attachmentAnchor:arrowEdges:action:)

Declaration

@preconcurrency nonisolated func popoverTip(_ tip: (any Tip)?, isPresented: Binding<Bool>? = nil, attachmentAnchor: PopoverAttachmentAnchor = .rect(.bounds), arrowEdges: Edge.Set, action: @escaping @MainActor @Sendable (Tips.Action) -> Void = { _ in }) -> some View

Parameters

• tip:

  The tip to display.

• isPresented:

  A binding that will automatically update to true when a tip is displayed. This value can be changed to temporarily hide or show a currently displayable tip. If this value is nil, the popover will automatically be dismissed based on the tip’s status and display rules. If this value is nil, the popover will automatically be dismissed based on the tip’s status and display rules.

• attachmentAnchor:

  The positioning anchor that defines the attachment point of the popover. The default is bounds.

• arrowEdges:

  The edges that the popover’s arrow is allowed to be positioned.

• action:

  The closure to perform when the user triggers a tip’s action.

Discussion

Use this modifier to present a tip as a popover on an existing view when the tip becomes eligible for display.

struct TrailRow: View {
    let trail: Trail

    var body: some View {
        VStack {
            HStack {
                Text(trail.name)

                Button(action: trail.favorite) {
                    Image(systemName: "star")
                }
            }
        }
        .popoverTip(FavoriteTrailTip(), attachmentAnchor: .point(.center), arrowEdges: .vertical)
    }
}