useViewTransitionState

[MODES: framework, data]

Summary

Reference Documentation ↗

This hook returns true when there is an active View Transition to the specified location. This can be used to apply finer-grained styles to elements to further customize the view transition. This requires that view transitions have been enabled for the given navigation via LinkProps.viewTransition (or the Form, submit, or navigate call)

Signature

function useViewTransitionState(
  to: To,
  {
    relative,
  }: {
    relative?: RelativeRoutingType;
  } = ,
) {}

Params

to

The To location to check for an active View Transition.

options.relative

The relative routing type to use when resolving the to location, defaults to "route". See RelativeRoutingType for more details.

Returns

true if there is an active View Transition to the specified Location, otherwise false.