Documentation / @ripl/vue / RiplTransitionScope

Class: RiplTransitionScope

Defined in: adapters/vue/src/core/transition.ts:78

The live transition phases in scope for a subtree of elements, resolved lazily so that reactive prop changes on the transition component take effect without re-registering its descendants.

Members are tracked in attachment order so a phase expressed as a factory receives a stable index and length, which is what makes staggered enters (delay: index * 20) work.

Constructors

Constructor

new RiplTransitionScope(getPhases): RiplTransitionScope

Defined in: adapters/vue/src/core/transition.ts:88

Parameters

Parameter	Type
getPhases	() => RiplTransitionPhases

Returns

RiplTransitionScope

Accessors

appear

Get Signature

get appear(): boolean

Defined in: adapters/vue/src/core/transition.ts:84

Whether elements present on the initial mount run their enter phase.

Returns

boolean

Methods

register()

register(element): void

Defined in: adapters/vue/src/core/transition.ts:93

Adds an element to the scope, giving it a position for staggered phase factories.

Parameters

Parameter	Type
element	Element

Returns

void

---

resolve()

resolve(name, element): RiplTransitionPhaseOptions<Element<Partial<BaseState>, ElementEventMap>> | undefined

Defined in: adapters/vue/src/core/transition.ts:116

Resolves a phase's options for a single element, invoking the factory form with the element's position in the scope.

Parameters

Parameter	Type	Description
name	RiplTransitionPhaseName	The phase to resolve.
element	Element	The element the phase applies to.

Returns

RiplTransitionPhaseOptions<Element<Partial<BaseState>, ElementEventMap>> | undefined

The resolved options, or undefined when the phase was not supplied.

---

unregister()

unregister(element): void

Defined in: adapters/vue/src/core/transition.ts:98

Removes an element from the scope.

Parameters

Parameter	Type
element	Element

Returns

void