All files / dom-event-testing-library/src domEvents.js

77.05% Statements 47/61
73.53% Branches 75/102
82.22% Functions 37/45
77.05% Lines 47/61

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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450                                                                                                                        19x   19x                         19x 2x     19x                                                               432x   432x                                                                                                                                 131x 131x   131x                                                                                     121x                           13x       33x             3x             1x                     101x       101x       8x       8x       17x       2x               8x           71x   71x   71x               70x       15x       75x                 17x       95x       50x                                               10x 10x                 22x       15x       20x               16x       22x       10x                 19x       2x       3x       1x       36x       21x       63x       2x                                
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
'use strict';
 
import createEvent from './createEvent';
import { buttonType, buttonsType, defaultPointerSize, defaultBrowserChromeSize } from './constants';
 
/**
 * Native event object mocks for higher-level events.
 *
 * 1. Each event type defines the exact object that it accepts. This ensures
 * that no arbitrary properties can be assigned to events, and the properties
 * that don't exist on specific event types (e.g., 'pointerType') are not added
 * to the respective native event.
 *
 * 2. Properties that cannot be relied on due to inconsistent browser support (e.g., 'x' and 'y') are not
 * added to the native event. Others that shouldn't be arbitrarily customized (e.g., 'screenX')
 * are automatically inferred from associated values.
 *
 * 3. PointerEvent and TouchEvent fields are normalized (e.g., 'rotationAngle' -> 'twist')
 */
 
function emptyFunction() {}
 
function createGetModifierState(keyArg, data) {
  if (keyArg === 'Alt') {
    return data.altKey || false;
  }
  if (keyArg === 'Control') {
    return data.ctrlKey || false;
  }
  if (keyArg === 'Meta') {
    return data.metaKey || false;
  }
  if (keyArg === 'Shift') {
    return data.shiftKey || false;
  }
}
 
/**
 * KeyboardEvent
 */
 
function createKeyboardEvent(
  type,
  {
    altKey = false,
    ctrlKey = false,
    isComposing = false,
    key = '',
    metaKey = false,
    preventDefault = emptyFunction,
    shiftKey = false
  } = {}
) {
  const modifierState = { altKey, ctrlKey, metaKey, shiftKey };
 
  const eventPayload = {
    altKey,
    ctrlKey,
    getModifierState(keyArg) {
      return createGetModifierState(keyArg, modifierState);
    },
    isComposing,
    key,
    metaKey,
    preventDefault,
    shiftKey
  };
 
  if (isComposing) {
    eventPayload.keyCode = 229;
  }
 
  return createEvent(type, eventPayload);
}
 
/**
 * MouseEvent
 */
 
function createMouseEvent(
  type,
  {
    altKey = false,
    button = buttonType.none,
    buttons = buttonsType.none,
    ctrlKey = false,
    detail = 1,
    metaKey = false,
    movementX = 0,
    movementY = 0,
    offsetX = 0,
    offsetY = 0,
    pageX,
    pageY,
    preventDefault = emptyFunction,
    relatedTarget,
    screenX,
    screenY,
    shiftKey = false,
    timeStamp,
    x = 0,
    y = 0
  } = {}
) {
  const modifierState = { altKey, ctrlKey, metaKey, shiftKey };
 
  return createEvent(type, {
    altKey,
    button,
    buttons,
    clientX: x,
    clientY: y,
    ctrlKey,
    detail,
    getModifierState(keyArg) {
      return createGetModifierState(keyArg, modifierState);
    },
    metaKey,
    movementX,
    movementY,
    offsetX,
    offsetY,
    pageX: pageX || x,
    pageY: pageY || y,
    preventDefault,
    relatedTarget,
    screenX: screenX === 0 ? screenX : x,
    screenY: screenY === 0 ? screenY : y + defaultBrowserChromeSize,
    shiftKey,
    timeStamp
  });
}
 
/**
 * PointerEvent
 */
 
function createPointerEvent(
  type,
  {
    altKey = false,
    button = buttonType.none,
    buttons = buttonsType.none,
    ctrlKey = false,
    detail = 1,
    height,
    metaKey = false,
    movementX = 0,
    movementY = 0,
    offsetX = 0,
    offsetY = 0,
    pageX,
    pageY,
    pointerId,
    pressure = 0,
    preventDefault = emptyFunction,
    pointerType = 'mouse',
    relatedTarget,
    screenX,
    screenY,
    shiftKey = false,
    tangentialPressure = 0,
    tiltX = 0,
    tiltY = 0,
    timeStamp,
    twist = 0,
    width,
    x = 0,
    y = 0
  } = {}
) {
  const modifierState = { altKey, ctrlKey, metaKey, shiftKey };
  const isMouse = pointerType === 'mouse';
 
  return createEvent(type, {
    altKey,
    button,
    buttons,
    clientX: x,
    clientY: y,
    ctrlKey,
    detail,
    getModifierState(keyArg) {
      return createGetModifierState(keyArg, modifierState);
    },
    height: isMouse ? 1 : height != null ? height : defaultPointerSize,
    metaKey,
    movementX,
    movementY,
    offsetX,
    offsetY,
    pageX: pageX || x,
    pageY: pageY || y,
    pointerId,
    pointerType,
    pressure,
    preventDefault,
    relatedTarget,
    releasePointerCapture: emptyFunction,
    screenX: screenX === 0 ? screenX : x,
    screenY: screenY === 0 ? screenY : y + defaultBrowserChromeSize,
    setPointerCapture: emptyFunction,
    shiftKey,
    tangentialPressure,
    tiltX,
    tiltY,
    timeStamp,
    twist,
    width: isMouse ? 1 : width != null ? width : defaultPointerSize
  });
}
 
/**
 * TouchEvent
 */
 
function createTouchEvent(type, payload) {
  return createEvent(type, {
    ...payload,
    detail: 0,
    sourceCapabilities: {
      firesTouchEvents: true
    }
  });
}
 
/**
 * DOM events
 */
 
export function blur({ relatedTarget } = {}) {
  return createEvent('blur', { relatedTarget });
}
 
export function click(payload) {
  return createMouseEvent('click', {
    button: buttonType.primary,
    ...payload
  });
}
 
export function contextmenu(payload) {
  return createMouseEvent('contextmenu', {
    ...payload,
    detail: 0
  });
}
 
export function dragstart(payload) {
  return createMouseEvent('dragstart', {
    ...payload,
    detail: 0
  });
}
 
export function error() {
  return createEvent('error');
}
 
export function focus({ relatedTarget } = {}) {
  return createEvent('focus', { relatedTarget });
}
 
export function focusin({ relatedTarget } = {}) {
  return createEvent('focusin', { relatedTarget });
}
 
export function focusout({ relatedTarget } = {}) {
  return createEvent('focusout', { relatedTarget });
}
 
export function gotpointercapture(payload) {
  return createPointerEvent('gotpointercapture', payload);
}
 
export function keydown(payload) {
  return createKeyboardEvent('keydown', payload);
}
 
export function keyup(payload) {
  return createKeyboardEvent('keyup', payload);
}
 
export function load(payload) {
  return createEvent('load', payload);
}
 
export function lostpointercapture(payload) {
  return createPointerEvent('lostpointercapture', payload);
}
 
export function mousedown(payload) {
  // The value of 'button' and 'buttons' for 'mousedown' must not be none.
  const button =
    payload != null && payload.button !== buttonType.none ? payload.button : buttonType.primary;
  const buttons =
    payload != null && payload.buttons !== buttonsType.none ? payload.buttons : buttonsType.primary;
 
  return createMouseEvent('mousedown', {
    ...payload,
    button,
    buttons
  });
}
 
export function mouseenter(payload) {
  return createMouseEvent('mouseenter', payload);
}
 
export function mouseleave(payload) {
  return createMouseEvent('mouseleave', payload);
}
 
export function mousemove(payload) {
  return createMouseEvent('mousemove', {
    // 0 is also the uninitialized value (i.e., don't assume it means primary button down)
    button: 0,
    buttons: 0,
    ...payload
  });
}
 
export function mouseout(payload) {
  return createMouseEvent('mouseout', payload);
}
 
export function mouseover(payload) {
  return createMouseEvent('mouseover', payload);
}
 
export function mouseup(payload) {
  return createMouseEvent('mouseup', {
    button: buttonType.primary,
    ...payload,
    buttons: buttonsType.none
  });
}
export function pointercancel(payload) {
  return createPointerEvent('pointercancel', {
    ...payload,
    buttons: 0,
    detail: 0,
    height: 1,
    pageX: 0,
    pageY: 0,
    pressure: 0,
    screenX: 0,
    screenY: 0,
    width: 1,
    x: 0,
    y: 0
  });
}
 
export function pointerdown(payload) {
  const isTouch = payload != null && payload.pointerType === 'touch';
  return createPointerEvent('pointerdown', {
    button: buttonType.primary,
    buttons: buttonsType.primary,
    pressure: isTouch ? 1 : 0.5,
    ...payload
  });
}
 
export function pointerenter(payload) {
  return createPointerEvent('pointerenter', payload);
}
 
export function pointerleave(payload) {
  return createPointerEvent('pointerleave', payload);
}
 
export function pointermove(payload) {
  return createPointerEvent('pointermove', {
    ...payload,
    button: buttonType.none,
    buttons: buttonsType.none
  });
}
 
export function pointerout(payload) {
  return createPointerEvent('pointerout', payload);
}
 
export function pointerover(payload) {
  return createPointerEvent('pointerover', payload);
}
 
export function pointerup(payload) {
  return createPointerEvent('pointerup', {
    button: buttonType.primary,
    ...payload,
    buttons: buttonsType.none,
    pressure: 0
  });
}
 
export function scroll() {
  return createEvent('scroll', { bubbles: false });
}
 
export function select() {
  return createEvent('select');
}
 
export function selectionchange() {
  return createEvent('selectionchange');
}
 
export function touchcancel(payload) {
  return createTouchEvent('touchcancel', payload);
}
 
export function touchend(payload) {
  return createTouchEvent('touchend', payload);
}
 
export function touchmove(payload) {
  return createTouchEvent('touchmove', payload);
}
 
export function touchstart(payload) {
  return createTouchEvent('touchstart', payload);
}
 
export function virtualclick(payload) {
  return createMouseEvent('click', {
    button: 0,
    ...payload,
    buttons: 0,
    detail: 0,
    height: 1,
    pageX: 0,
    pageY: 0,
    pressure: 0,
    screenX: 0,
    screenY: 0,
    width: 1,
    x: 0,
    y: 0
  });
}