SwiftBindings.Apple.TipKit 26.2.6

SwiftBindings.Apple.TipKit

Native .NET bindings for Apple's TipKit framework — in-app tips for surfacing app features. These are not Objective-C proxy wrappers; they use .NET 10's native Swift interop for direct, high-performance calls into Swift APIs from C#.

📖 Full usage guide → — the tip/rule/event/status model in C#, datastore configuration, display-frequency options, UIKit presentation, and why tips must be authored in a Swift companion.

Installation

dotnet add package SwiftBindings.Apple.TipKit

Requirements

• .NET 10.0+
• iOS 26.2+, macOS 26.2+, Mac Catalyst 26.2+, tvOS 26.2+
• macOS host for development

Usage

using TipKit;

// Configure the tip datastore at app startup
Tips.Configure();

// Build display-frequency options that gate tip presentation
var maxDisplay = new Tips.MaxDisplayCount((nint)3);
var ignoresFreq = new Tips.IgnoresDisplayFrequency(true);

// Reset stored donation/event state (e.g. for testing)
Tips.ResetDatastore();

Tips.Configure, TipView, PopoverTipView, Invalidate(reason:), the Tips.InvalidationReason enum, and the configuration-option types are all bound. Tips that display unconditionally — or whose display rule is declared in Swift — are fully supported from C#.

Documentation

• Usage guide (wiki) — full C# walkthrough of the binding surface
• Apple TipKit framework

Caveats

Tips.Rule.when(...) result-builder DSL is unreachable from C#

Swift authors compose Tips.Rule predicates with a result-builder DSL:

@Rule(Donations.self) { $0.count >= 3 }
// or:
Tips.Rule(Donations.self) { donations in donations.count >= 3 }

These entry points are marked @_alwaysEmitIntoClient in the Swift standard library. That attribute tells the compiler to inline the implementation into every caller rather than exporting a stable ABI symbol. The generator therefore sees no call target: there is nothing to P/Invoke, and no Swift shim we can produce from the C# side would route back to the inlined-away generic body.

This is an upstream ABI limitation, not a gap in the generator. Donation-tracking, parameter rules, and event-count rules built through the DSL are currently not accessible from C#. Tip registration, tip discovery, display, and dismissal (Tips.configure, TipView, PopoverTipView, .invalidate(reason:), etc.) are all fully supported.

Workaround

If your tips do not rely on the DSL — i.e. they display unconditionally or their display rule is declared in Swift — the bindings cover every surface you need. For DSL-based rules, you can ship a tiny Swift companion target that publishes concrete Tips.Rule values as public static let properties; those are ordinary stored-property symbols and bind cleanly.

Status

Tracked as a permanent limitation. We will revisit if Apple exports stable symbols for the DSL in a future SDK, or if we add a C# source generator that emits a Swift shim target.

How It Works

These bindings are auto-generated by Swift Dotnet Bindings using .NET 10's native Swift interop via the SwiftBindings SDK.

License

The bindings are MIT licensed. TipKit is part of the Apple SDK; refer to Apple's licensing for the underlying framework.