Overview
Start with Getting started to open your first window. Use Guides to build your application and Components to find UI controls. For framework changes, see Contributing.
Getting started
- Getting started: scaffold a project, edit its UI, run it, and package it.
- WebAssembly: build WebAssembly and understand the differences from desktop applications.
- Migration: replace APIs from older versions.
Mobile
- Overview: iOS and Android support and system capability limits.
- iOS: builds, simulator runs, scene lifecycle adapter and device signing.
- Android: APK packaging, device installation and toolchain checks.
Guides
- Elements and views: layout, state, events, focus, scrolling, and overlays.
- Windows: multiple windows, lifecycle, shortcuts, and offscreen screenshots.
- Theme: colors, fonts, dimensions, local themes, and motion.
- Markdown: streaming, code blocks, caching, and customization.
- Native APIs: permissions, screenshots, keyboard and mouse input, global hotkeys, notifications, and the clipboard.
- Primitives: reuse keyboard navigation and selection behavior with your own appearance.
- Accessibility: what VoiceOver reads and presses in a Keel window.
Components
- Overview: find components by purpose, with APIs and interactive examples.
Testing
- Automation: launch applications, operate components, and take screenshots through MCP.
- Troubleshooting: environment, text layout, redraw, window, and permission issues.
- Testing: interaction regressions, screenshot matrices, and real-window tests.
Contributing
- Architecture: module responsibilities, dependency boundaries, and threading rules.
- Extending Keel: add components, native capabilities, and examples.
- Component guidelines: APIs, state, file organization, and acceptance criteria.
- Visual guidelines: typography, dimensions, spacing, colors, and interaction states.
- Design decisions: framework trade-offs and historical approaches.
- One module: Gio and go-text as packages of the Keel module, import prefixes, and migration.
- Changes from upstream: Gio, go-text and packager changes, source locations, regression tests, and compatibility limits.
- Rendering memory and reuse: renderer allocation changes, native measurements, regression coverage and limitations.
- Desktop CGO-free delivery design: native binding migration and acceptance gates.
- Desktop no-cgo implementation evidence: verified build and ABI results, limitations, and pending acceptance.
- Gallery capability gaps: comparison scope and remaining component behavior.
- Shared WebAssembly experiment: single-runtime module loading, measurements and production gates.
Module READMEs describe source responsibilities and implementation files. Read the repository’s contribution guide before contributing.