# All files / src/test-utils matchMedia.ts

99.49% Statements 197/198
94.11% Branches 16/17
91.66% Functions 11/12
99.49% Lines 197/198

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    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
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    1991x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1464x
    1464x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    25x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    8x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1528x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    7x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    4x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    4x
    4x
    4x
    4x
    4x
    4x
    4x
    4x
    60x
    60x
    1x
    1x
    1x
    1x
    1x
    26x
    26x
    26x
    60x
    26x
    26x
    26x
    1x
    1x
    1x
    1x
    1x
    26x
    26x
    26x
    60x
    60x
    4x
    4x
    12x
    12x
    12x
    12x
    12x
    12x
    12x
    12x
    45x
    45x
    45x
    45x
    45x
    45x
    12x
    12x

    12x
    12x
    12x
    12x
    4x
    4x
    4x
    4x
    4x
    4x
     import { jest } from "@jest/globals";
    import { act } from "@testing-library/react";
    import {
      DEFAULT_DESKTOP_LARGE_MIN_WIDTH,
      DEFAULT_DESKTOP_MIN_WIDTH,
      DEFAULT_PHONE_MAX_WIDTH,
      DEFAULT_TABLET_MIN_WIDTH,
    } from "../media-queries/appSize.js";

    const noop = (): void => {
      // do nothing
    };

    /**
     * @see {@link spyOnMatchMedia} instead
     * @internal
     * @remarks \@since 6.0.0
     */
    export const BASE_MEDIA_QUERY_LIST: MediaQueryList = {
      media: "",
      matches: false,
      onchange: noop,
      addListener: noop,
      addEventListener: noop,
      removeEventListener: noop,
      removeListener: noop,
      dispatchEvent: () => false,
    };

    /** @remarks \@since 6.0.0 */
    export type MatchMediaMatcher = (query: string) => boolean;

    /**
     * @see {@link spyOnMatchMedia} for usage
     * @remarks \@since 6.0.0
     * @returns `true` for phone media queries
     */
    export const matchPhone: MatchMediaMatcher = (query) =>
      query.includes(`${DEFAULT_PHONE_MAX_WIDTH}`);

    /**
     * @see {@link spyOnMatchMedia} for usage
     * @remarks \@since 6.0.0
     * @returns `true` for tablet media queries
     */
    export const matchTablet: MatchMediaMatcher = (query) =>
      query.includes(`${DEFAULT_TABLET_MIN_WIDTH}`);

    /**
     * @see {@link spyOnMatchMedia} for usage
     * @remarks \@since 6.0.0
     * @returns `true` for desktop media queries
     */
    export const matchDesktop: MatchMediaMatcher = (query) =>
      query.includes(`${DEFAULT_DESKTOP_MIN_WIDTH}`);

    /**
     * @see {@link spyOnMatchMedia} for usage
     * @remarks \@since 6.0.0
     * @returns `true` for large desktop media queries
     */
    export const matchLargeDesktop: MatchMediaMatcher = (query) =>
      query.includes(`${DEFAULT_DESKTOP_LARGE_MIN_WIDTH}`);

    /**
     * @see {@link spyOnMatchMedia} for usage
     * @remarks \@since 6.0.0
     * @returns `true` for both desktop and large desktop media queries
     */
    export const matchAnyDesktop: MatchMediaMatcher = (query) =>
      matchDesktop(query) || matchLargeDesktop(query);

    /**
     * @remarks \@since 6.0.0
     */
    export type MatchMediaSpiedFunction = jest.SpiedFunction<
      typeof window.matchMedia
    > & {
      /**
       * @example
       * Default Behavior
       * ```tsx
       * const matchMedia = spyOnMatchMedia();
       * render(<Test />);
       *
       * // expect desktop results
       *
       * matchMedia.changeViewport(matchPhone);
       * // expect phone results
       * ```
       *
       * @example
       * Custom Act Behavior
       * ```tsx
       * const matchMedia = spyOnMatchMedia();
       * const { rerender } = render(<Test />);
       *
       * // expect desktop results
       *
       * matchMedia.changeViewport(matchPhone, false);
       * rerender(<Test key="new-key" />);
       *
       * // expect phone results
       * ```
       */
      changeViewport(matcher: MatchMediaMatcher, disableAct?: boolean): void;
    };

    /**
     * @example
     * Default Behavior
     * ```tsx
     * import { matchPhone, render, spyOnMatchMedia } from "@react-md/test-utils";
     *
     * const matchMedia = spyOnMatchMedia();
     * render(<Test />);
     *
     * // expect desktop results
     *
     * matchMedia.changeViewport(matchPhone);
     * // expect phone results
     * ```
     *
     * @example
     * Set Default Media
     * ```tsx
     * import { matchPhone, render, spyOnMatchMedia } from "@react-md/test-utils";
     *
     * const matchMedia = spyOnMatchMedia(matchPhone);
     * render(<Test />);
     *
     * // expect phone results
     * ```
     *
     * @remarks \@since 6.0.0
     */
    export function spyOnMatchMedia(
      defaultMatch: MatchMediaMatcher = matchDesktop
    ): MatchMediaSpiedFunction {
      type Listener = (event: MediaQueryListEvent) => void;

      const listeners = new Map<string, Listener>();
      const matchMedia = jest
        .spyOn(window, "matchMedia")
        .mockImplementation((query) => ({
          ...BASE_MEDIA_QUERY_LIST,
          addEventListener(type: string, listener: Listener | EventListenerObject) {
            /* c8 ignore start */
            if (typeof listener !== "function" || type !== "change") {
              return;
            }
            /* c8 ignore stop */

            listeners.set(query, listener);
          },
          removeEventListener(
            type: string,
            listener: Listener | EventListenerObject
          ) {
            /* c8 ignore start */
            if (typeof listener !== "function" || type !== "change") {
              return;
            }
            /* c8 ignore stop */

            listeners.delete(query);
          },
          matches: defaultMatch(query),
        }));

      const changeViewport = (
        matcher: MatchMediaMatcher,
        disableAct = false
      ): void => {
        const update = (): void => {
          window.dispatchEvent(new Event("resize"));

          const event = new Event("change");
          listeners.forEach((listener, query) => {
            listener({
              ...event,
              media: "",
              matches: matcher(query),
            });
          });
        };
        if (disableAct) {
          update();
        } else {
          act(update);
        }
      };

      const mock = matchMedia as MatchMediaSpiedFunction;
      mock.changeViewport = changeViewport;

      return mock;
    }