API Reference

Every export from glyx (@glyx-dev/react). React hooks and standard library — import those from 'react' directly.

Core components

Form components

Hooks

import { useWindowSize, useScreenSize, useMediaQuery, useDraggable } from '@glyx-dev/react'

useDraggable handlers

useDraggable({
  onDragStart?: (x: number, y: number) => void
  onDragMove?:  (dx: number, dy: number) => void
  onDragEnd?:   (x: number, y: number) => void
})

Overlay / Popover

import { openPopover, closePopover } from '@glyx-dev/react'

openPopover options: x, y, h, width, contentH, render: () => ReactElement, onClose: () => void. See Popover for full docs.

App lifecycle

import { render, getEnv, measureText } from '@glyx-dev/react'

glyxWindow

import { glyxWindow } from '@glyx-dev/react'

Window state

Window properties

Lifecycle

Utilities

Network

import { fetch, Headers, ws, mdns } from '@glyx-dev/react'
// fetch and Headers are also available as globals

Requires capability: "network"

fetch

fetch(url: string, options?: {
  method?:    string
  headers?:   Headers | Record<string, string> | [string, string][]
  body?:      string | object          // objects are JSON-serialized automatically
  multipart?: MultipartPart[]
}): Promise<Response>

Response properties: status, ok, statusText, url, redirected, type, bodyUsed, headers: Headers. Response methods: text(), json(), arrayBuffer(), blob(), clone().

Headers

const h = new Headers()
h.set('Content-Type', 'application/json')
h.append('X-Custom', 'value')
h.get('content-type')    // case-insensitive
h.has('x-custom')
h.forEach((value, name) => { ... })

ws

ws.connect(url: string, handlers?: {
  onmessage?: (ev: { data: string }) => void
  onclose?:   () => void
  onerror?:   (err: string) => void
}): Promise<{ id: number, send(msg: string): void, close(): void }>

mdns

mdns.discover(serviceType: string, opts?: { timeout?: number }): Promise<MdnsService[]>
 
type MdnsService = { name: string, hostname: string, port: number, addresses: string[] }

File system

import { fs } from '@glyx-dev/react'

Requires capability: "fs"

Database

import { db } from '@glyx-dev/react'

Requires capability: "db"

Vector database

import { vectorDb } from '@glyx-dev/react'

Requires capability: "vectorDb"

Dialog

import { dialog } from '@glyx-dev/react'

opts for file pickers: { filters?: [{name, extensions[]}], defaultPath? }

Clipboard

import { clipboard } from '@glyx-dev/react'

Notifications

import { notification } from '@glyx-dev/react'

opts: { title: string, body?: string, icon?: string }

System Tray

import { tray } from '@glyx-dev/react'

Menu items: { id: string, label: string, enabled?: boolean, checked?: boolean, separator?: boolean, children?: TrayMenuItem[] }

Events (returned as JSON from pollEvents()): Click | DoubleClick | MenuItemClick { tray_id, item_id }

Requires tray: true capability in glyx.config.json.

Audio

import { audio } from '@glyx-dev/react'

Requires capability: "audio"

audio.play(src, opts?) starts playback and returns a player handle used for all subsequent control.

See the Audio page for full examples.

Microphone

import { microphone } from '@glyx-dev/react'

Requires capability: "microphone" (and "audio").

One-shot WAV recording via the OS audio input.

AI

import { ai } from '@glyx-dev/react'

Requires capability: "ai"

System

import { system, battery, power, storage } from '@glyx-dev/react'

Credentials (keychain)

import { credentials } from '@glyx-dev/react'

Backed by Windows Credential Manager, macOS Keychain, or Linux Secret Service.

IPC (inter-window)

import { ipc } from '@glyx-dev/react'

Deep links

import { deeplink } from '@glyx-dev/react'

Register your URL scheme in glyx.config.json under "deeplink": { "scheme": "myapp" }.

Crash reporting

import { crash } from '@glyx-dev/react'

CrashReport: { id, timestamp, message, stackTrace }. Reports are captured automatically and persisted across restarts.

Auto-updater

import { updater } from '@glyx-dev/react'

Performance

import { perf } from '@glyx-dev/react'

Backend (custom commands)

import { backend } from '@glyx-dev/react'

// Call a custom backend command
const result = await backend.myCommand({ arg1: 'value' })

backend is a Proxy — any property access becomes a command call. Arguments are serialized to JSON and the return value is deserialized. Use it for both namespaced JS Plugins and custom Rust commands from Native Extensions.

Input

import { input } from '@glyx-dev/react'

input.shortcut — focused shortcuts

Fires when the app window is focused. No OS registration.

input.globalShortcut — system-wide shortcuts

Fires even when the app is backgrounded. Registered with the OS.

Accelerator format: modifiers joined with +, key last — "ctrl+s", "ctrl+shift+z", "meta+k", "f11", "escape". Modifiers: ctrl / control, shift, alt, meta / cmd / win.

input.gamepads — gamepad input

See the Window & Shortcuts page for full examples.