Classes
SharedTransition
SharedTransition
Shared Element Transitions (preview)
Allows you to auto animate between shared elements on two different screesn to create smooth navigational experiences.
View components can define sharedTransitionTag="name" alone with a transition through this API.
Summary β
Constructors
Properties
Constructors β
constructor β
new SharedTransition(): SharedTransition
Returns SharedTransition
Properties β
DEBUG β
Static
Enable to see various console logging output of Shared Element Transition behavior.
finishedEvent β
Static
When the transition finishes.
inProgress β
Static
Whether a transition is in progress or not.
Note: used internally however exposed in case custom state ordering is needed.
Updated when transitions start/end/cancel.
interactiveCancelledEvent β
Static
When the interactive transition cancels.
interactiveUpdateEvent β
Static
When the interactive transition updates with the percent value.
startedEvent β
Static
When the transition starts.
Methods β
custom β
Static
custom(transition: Transition, options?: SharedTransitionConfig): {}
Configure a custom transition with presentation/dismissal options.
Parameter Default Description
Returns {}
events β
Static
Listen to various shared element transition events.
Returns SharedTransitionObservable
finishState β
Static
Finish transition state.
Parameter Default Description
id
number
Transition instance id
Returns void
getSharedElements β
Static
Gather view collections based on sharedTransitionTag details.
getState β
Static
Get current state for any transition.
Parameter Default Description
id
number
Transition instance id
Returns SharedTransitionState
notifyEvent β
Static
Notify a Shared Transition event.
Parameter Default Description
eventName
string
Shared Transition event name
data
SharedTransitionEventDataPayload
Returns void
updateState β
Static
Update transition state.
Parameter Default Description
id
number
Transition instance id
state
SharedTransitionState
SharedTransitionState
Returns void
- Previous
- SegmentedBarItem