Class: FakeMouseEvent

Defined in: packages/dom-core/src/fakeEvents/FakeMouseEvent.ts:5

Fake mouse event for testing.

See

https://github.com/testing-library/react-testing-library/issues/268

Extends

• MouseEvent

Constructors

Constructor

new FakeMouseEvent(type, overrides): FakeMouseEvent

Defined in: packages/dom-core/src/fakeEvents/FakeMouseEvent.ts:6

Parameters

type

string

overrides

Partial<MouseEvent> = {}

Returns

FakeMouseEvent

Overrides

MouseEvent.constructor

Properties

altKey

readonly altKey: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20935

The MouseEvent.altKey read-only property is a boolean value that indicates whether the alt key was pressed or not when a given mouse event occurs.

MDN Reference

Inherited from

MouseEvent.altKey

---

AT_TARGET

readonly AT_TARGET: 2

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11462

Inherited from

MouseEvent.AT_TARGET

---

bubbles

readonly bubbles: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11353

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

Inherited from

MouseEvent.bubbles

---

BUBBLING_PHASE

readonly BUBBLING_PHASE: 3

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11463

Inherited from

MouseEvent.BUBBLING_PHASE

---

button

readonly button: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20941

The MouseEvent.button read-only property indicates which button was pressed or released on the mouse to trigger the event.

MDN Reference

Inherited from

MouseEvent.button

---

buttons

readonly buttons: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20947

The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.

MDN Reference

Inherited from

MouseEvent.buttons

---

cancelable

readonly cancelable: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11366

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

Inherited from

MouseEvent.cancelable

---

cancelBubble

cancelBubble: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11360

The cancelBubble property of the Event interface is deprecated.

Deprecated

MDN Reference

Inherited from

MouseEvent.cancelBubble

---

CAPTURING_PHASE

readonly CAPTURING_PHASE: 1

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11461

Inherited from

MouseEvent.CAPTURING_PHASE

---

clientX

readonly clientX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20953

The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

Inherited from

MouseEvent.clientX

---

clientY

readonly clientY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20959

The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

Inherited from

MouseEvent.clientY

---

composed

readonly composed: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11372

The read-only composed property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

Inherited from

MouseEvent.composed

---

ctrlKey

readonly ctrlKey: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20965

The MouseEvent.ctrlKey read-only property is a boolean value that indicates whether the ctrl key was pressed or not when a given mouse event occurs.

MDN Reference

Inherited from

MouseEvent.ctrlKey

---

currentTarget

readonly currentTarget: EventTarget | null

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11378

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

Inherited from

MouseEvent.currentTarget

---

defaultPrevented

readonly defaultPrevented: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11384

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

Inherited from

MouseEvent.defaultPrevented

---

detail

readonly detail: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:32607

The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.

MDN Reference

Inherited from

MouseEvent.detail

---

eventPhase

readonly eventPhase: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11390

The eventPhase read-only property of the being evaluated.

MDN Reference

Inherited from

MouseEvent.eventPhase

---

isTrusted

readonly isTrusted: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11396

The isTrusted read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

Inherited from

MouseEvent.isTrusted

---

layerX

readonly layerX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20971

The MouseEvent.layerX read-only property returns the horizontal coordinate of the event relative to the current layer.

MDN Reference

Inherited from

MouseEvent.layerX

---

layerY

readonly layerY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20977

The MouseEvent.layerY read-only property returns the vertical coordinate of the event relative to the current layer.

MDN Reference

Inherited from

MouseEvent.layerY

---

metaKey

readonly metaKey: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20983

The MouseEvent.metaKey read-only property is a boolean value that indicates whether the meta key was pressed or not when a given mouse event occurs.

MDN Reference

Inherited from

MouseEvent.metaKey

---

movementX

readonly movementX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20989

The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous Element/mousemove_event event.

MDN Reference

Inherited from

MouseEvent.movementX

---

movementY

readonly movementY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:20995

The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous Element/mousemove_event event.

MDN Reference

Inherited from

MouseEvent.movementY

---

NONE

readonly NONE: 0

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11460

Inherited from

MouseEvent.NONE

---

offsetX

readonly offsetX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21001

The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

Inherited from

MouseEvent.offsetX

---

offsetY

readonly offsetY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21007

The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

Inherited from

MouseEvent.offsetY

---

pageX

readonly pageX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21013

The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document.

MDN Reference

Inherited from

MouseEvent.pageX

---

pageY

readonly pageY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21019

The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate (in pixels) at which the mouse was clicked, relative to the top edge of the entire document.

MDN Reference

Inherited from

MouseEvent.pageY

---

relatedTarget

readonly relatedTarget: EventTarget | null

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21025

The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.

MDN Reference

Inherited from

MouseEvent.relatedTarget

---

returnValue

returnValue: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11403

The Event property returnValue indicates whether the default action for this event has been prevented or not.

Deprecated

MDN Reference

Inherited from

MouseEvent.returnValue

---

screenX

readonly screenX: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21031

The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

Inherited from

MouseEvent.screenX

---

screenY

readonly screenY: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21037

The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

Inherited from

MouseEvent.screenY

---

shiftKey

readonly shiftKey: boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21043

The MouseEvent.shiftKey read-only property is a boolean value that indicates whether the shift key was pressed or not when a given mouse event occurs.

MDN Reference

Inherited from

MouseEvent.shiftKey

---

srcElement

readonly srcElement: EventTarget | null

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11410

The deprecated Event.srcElement is an alias for the Event.target property.

Deprecated

MDN Reference

Inherited from

MouseEvent.srcElement

---

target

readonly target: EventTarget | null

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11416

The read-only target property of the dispatched.

MDN Reference

Inherited from

MouseEvent.target

---

timeStamp

readonly timeStamp: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11422

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

Inherited from

MouseEvent.timeStamp

---

type

readonly type: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11428

The type read-only property of the Event interface returns a string containing the event's type.

MDN Reference

Inherited from

MouseEvent.type

---

view

readonly view: Window | null

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:32613

The UIEvent.view read-only property returns the is the Window object the event happened in.

MDN Reference

Inherited from

MouseEvent.view

---

which

readonly which: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:32620

The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.

Deprecated

MDN Reference

Inherited from

MouseEvent.which

---

x

readonly x: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21049

The MouseEvent.x property is an alias for the MouseEvent.clientX property.

MDN Reference

Inherited from

MouseEvent.x

---

y

readonly y: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21055

The MouseEvent.y property is an alias for the MouseEvent.clientY property.

MDN Reference

Inherited from

MouseEvent.y

Methods

composedPath()

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11434

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

MDN Reference

Returns

EventTarget[]

Inherited from

MouseEvent.composedPath

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.webworker.d.ts:3892

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

MDN Reference

Returns

EventTarget[]

Inherited from

MouseEvent.composedPath

---

getModifierState()

getModifierState(keyArg): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21061

The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.

MDN Reference

Parameters

keyArg

string

Returns

boolean

Inherited from

MouseEvent.getModifierState

---

initEvent()

Call Signature

initEvent(type, bubbles?, cancelable?): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11441

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

Parameters

type

string

bubbles?

boolean

cancelable?

boolean

Returns

void

Deprecated

MDN Reference

Inherited from

MouseEvent.initEvent

Call Signature

initEvent(type, bubbles?, cancelable?): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.webworker.d.ts:3899

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

Parameters

type

string

bubbles?

boolean

cancelable?

boolean

Returns

void

Deprecated

MDN Reference

Inherited from

MouseEvent.initEvent

---

initMouseEvent()

initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:21068

The MouseEvent.initMouseEvent() method initializes the value of a mouse event once it's been created (normally using the Document.createEvent() method).

Parameters

typeArg

string

canBubbleArg

boolean

cancelableArg

boolean

viewArg

Window

detailArg

number

screenXArg

number

screenYArg

number

clientXArg

number

clientYArg

number

ctrlKeyArg

boolean

altKeyArg

boolean

shiftKeyArg

boolean

metaKeyArg

boolean

buttonArg

number

relatedTargetArg

EventTarget | null

Returns

void

Deprecated

MDN Reference

Inherited from

MouseEvent.initMouseEvent

---

initUIEvent()

initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:32627

The UIEvent.initUIEvent() method initializes a UI event once it's been created.

Parameters

typeArg

string

bubblesArg?

boolean

cancelableArg?

boolean

viewArg?

Window | null

detailArg?

number

Returns

void

Deprecated

MDN Reference

Inherited from

MouseEvent.initUIEvent

---

preventDefault()

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11447

The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

MDN Reference

Returns

void

Inherited from

MouseEvent.preventDefault

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.webworker.d.ts:3905

The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

MDN Reference

Returns

void

Inherited from

MouseEvent.preventDefault

---

stopImmediatePropagation()

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11453

The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

MDN Reference

Returns

void

Inherited from

MouseEvent.stopImmediatePropagation

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.webworker.d.ts:3911

The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

MDN Reference

Returns

void

Inherited from

MouseEvent.stopImmediatePropagation

---

stopPropagation()

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.dom.d.ts:11459

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

MDN Reference

Returns

void

Inherited from

MouseEvent.stopPropagation

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.webworker.d.ts:3917

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

MDN Reference

Returns

void

Inherited from

MouseEvent.stopPropagation