moreswift/swift-observation-polyfill

Important information

• Observable models produced using the polyfill are compatible with APIs that expect real Observation.Observable models. This is because the polyfilled macro generates a conformance to Observation.Observable when Observation is available.
• Observable models produced using Observation are not compatible with APIs that expect polyfilled ObservationPolyfill.Observable models.
• If your deployment target is lower than the platform version that brought the Observation library, then you can always use this polyfill's declarations unqualified (i.e. @Observable instead of @ObservationPolyfill.Observable), even if Observation/SwiftUI is in scope.
• @Observable unambiguously refers to the ObservationPolyfill.Observable macro as long as your deployment target is low enough that Observation.Observable isn't unconditionally available.
• Library developers relying on ObservationPolyfill must implement special handling and/or multiple copies of their APIs if they would like users to be able to use both polyfilled models and real Observation.Observable models with their library. This is because users with high enough deployment targets may want to be able to just use the first-party Observation module, especially when porting existing code from SwiftUI etc.
• When using ObservationPolyfill with SwiftUI and targeting pre-Observation OS versions, you must wrap each view body in the WithObservationTracking view to ensure that state tracking functions correctly. It's easy to forget to do this if you only test your app on the latest OS version, because your app will appear to work fine both with and without WithObservationTracking. This is the same way that things work when using swift-perception.

In short, there generally aren't any drawbacks to using ObservationPolyfill as an application developer, because polyfilled models are still compatible with regular Observation APIs, but as a library developer you have to take more care to support both Observation and ObservationPolyfill.

Package Metadata

Repository: moreswift/swift-observation-polyfill

Default branch: main

README: README.md