ScenePhase
An indication of a scene's operational state.
Declaration
type ScenePhase = 'active' | 'background' | 'inactive';enum ScenePhasePass a literal, or build one with SwiftUI.ScenePhase from import { SwiftUI } from 'swiftui-react-native'.
Type properties
'active'SwiftUI.ScenePhase.active'background'SwiftUI.ScenePhase.background'inactive'SwiftUI.ScenePhase.inactive
Overview
The system moves your app's Scene instances through phases that reflect
a scene's operational state. A scene's operational state can vary
depending on what platform it's on and whether it's in the foreground,
minimized, in the app switcher, or in the background. You can perform
actions when the phase changes. Read the current phase by observing the
EnvironmentValues.scenePhase value in the Environment:
@Environment(\.scenePhase) private var scenePhaseHow you interpret the value depends on where it's read from.
If you read the phase from inside a View instance, you obtain a value
that reflects the phase of the scene that contains the view. The following
example uses the View.onChange(of:initial:_:)-8wgw9 method to enable
a timer whenever the enclosing scene enters the ScenePhase.active phase
and disable the timer when entering any other phase:
struct MyView: View {
@ObservedObject var model: DataModel
@Environment(\.scenePhase) private var scenePhase
var body: some View {
TimerView()
.onChange(of: scenePhase) {
model.isTimerRunning = (scenePhase == .active)
}
}
}If you read the phase from within an App instance, you obtain an
aggregate value that reflects the phases of all the scenes in your app. The
app reports a value of ScenePhase.active if any scene is active, or a
value of ScenePhase.inactive when no scenes are active. This includes
multiple scene instances created from a single scene declaration; for
example, from a WindowGroup. When an app enters the
ScenePhase.background phase, expect the app to terminate soon after.
You can use that opportunity to free any resources:
@main
struct MyApp: App {
@Environment(\.scenePhase) private var scenePhase
var body: some Scene {
WindowGroup {
MyRootView()
}
.onChange(of: scenePhase) {
if scenePhase == .background {
// Perform cleanup when all scenes within
// MyApp go to the background.
}
}
}
}From Apple’s SwiftUI documentation. Code samples there are Swift.
See also
More in Animation.
- AnimationThe way a view changes over time to create a smooth visual transition from one state to another.
- AnimationChainAnimation with chained calls: SwiftUI.Animation.delay(...).
- AnimationCompletionCriteriaThe criteria that determines when an animation is considered finished.
- AnimationTimelineScheduleA pausable schedule of dates updating at a frequency no more quickly than the provided interval.
- AnyTransitionA type-erased transition.
- AnyTransitionChainAnyTransition with chained calls: SwiftUI.AnyTransition.animation(...).
- BlurReplaceTransitionA transition that animates the insertion or removal of a view by combining blurring and scaling effects.
- BlurReplaceTransitionConfigurationConfiguration properties for a transition.
- ContentTransitionA kind of transition that applies to the content within a single view, rather than to the insertion or removal of a view.
- DropSessionPhaseThe phase of the current drop session.
- GlassEffectTransitionA structure that describes changes to apply when a glass effect is added or removed from the view hierarchy.
- IdentityTransitionA transition that returns the input view, unmodified, as the output view.