Skip to content

API Reference / @gtkx/testing / UserEvent

Type Alias: UserEvent ​

UserEvent = object

Defined in: packages/testing/src/user-event/index.ts:21

User interactions exposed by userEvent.

Properties ​

clear ​

clear: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:42

Deletes all text from an editable widget.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof clear> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


click ​

click: (widget) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:25

Activates or presses and releases a widget.

Parameters ​

widget ​

Gtk.Accessible

Returns ​

Promise<void>


copy ​

copy: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:47

Copies the current selection.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof copy> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


cut ​

cut: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:52

Cuts the current selection.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof cut> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


dblClick ​

dblClick: (widget) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:27

Delivers a double-click gesture.

Parameters ​

widget ​

Gtk.Accessible

Returns ​

Promise<void>


deselectOptions ​

deselectOptions: typeof deselectOptions

Defined in: packages/testing/src/user-event/index.ts:64

Unselects positions without activating them.


drag ​

drag: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:99

Runs a begin, update, and end sequence on the drag gestures of the widget or its nearest ancestor that has one, ending at the given offset.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof drag> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


dragAndDrop ​

dragAndDrop: (source, target, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:112

Begins a drag from the drag sources of the source widget or its nearest ancestor that has one, then emits drop with the content on the drop targets of the target widget or its nearest ancestor that has one.

Parameters ​

source ​

Gtk.Accessible

target ​

Gtk.Accessible

args ​

...Parameters<typeof dragAndDrop> extends [Gtk.Widget, Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


drop ​

drop: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:104

Emits drop with the given content on the drop targets of the widget or its nearest ancestor that has one.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof drop> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


hover ​

hover: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:66

Emits a motion enter on the widget, adding a motion controller when it has none.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof hover> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


keyboard ​

keyboard: {(input): Promise<void>; (widget, input): Promise<void>; }

Defined in: packages/testing/src/user-event/index.ts:132

Sends a key sequence through GTK's propagation chain, to the given widget or, without one, to the focused widget of the active window. A given widget that can take focus, or passes it to a child as a menu button does to its button, is focused first unless the focus is already inside it.

Call Signature ​

(input): Promise<void>

Parameters ​
input ​

string

Returns ​

Promise<void>

Call Signature ​

(widget, input): Promise<void>

Parameters ​
widget ​

Accessible

input ​

string

Returns ​

Promise<void>


longPress ​

longPress: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:91

Emits pressed at the given point on the long-press gestures of the widget or its nearest ancestor that has one.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof longPress> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


paste ​

paste: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:57

Pastes text or clipboard contents.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof paste> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


pointer ​

pointer: (widget, input) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:137

Applies a pointer token, such as [MouseLeft] or [MouseRight>], while preserving held-button state.

Parameters ​

widget ​

Gtk.Accessible

input ​

PointerInput

Returns ​

Promise<void>


rotate ​

rotate: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:76

Emits angle-changed on the rotate gestures of the widget or its nearest ancestor that has one.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof rotate> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


scroll ​

scroll: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:123

Adds the delta to the adjustments of the widget itself, or of its nearest scrollable ancestor.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof scroll> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


selectOptions ​

selectOptions: typeof selectOptions

Defined in: packages/testing/src/user-event/index.ts:62

Selects positions without activating them.


setup ​

setup: (options?) => UserEvent

Defined in: packages/testing/src/user-event/index.ts:23

Creates an instance with shared keyboard and pointer state.

Parameters ​

options? ​

UserEventOptions

Returns ​

UserEvent


slide ​

slide: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:118

Emits a jump change-value on a Gtk.Range so it moves to the given value.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof slide> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


swipe ​

swipe: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:86

Emits swipe with the given velocity on the swipe gestures of the widget or its nearest ancestor that has one.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof swipe> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


tab ​

tab: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:31

Moves focus forward or backward within the root.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof tab> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


tripleClick ​

tripleClick: (widget) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:29

Delivers a triple-click gesture.

Parameters ​

widget ​

Gtk.Accessible

Returns ​

Promise<void>


type ​

type: (widget, text, options?) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:40

Types into an editable widget, inserting each character as its own edit. Keys named in braces, such as {Enter}, {Backspace} or {Tab}, are pressed as keyboard presses them, and a doubled opening brace types a literal {. Once a key moves focus out of the widget, as {Tab} does, the rest of the text goes to the newly focused widget.

Parameters ​

widget ​

Gtk.Accessible

text ​

string

options? ​

TypeOptions

Returns ​

Promise<void>


unhover ​

unhover: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:71

Emits a motion leave on the widget, adding a motion controller when it has none.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof unhover> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>


zoom ​

zoom: (widget, ...args) => Promise<void>

Defined in: packages/testing/src/user-event/index.ts:81

Emits scale-changed on the zoom gestures of the widget or its nearest ancestor that has one.

Parameters ​

widget ​

Gtk.Accessible

args ​

...Parameters<typeof zoom> extends [Gtk.Widget, ...(infer Args)] ? Args : never

Returns ​

Promise<void>