Help prepare for 2025 → Answer 8 simple questions on our Fall Survey
Open Survey
SharedTransitionHelper
Platform helper to aid in creating your own custom Shared Element Transition classes. (iOS Only)

Summary ​

Constructors ​

constructor ​

new SharedTransitionHelper(): SharedTransitionHelper
Returns SharedTransitionHelper

Methods ​

animate ​

Static
animate(
  state: SharedTransitionState,
  transitionContext: any,
  type: TransitionNavigationType
): void
Parameter Default Description
state
SharedTransitionState

transitionContext
any

type
TransitionNavigationType

Returns void

interactiveCancel ​

Static
interactiveCancel(
  state: SharedTransitionState,
  interactiveState: TransitionInteractiveState,
  type: TransitionNavigationType
): void
Parameter Default Description
state
SharedTransitionState

interactiveState
TransitionInteractiveState

type
TransitionNavigationType

Returns void

interactiveFinish ​

Static
interactiveFinish(
  state: SharedTransitionState,
  interactiveState: TransitionInteractiveState,
  type: TransitionNavigationType
): void
Parameter Default Description
state
SharedTransitionState

interactiveState
TransitionInteractiveState

type
TransitionNavigationType

Returns void

interactiveStart ​

Static
interactiveStart(
  state: SharedTransitionState,
  interactiveState: TransitionInteractiveState,
  type: TransitionNavigationType
): void
Parameter Default Description
state
SharedTransitionState

interactiveState
TransitionInteractiveState

type
TransitionNavigationType

Returns void

interactiveUpdate ​

Static
interactiveUpdate(
  state: SharedTransitionState,
  interactiveState: TransitionInteractiveState,
  type: TransitionNavigationType,
  percent: number
): void
Parameter Default Description
state
SharedTransitionState

interactiveState
TransitionInteractiveState

type
TransitionNavigationType

percent
number

Returns void
Next
ShorthandProperty