# gpuix-svelte

> A Svelte custom renderer for GPUI, the GPU-accelerated UI framework behind the Zed editor: Svelte 5
> components rendered straight into a native desktop window on Node.js >= 24 or Bun >= 1.4.

Elements are GPUI's (`div`, `text`, `img`, `input`, `textarea`, `virtual-list`, ...), styling is CSS
text for a flexbox layout in logical pixels, events go to the element under the pointer (`hitbox="self"`
hands a clickable element the clicks on its children), and inputs report their value in event
payloads. Read the Styling page before writing CSS. The package bundles its own Svelte build, so
a project depends on `gpuix-svelte` alone and runs its entry through the `gpuix-svelte` bin.

## Docs

- [Overview](https://gpuix-svelte.stanislav.garden/overview.md): what the package is, setup, how it differs from Svelte on the web, TypeScript config
- [Styling](https://gpuix-svelte.stanislav.garden/styling.md): every CSS property and value GPUI accepts, what is dropped, theming with var() and set_css_vars
- [Components](https://gpuix-svelte.stanislav.garden/components.md): Scroller (scrollbars, virtual lists), Portal (modals, menus, toasts), Tooltip, Popover and the native <anchored> they build on
- [Guide](https://gpuix-svelte.stanislav.garden/guide.md): forms and inputs, keyboard shortcuts and focus, window and desktop helpers, state that survives hot reload
- [Testing](https://gpuix-svelte.stanislav.garden/testing.md): headless tests through gpuix-svelte/test: mount, click, type, read back, screenshot; gpuix-svelte/automation drives a running window
- [Shipping](https://gpuix-svelte.stanislav.garden/shipping.md): standalone binaries with Bun, macOS signing, running in a browser on WebGPU
- [DOM](https://gpuix-svelte.stanislav.garden/dom.md): rendering Svelte components in both gpuix-svelte and normal DOM, with Vite or SvelteKit: IS_GPUIX, the DOM versions of the helpers and components, writing for both renderers
- [Updating](https://gpuix-svelte.stanislav.garden/updating.md): in-app updates from a static manifest with hash and signature checks, the GitHub release workflow, what install() does

## Optional

- [Contributing](https://gpuix-svelte.stanislav.garden/contributing.md): working on the gpuix-svelte repository itself
- [Everything in one file](https://gpuix-svelte.stanislav.garden/llms-full.txt): all of the pages above, concatenated