API Reference / @gtkx/testing / RenderOptions

Type Alias: RenderOptions<Q>

RenderOptions<Q> = object

Defined in: types.d.ts:78

Options for render: the container and base element to mount into, an optional wrapper, React behavior toggles, error callbacks, and custom queries to bind.

Type Parameters

Q

Q extends QueryMap = Record<never, never>

Properties

animations?

optional animations?: boolean

Defined in: types.d.ts:86

Enable widget animations during the test.

---

baseElement?

optional baseElement?: Container

Defined in: types.d.ts:81

Root of the subtree that bound queries search.

---

container?

optional container?: Gtk.Widget | RootElement

Defined in: types.d.ts:79

---

onCaughtError?

optional onCaughtError?: (error, errorInfo) => void

Defined in: types.d.ts:88

Called for errors caught by React error boundaries.

Parameters

error

unknown

errorInfo

ErrorInfo

Returns

void

---

onRecoverableError?

optional onRecoverableError?: (error, errorInfo) => void

Defined in: types.d.ts:90

Called for errors React recovered from automatically.

Parameters

error

unknown

errorInfo

ErrorInfo

Returns

void

---

queries?

optional queries?: Q

Defined in: types.d.ts:92

Custom queries to bind to the rendered result.

---

reactStrictMode?

optional reactStrictMode?: boolean

Defined in: types.d.ts:84

Render inside React StrictMode.

---

wrapper?

optional wrapper?: WrapperComponent

Defined in: types.d.ts:82