summaryrefslogtreecommitdiffhomepage
path: root/desktop/packages/mullvad-vpn/src/renderer/lib/transition-hooks.ts
blob: 4c7f1708b9ab05906e2acbaad29c43f2ab1cb121 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
import { Location } from 'history';
import { useCallback, useEffect, useRef, useState } from 'react';

import { ViewTransition } from '../../../types/global';
import { LocationState } from '../../shared/ipc-types';
import { useAppContext } from '../context';
import { TransitionType, useHistory } from '../lib/history';
import { getReduceMotion } from './functions';
import { useEffectEvent } from './utility-hooks';

type QueueItem = { location: Location<LocationState>; transition: TransitionType };

const TRANSITION_DURATION = 450;

const viewTransitionRef: { current?: ViewTransition } = {};

export function useAfterTransition() {
  const runAfterTransition = useCallback((fn: () => void) => {
    if (viewTransitionRef.current) {
      void viewTransitionRef.current.finished.then(() => runAfterTransition(fn));
    } else {
      fn();
    }
  }, []);

  return runAfterTransition;
}

export function useViewTransitions(onTransition?: () => void): Location<LocationState> {
  const history = useHistory();
  const [currentLocation, setCurrentLocation] = useState(history.location);
  const queuedLocationRef = useRef<QueueItem>(undefined);
  const { setNavigationHistory } = useAppContext();

  const updateView = useEffectEvent((location: Location<LocationState>) => {
    setCurrentLocation(location);
    setNavigationHistory(history.asObject);
  });

  const onTransitionEnd = useEffectEvent((location: Location<LocationState>) => {
    if (window.env.e2e) {
      window.e2e.location = location.pathname;
    }

    onTransition?.();
  });

  const transitionToView = useEffectEvent(
    (location: Location<LocationState>, transition: TransitionType) => {
      if (getReduceMotion()) {
        updateView(location);
        setTimeout(() => onTransitionEnd(location));
        return;
      }

      viewTransitionRef.current = document.startViewTransition(() => {
        updateView(location);
      });

      void viewTransitionRef.current.ready.then(() => animateNavigation(transition));
      void viewTransitionRef.current.finished.then(() => {
        const queueLocation = queuedLocationRef.current;

        delete viewTransitionRef.current;
        delete queuedLocationRef.current;

        if (queueLocation) {
          transitionToView(queueLocation.location, queueLocation.transition);
        } else {
          onTransitionEnd?.(location);
        }
      });
    },
  );

  useEffect(() => {
    // React throttles updates, so it's impossible to capture the intermediate navigation without
    // listening to the history directly.
    const unobserveHistory = history.listen((location, _, transition) => {
      if (viewTransitionRef.current === undefined) {
        transitionToView(location, transition);
      } else {
        queuedLocationRef.current = { location, transition };
      }
    });

    return () => {
      unobserveHistory?.();
    };
    // These lint rules are disabled for now because the react plugin for eslint does
    // not understand that useEffectEvent should not be added to the dependency array.
    // Enable these rules again when eslint can lint useEffectEvent properly.
    // eslint-disable-next-line react-compiler/react-compiler
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [history]);

  return currentLocation;
}

function animateNavigation(transition: TransitionType) {
  const oldInFront = transition === TransitionType.dismiss || transition === TransitionType.pop;
  const oldZIndex = oldInFront ? 2 : 0;

  document.documentElement.animate(
    [
      { transform: 'translate(0%, 0%)', zIndex: oldZIndex },
      { transform: oldToTransform[transition], zIndex: oldZIndex },
    ],
    {
      duration: TRANSITION_DURATION,
      easing: 'ease-in-out',
      pseudoElement: '::view-transition-old(root)',
    },
  );
  document.documentElement.animate(
    [{ transform: newFromTransform[transition] }, { transform: 'translate(0%, 0%)' }],
    {
      duration: TRANSITION_DURATION,
      easing: 'ease-in-out',
      pseudoElement: '::view-transition-new(root)',
    },
  );
}

const oldToTransform = {
  [TransitionType.show]: 'translateY(0%)',
  [TransitionType.dismiss]: 'translateY(100%)',
  [TransitionType.push]: 'translateX(-33%)',
  [TransitionType.pop]: 'translateX(100%)',
  [TransitionType.none]: '',
};

const newFromTransform = {
  [TransitionType.show]: 'translateY(100%)',
  [TransitionType.dismiss]: 'translateY(0%)',
  [TransitionType.push]: 'translateX(100%)',
  [TransitionType.pop]: 'translateX(-33%)',
  [TransitionType.none]: '',
};