@gtkx/testing 0.13.2 → 0.14.0

package/README.md

@@ -1,18 +1,18 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/eugeniodepalo/gtkx/main/logo.svg" alt="GTKX" width="60" height="60">
+ <img src="https://raw.githubusercontent.com/eugeniodepalo/gtkx/main/logo.svg" alt="GTKX" width="60" height="60">
 </p>
 
 <h1 align="center">GTKX</h1>
 
 <p align="center">
-  <strong>Build native GTK4 desktop applications with React and TypeScript.</strong>
+ <strong>Build native GTK4 desktop applications with React and TypeScript.</strong>
 </p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/@gtkx/react"><img src="https://img.shields.io/npm/v/@gtkx/react.svg" alt="npm version"></a>
-  <a href="https://github.com/eugeniodepalo/gtkx/actions"><img src="https://img.shields.io/github/actions/workflow/status/eugeniodepalo/gtkx/ci.yml" alt="CI"></a>
-  <a href="https://github.com/eugeniodepalo/gtkx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License"></a>
-  <a href="https://github.com/eugeniodepalo/gtkx/discussions"><img src="https://img.shields.io/badge/discussions-GitHub-blue" alt="GitHub Discussions"></a>
+ <a href="https://www.npmjs.com/package/@gtkx/react"><img src="https://img.shields.io/npm/v/@gtkx/react.svg" alt="npm version"></a>
+ <a href="https://github.com/eugeniodepalo/gtkx/actions"><img src="https://img.shields.io/github/actions/workflow/status/eugeniodepalo/gtkx/ci.yml" alt="CI"></a>
+ <a href="https://github.com/eugeniodepalo/gtkx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License"></a>
+ <a href="https://github.com/eugeniodepalo/gtkx/discussions"><img src="https://img.shields.io/badge/discussions-GitHub-blue" alt="GitHub Discussions"></a>
 </p>
 
 ---
@@ -80,10 +80,11 @@ render(<App />, "com.example.counter");
 
 Explore complete applications in the [`examples/`](./examples) directory:
 
+- **[browser](./examples/browser)** — Simple browser using WebKitWebView
 - **[gtk-demo](./examples/gtk-demo)** — Full replica of the official GTK demo app
 - **[hello-world](./examples/hello-world)** — Minimal application showing a counter
 - **[todo](./examples/todo)** — Full-featured todo application with Adwaita styling and testing
-- **[x-showcase](./examples/x-showcase)** — Showcase of all x.* virtual components
+- **[x-showcase](./examples/x-showcase)** — Showcase of all x.\* virtual components
 - **[deploying](./examples/deploying)** — Example of packaging and distributing a GTKX app
 
 ## Documentation

package/dist/fire-event.d.ts

@@ -1,23 +1,27 @@
 import type * as Gtk from "@gtkx/ffi/gtk";
 import type { Arg } from "@gtkx/native";
 /**
- * Emits a GTK signal on a widget.
+ * Emits a GTK signal on a widget or event controller.
  *
  * Low-level utility for triggering signals directly. Prefer {@link userEvent}
  * for common interactions like clicking and typing.
  *
- * @param element - The widget to emit the signal on
- * @param signalName - GTK signal name (e.g., "clicked", "activate")
+ * @param element - The widget or event controller to emit the signal on
+ * @param signalName - GTK signal name (e.g., "clicked", "activate", "drag-begin")
  * @param args - Additional signal arguments
  *
  * @example
  * ```tsx
  * import { fireEvent } from "@gtkx/testing";
  *
- * // Emit custom signal
- * await fireEvent(widget, "my-custom-signal");
+ * // Emit signal on widget
+ * await fireEvent(widget, "clicked");
+ *
+ * // Emit signal on gesture controller
+ * const gesture = widget.observeControllers().getObject(0) as Gtk.GestureDrag;
+ * await fireEvent(gesture, "drag-begin", { type: { type: "float", size: 64 }, value: 100 }, { type: { type: "float", size: 64 }, value: 100 });
  * ```
  *
  * @see {@link userEvent} for high-level user interactions
  */
-export declare const fireEvent: (element: Gtk.Widget, signalName: string, ...args: Arg[]) => Promise<void>;
+export declare const fireEvent: (element: Gtk.Widget | Gtk.EventController, signalName: string, ...args: Arg[]) => Promise<void>;

package/dist/fire-event.js

@@ -1,21 +1,25 @@
 import { call } from "@gtkx/native";
 import { tick } from "./timing.js";
 /**
- * Emits a GTK signal on a widget.
+ * Emits a GTK signal on a widget or event controller.
  *
  * Low-level utility for triggering signals directly. Prefer {@link userEvent}
  * for common interactions like clicking and typing.
  *
- * @param element - The widget to emit the signal on
- * @param signalName - GTK signal name (e.g., "clicked", "activate")
+ * @param element - The widget or event controller to emit the signal on
+ * @param signalName - GTK signal name (e.g., "clicked", "activate", "drag-begin")
  * @param args - Additional signal arguments
  *
  * @example
  * ```tsx
  * import { fireEvent } from "@gtkx/testing";
  *
- * // Emit custom signal
- * await fireEvent(widget, "my-custom-signal");
+ * // Emit signal on widget
+ * await fireEvent(widget, "clicked");
+ *
+ * // Emit signal on gesture controller
+ * const gesture = widget.observeControllers().getObject(0) as Gtk.GestureDrag;
+ * await fireEvent(gesture, "drag-begin", { type: { type: "float", size: 64 }, value: 100 }, { type: { type: "float", size: 64 }, value: 100 });
  * ```
  *
  * @see {@link userEvent} for high-level user interactions

package/dist/render.d.ts

@@ -15,9 +15,9 @@ import type { RenderOptions, RenderResult } from "./types.js";
  * import { render, screen } from "@gtkx/testing";
  *
  * test("button click", async () => {
- *   await render(<MyButton />);
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   await userEvent.click(button);
+ * await render(<MyButton />);
+ * const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
+ * await userEvent.click(button);
  * });
  * ```
  *
@@ -36,12 +36,12 @@ export declare const render: (element: ReactNode, options?: RenderOptions) => Pr
  * import { render, cleanup } from "@gtkx/testing";
  *
  * afterEach(async () => {
- *   await cleanup();
+ * await cleanup();
  * });
  *
  * test("my test", async () => {
- *   await render(<MyComponent />);
- *   // ...
+ * await render(<MyComponent />);
+ * // ...
  * });
  * ```
  */

package/dist/render.js

@@ -55,9 +55,9 @@ const wrapElement = (element, wrapper = true) => {
  * import { render, screen } from "@gtkx/testing";
  *
  * test("button click", async () => {
- *   await render(<MyButton />);
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   await userEvent.click(button);
+ * await render(<MyButton />);
+ * const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
+ * await userEvent.click(button);
  * });
  * ```
  *
@@ -96,12 +96,12 @@ export const render = async (element, options) => {
  * import { render, cleanup } from "@gtkx/testing";
  *
  * afterEach(async () => {
- *   await cleanup();
+ * await cleanup();
  * });
  *
  * test("my test", async () => {
- *   await render(<MyComponent />);
- *   // ...
+ * await render(<MyComponent />);
+ * // ...
  * });
  * ```
  */

package/dist/user-event.js

@@ -1,7 +1,7 @@
 import { getNativeObject } from "@gtkx/ffi";
 import * as Gdk from "@gtkx/ffi/gdk";
 import * as Gtk from "@gtkx/ffi/gtk";
-import { call } from "@gtkx/native";
+import { call, createRef } from "@gtkx/native";
 import { fireEvent } from "./fire-event.js";
 import { tick } from "./timing.js";
 import { isEditable } from "./widget.js";
@@ -166,6 +166,7 @@ const getOrCreateController = (element, controllerType) => {
     element.addController(controller);
     return controller;
 };
+const SIGNALS_WITH_RETURN_VALUE = new Set(["key-pressed", "key-released"]);
 const emitSignal = (target, signalName, ...args) => {
     const signalArgs = args.map((arg) => {
         if (arg.type === "float") {
@@ -173,11 +174,19 @@ const emitSignal = (target, signalName, ...args) => {
         }
         return { type: { type: "int", size: 32, unsigned: true }, value: arg.value };
     });
-    call("libgobject-2.0.so.0", "g_signal_emit_by_name", [
+    const ffiArgs = [
         { type: { type: "gobject", ownership: "borrowed" }, value: target.handle },
         { type: { type: "string", ownership: "borrowed" }, value: signalName },
         ...signalArgs,
-    ], { type: "undefined" });
+    ];
+    if (SIGNALS_WITH_RETURN_VALUE.has(signalName)) {
+        const returnRef = createRef(0);
+        ffiArgs.push({
+            type: { type: "ref", innerType: { type: "int", size: 32, unsigned: false } },
+            value: returnRef,
+        });
+    }
+    call("libgobject-2.0.so.0", "g_signal_emit_by_name", ffiArgs, { type: "undefined" });
 };
 const hover = async (element) => {
     const controller = getOrCreateController(element, Gtk.EventControllerMotion);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtkx/testing",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "description": "Testing utilities for GTKX applications",
   "keywords": [
     "gtkx",
@@ -36,14 +36,14 @@
     "dist"
   ],
   "dependencies": {
-    "@gtkx/ffi": "0.13.2",
-    "@gtkx/react": "0.13.2",
-    "@gtkx/native": "0.13.2"
+    "@gtkx/ffi": "0.14.0",
+    "@gtkx/native": "0.14.0",
+    "@gtkx/react": "0.14.0"
   },
   "devDependencies": {
     "@types/react-reconciler": "^0.32.3",
     "react-reconciler": "^0.33.0",
-    "@gtkx/vitest": "0.13.2"
+    "@gtkx/vitest": "0.14.0"
   },
   "scripts": {
     "build": "tsc -b && cp ../../README.md .",