GTKX

API Reference / @gtkx/testing / RenderResult

Type Alias: RenderResult<Q> ​

RenderResult<Q> = BoundQueries & BoundCustomQueries<Q> & DebugUtilities & object

Defined in: packages/testing/src/bound-queries.ts:23

The result of a render call: queries scoped to the rendered tree, debug utilities, and controls for updating or tearing down the render.

Type Declaration ​

baseElement ​

baseElement: Container

The root the queries are scoped to (defaults to all toplevels).

container ​

container: Gtk.Widget

The top-level widget the element was rendered into.

rerender ​

rerender: (element) => Promise<void>

Re-renders the tree with a new element, reusing the same root.

Parameters ​

element ​

ReactNode

Returns ​

Promise<void>

unmount ​

unmount: () => Promise<void>

Unmounts the rendered tree and disposes its resources.

Returns ​

Promise<void>

Type Parameters ​

Q ​

Q extends QueryMap = Record<never, never>

Custom queries provided at render time, merged with the built-in ones.