# tvOS modal rich media
Starting from Pushwoosh SDK version 6.11.0, you have the ability to send **Modal Rich Media** to tvOS devices (Apple TV).
Modal Rich Media for tvOS provides an interactive HTML-based content display optimized for Apple TV's remote control navigation. The rich media can be customized with different positions, animations, and focus navigation support.
> For more information on Rich Media pages, please refer to [our guide](/product/content/rich-media).
## Installation
The PushwooshTVOS module is optional and can be integrated into your tvOS project using Swift Package Manager or CocoaPods.
### Swift Package Manager
Add the Pushwoosh package to your tvOS project:
1. In Xcode, select **File** → **Add Package Dependencies...**
2. Enter the repository URL: `https://github.com/Pushwoosh/Pushwoosh-XCFramework`
3. Select the latest version
4. Add the following frameworks to your tvOS target:
* **PushwooshFramework**
* **PushwooshCore**
* **PushwooshBridge**
* **PushwooshLiveActivities**
* **PushwooshTVOS**
### CocoaPods
Add to your Podfile:
```ruby
target 'YourTvOSApp' do
platform :tvos, '13.0'
pod 'PushwooshXCFramework'
pod 'PushwooshXCFramework/PushwooshTVOS'
end
```
Then run:
```bash
pod install
```
## Basic integration
### 1. Configure Pushwoosh in your AppDelegate
Import the required modules and configure Pushwoosh with your application code:
```swift
import UIKit
import PushwooshTVOS
import PushwooshFramework
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Configure Pushwoosh with your app code
Pushwoosh.TVoS.setAppCode("XXXXX-XXXXX")
// Register for push notifications
Pushwoosh.TVoS.registerForTvPushNotifications()
return true
}
}
```
### 2. Handle device token registration
Implement the device token handler to register the device with Pushwoosh:
```swift
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Pushwoosh.TVoS.registerForTvPushNotifications(withToken: deviceToken) { error in
if let error = error {
print("Failed to register: \(error)")
} else {
print("Successfully registered for push notifications")
}
}
}
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
Pushwoosh.TVoS.handleTvPushRegistrationFailure(error)
}
```
### 3. Handle incoming push notifications
Process incoming push notifications with rich media content:
```swift
func application(_ application: UIApplication,
didReceiveRemoteNotification userInfo: [AnyHashable: Any],
fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
// Handle push notification and display rich media if present
if Pushwoosh.TVoS.handleTVOSPush(userInfo: userInfo) {
completionHandler(.newData)
} else {
completionHandler(.noData)
}
}
```
## Rich Media configuration
### Positioning
Modal Rich Media for tvOS can be positioned in five locations on the screen:
```swift
// Center position (default)
Pushwoosh.TVoS.configureRichMediaWith(position: .center, presentAnimation: .none, dismissAnimation: .none)
// Left side of the screen
Pushwoosh.TVoS.configureRichMediaWith(position: .left, presentAnimation: .fromLeft, dismissAnimation: .toLeft)
// Right side of the screen
Pushwoosh.TVoS.configureRichMediaWith(position: .right, presentAnimation: .fromRight, dismissAnimation: .toRight)
// Top of the screen
Pushwoosh.TVoS.configureRichMediaWith(position: .top, presentAnimation: .fromTop, dismissAnimation: .toTop)
// Bottom of the screen
Pushwoosh.TVoS.configureRichMediaWith(position: .bottom, presentAnimation: .fromBottom, dismissAnimation: .toBottom)
```
Available position options:
```swift
enum PWTVOSRichMediaPosition {
case center // Content positioned at the center of the screen (default)
case left // Content positioned at the left side of the screen
case right // Content positioned at the right side of the screen
case top // Content positioned at the top of the screen
case bottom // Content positioned at the bottom of the screen
}
```
### Present animations
Control how rich media content appears on screen:
```swift
enum PWTVOSRichMediaPresentAnimation {
case none // No animation, content appears immediately (default)
case fromTop // Content slides in from the top of the screen
case fromBottom // Content slides in from the bottom of the screen
case fromLeft // Content slides in from the left side of the screen
case fromRight // Content slides in from the right side of the screen
}
```
### Dismiss animations
Control how rich media content disappears from screen:
```swift
enum PWTVOSRichMediaDismissAnimation {
case none // No animation, content disappears immediately (default)
case toTop // Content slides out to the top of the screen
case toBottom // Content slides out to the bottom of the screen
case toLeft // Content slides out to the left side of the screen
case toRight // Content slides out to the right side of the screen
}
```
### Configuration examples
Configure rich media to appear on the left side with animations:
```swift
Pushwoosh.TVoS.configureRichMediaWith(
position: .left,
presentAnimation: .fromBottom,
dismissAnimation: .toLeft
)
```
Configure rich media to appear at the bottom with slide animations:
```swift
Pushwoosh.TVoS.configureRichMediaWith(
position: .bottom,
presentAnimation: .fromBottom,
dismissAnimation: .toBottom
)
```
Configure rich media to appear centered without animations:
```swift
Pushwoosh.TVoS.configureRichMediaWith(
position: .center,
presentAnimation: .none,
dismissAnimation: .none
)
```
## Close button configuration
By default, a Close button is displayed at the bottom of rich media presentations. You can hide this button if needed:
```swift
// Hide the system Close button
Pushwoosh.TVoS.configureCloseButton(false)
```
## Focus navigation for Apple TV
The tvOS SDK automatically manages focus navigation for Apple TV's remote control. Interactive elements (buttons, links) in your rich media HTML content will be focusable using the Apple TV remote.
### Focus behavior
- Focusable elements are automatically detected in the HTML content
- Users can navigate between elements using the directional pad on the Apple TV remote
- The currently focused element receives a visual highlight
- Users can activate focused elements by pressing the center button on the remote
- The system Close button (when visible) is also part of the focus navigation
### Best practices for HTML content
When creating HTML content for tvOS rich media:
1. Use standard interactive HTML elements: `