FluxTransition

Description

Component to display a transition animation between two resources.

Demoopen in new window

Props

interface FluxTransitionProps {
	size: Size;
	transition: Object;
	from: Resource;
	to: Resource;
	displayComponent?: null | any;
	options?: Object;
}

size

This size is the width and height in pixels that the component will have.

transition

The component that performs the animation.

TIP

Check included transitions or custom transitions for more details.

from

This attribute will define transition starting resource.

to

This attribute will define transition ending resource.

options

The transition options to overwrite the transition parameters.

The available options depend on transition, so check the transitions to know which ones can be modified.

For custom transitions, will apply the same.

Methods

// This method will call the method `onPlay`of the transition component, starting the transition.
async start(): void

Emits

NameParametersDescription
readytransition: Object, from: Resource, to: Resource, options: Object, duration: numberWill be fired when the transition is ready to play because the components are rendered
starttransition: Object, from: Resource, to: Resource, options: Object, duration: numberWill let know when transition has started
endtransition: Object, from: Resource, to: Resource, options: Object, duration: numberFired when transition ended