GTKX

API Reference / @gtkx/testing / UserEvent

Type Alias: UserEvent ​

UserEvent = object

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

User interactions exposed by userEvent.

Properties ​

clear ​

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

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

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, ...args) => Promise<void>

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

Activates or presses and releases a widget.

Parameters ​

widget ​

Gtk.Accessible

args ​

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

Returns ​

Promise<void>

copy ​

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

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

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

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, ...args) => Promise<void>

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

Delivers a double-click gesture.

Parameters ​

widget ​

Gtk.Accessible

args ​

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

Returns ​

Promise<void>

deselectOptions ​

deselectOptions: typeof deselectOptions

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

Unselects positions without activating them.

drag ​

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

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

Runs a begin, update, and end sequence on the widget's drag gestures, 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:123

Requires a drag source on the source widget, then emits drop with the content on the target's drop targets.

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

Emits drop with the given content on the widget's drop targets.

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

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: (widget, input) => Promise<void>

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

Sends a key sequence through GTK's propagation chain.

Parameters ​

widget ​

Gtk.Accessible

input ​

string

Returns ​

Promise<void>

longPress ​

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

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

Emits pressed at the given point on the widget's long-press gestures.

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

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

Applies a pointer token 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:93

Emits angle-changed on the widget's rotate gestures.

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

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

Selects positions without activating them.

setup ​

setup: (options?) => UserEvent

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

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

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

Emits swipe with the given velocity on the widget's swipe gestures.

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

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, ...args) => Promise<void>

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

Delivers a triple-click gesture.

Parameters ​

widget ​

Gtk.Accessible

args ​

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

Returns ​

Promise<void>

type ​

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

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

Types into an editable widget.

Parameters ​

widget ​

Gtk.Accessible

args ​

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

Returns ​

Promise<void>

unhover ​

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

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

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

Emits scale-changed on the widget's zoom gestures.

Parameters ​

widget ​

Gtk.Accessible

args ​

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

Returns ​

Promise<void>