Skip to main content

Class: FakeMouseEvent

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

Internal

Fake mouse event used internally by DOMInteractor to synthesize positioned mouse events in jsdom. Exported for cross-package reuse within the monorepo, not part of the stable 1.0 consumer API.

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:10

Parameters

type

string

overrides?

Partial<MouseEvent> = {}

Returns

FakeMouseEvent

Overrides

MouseEvent.constructor

Properties

altKey

readonly altKey: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25020

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.

Inherited from

MouseEvent.altKey

AT_TARGET

readonly AT_TARGET: 2

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14273

Inherited from

MouseEvent.AT_TARGET

bubbles

readonly bubbles: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14164

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

Inherited from

MouseEvent.bubbles

BUBBLING_PHASE

readonly BUBBLING_PHASE: 3

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14274

Inherited from

MouseEvent.BUBBLING_PHASE

button

readonly button: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25026

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

Inherited from

MouseEvent.button

buttons

readonly buttons: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25032

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

Inherited from

MouseEvent.buttons

cancelable

readonly cancelable: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14177

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.

Inherited from

MouseEvent.cancelable

cancelBubble

cancelBubble: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14171

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

Deprecated

Inherited from

MouseEvent.cancelBubble

CAPTURING_PHASE

readonly CAPTURING_PHASE: 1

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14272

Inherited from

MouseEvent.CAPTURING_PHASE

clientX

readonly clientX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25038

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).

Inherited from

MouseEvent.clientX

clientY

readonly clientY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25044

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).

Inherited from

MouseEvent.clientY

composed

readonly composed: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14183

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

Inherited from

MouseEvent.composed

ctrlKey

readonly ctrlKey: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25050

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.

Inherited from

MouseEvent.ctrlKey

currentTarget

readonly currentTarget: EventTarget | null

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14189

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

Inherited from

MouseEvent.currentTarget

defaultPrevented

readonly defaultPrevented: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14195

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.

Inherited from

MouseEvent.defaultPrevented

detail

readonly detail: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:37281

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

Inherited from

MouseEvent.detail

eventPhase

readonly eventPhase: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14201

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

Inherited from

MouseEvent.eventPhase

isTrusted

readonly isTrusted: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14207

The isTrusted read-only property of the Event interface is a boolean value that is true 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 EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

Inherited from

MouseEvent.isTrusted

layerX

readonly layerX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25056

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

Inherited from

MouseEvent.layerX

layerY

readonly layerY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25062

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

Inherited from

MouseEvent.layerY

metaKey

readonly metaKey: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25068

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.

Inherited from

MouseEvent.metaKey

movementX

readonly movementX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25074

The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse (or pointer) between the given move event and the previous move event of the same type.

Inherited from

MouseEvent.movementX

movementY

readonly movementY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25080

The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse (or pointer) between the given move event and the previous move event of the same type.

Inherited from

MouseEvent.movementY

NONE

readonly NONE: 0

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14271

Inherited from

MouseEvent.NONE

offsetX

readonly offsetX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25086

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.

Inherited from

MouseEvent.offsetX

offsetY

readonly offsetY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25092

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.

Inherited from

MouseEvent.offsetY

pageX

readonly pageX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25098

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. This includes any portion of the document not currently visible.

Inherited from

MouseEvent.pageX

pageY

readonly pageY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25104

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. This includes any portion of the document not currently visible.

Inherited from

MouseEvent.pageY

relatedTarget

readonly relatedTarget: EventTarget | null

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25110

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

Inherited from

MouseEvent.relatedTarget

returnValue

returnValue: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14214

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

Deprecated

Inherited from

MouseEvent.returnValue

screenX

readonly screenX: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25116

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

Inherited from

MouseEvent.screenX

screenY

readonly screenY: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25122

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

Inherited from

MouseEvent.screenY

shiftKey

readonly shiftKey: boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25128

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.

Inherited from

MouseEvent.shiftKey

srcElement

readonly srcElement: EventTarget | null

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14221

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

Deprecated

Inherited from

MouseEvent.srcElement

target

readonly target: EventTarget | null

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14227

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

Inherited from

MouseEvent.target

timeStamp

readonly timeStamp: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14233

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

Inherited from

MouseEvent.timeStamp

type

readonly type: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14239

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

Inherited from

MouseEvent.type

view

readonly view: Window | null

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:37287

The UIEvent.view read-only property returns the WindowProxy object from which the event was generated. In browsers, this is the Window object the event happened in.

Inherited from

MouseEvent.view

which

readonly which: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:37294

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

Inherited from

MouseEvent.which

x

readonly x: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25134

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

Inherited from

MouseEvent.x

y

readonly y: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25140

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

Inherited from

MouseEvent.y

Methods

composedPath()

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14245

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. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

Returns

EventTarget[]

Inherited from

MouseEvent.composedPath

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.webworker.d.ts:4378

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. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

Returns

EventTarget[]

Inherited from

MouseEvent.composedPath

getModifierState()

getModifierState(keyArg): boolean

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25146

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.

Parameters

keyArg

string

Returns

boolean

Inherited from

MouseEvent.getModifierState

initEvent()

Call Signature

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

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14252

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

Inherited from

MouseEvent.initEvent

Call Signature

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

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.webworker.d.ts:4385

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

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@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:25153

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

Inherited from

MouseEvent.initMouseEvent

initUIEvent()

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

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:37301

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

Inherited from

MouseEvent.initUIEvent

preventDefault()

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14258

The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

Returns

void

Inherited from

MouseEvent.preventDefault

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.webworker.d.ts:4391

The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

Returns

void

Inherited from

MouseEvent.preventDefault

stopImmediatePropagation()

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14264

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

Returns

void

Inherited from

MouseEvent.stopImmediatePropagation

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.webworker.d.ts:4397

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

Returns

void

Inherited from

MouseEvent.stopImmediatePropagation

stopPropagation()

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14270

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

Returns

void

Inherited from

MouseEvent.stopPropagation

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.webworker.d.ts:4403

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

Returns

void

Inherited from

MouseEvent.stopPropagation