Awesome
<p align="center"> <img width="480" alt="Braze Logo" src=".github/assets/logo-light.png#gh-light-mode-only" /> <img width="480" alt="Braze Logo" src=".github/assets/logo-dark.png#gh-dark-mode-only" /> </p> <p align="center"> <a href="https://github.com/braze-inc/braze-swift-sdk/releases"> <img src="https://badgen.net/badge/version/11.2.0/blue" alt="Version: 11.2.0"> </a> <a href="#"> <img src="https://badgen.net/badge/platforms/iOS%20%7C%20visionOS%20%7C%20tvOS%20%7C%20Mac%20Catalyst/orange" alt="Platforms: iOS - visionOS – tvOS – Mac Catalyst"> </a> <a href="#"> <img src="https://badgen.net/badge/package%20managers/SwiftPM%20%7C%20CocoaPods/green" alt="Package Managers: SwiftPM - CocoaPods"> </a> <a href="https://github.com/braze-inc/braze-swift-sdk/blob/main/LICENSE"> <img src="https://badgen.net/badge/license/Commercial/black" alt="License: Commercial"> </a> </p>Braze Swift SDK
Version Information
- The Braze Swift SDK supports
- iOS 12.0+
- Mac Catalyst 13.0+
- tvOS 12.0+
- visionOS 1.0+
- Xcode 15.2 (15C500b) or newer
- This repository follows Semantic Versioning
Package Managers
- Swift Package Manager
- CocoaPods
Libraries
<!-- Table generated with https://www.tablesgenerator.com/markdown_tables -->| iOS | tvOS | macCatatyst | visionOS | |
|---|---|---|---|---|
| BrazeKit</br> Main SDK library providing support for analytics and push notifications. | ✅ | ✅<sup>1</sup> | ✅ | ✅ |
| BrazeUI</br> Braze-provided user interface library for In-App Messages and Content Cards. | ✅ | n/a | ✅ | ✅ |
| BrazeLocation</br> Location library providing support for location analytics and geofence monitoring. | ✅ | ✅<sup>2</sup> | ✅ | ✅<sup>2</sup> |
| BrazeNotificationService</br> Notification service extension library providing support for rich push notifications. | ✅ | n/a | ✅ | ✅ |
| BrazePushStory</br> Notification content extension library providing support for Push Stories. | ✅ | n/a | ✅ | ✅ |
<sup>1</sup> Push notifications not supported on tvOS</br> <sup>2</sup> Geofence monitoring not supported on tvOS and visionOS
Examples
Explore our examples project which showcases multiple features' integrations.
Wrapper Support
| Wrapper SDK | Swift SDK Support | Release Version |
|---|---|---|
| React Native | ✅ | 2.0.0 |
| Flutter | ✅ | 3.0.0 |
| Cordova | ✅ | 2.33.0 |
| Unity | ✅ | 4.0.0 |
| Xamarin | ✅ | 4.0.0 |
Alternative Repositories
| Variant | Repository | GH Issues, SDK info |
|---|---|---|
| → Sources and Static XCFrameworks | braze-inc/braze-swift-sdk | ✓ |
| Static XCFrameworks | braze-inc/braze-swift-sdk-prebuilt-static | ✗ |
| Dynamic XCFrameworks | braze-inc/braze-swift-sdk-prebuilt-dynamic | ✗ |
| Mergeable XCFrameworks (early access) | braze-inc/braze-swift-sdk-prebuilt-mergeable | ✗ |
Appboy-iOS-SDK
As of version 5.8.0, the Braze Swift SDK provides all the features available in the Appboy-iOS-SDK.
We recommend all users to migrate to the Braze Swift SDK. For more information, please refer to our migration guide.
The Appboy-iOS-SDK (Objective-C) SDK is now in maintenance mode, which means only critical bug fixes, and security updates will be made. No new features or minor bug fixes will be added to that library.
Questions?
If you have questions, please contact support@braze.com or open a Github Issue.