Keel v0.5.1 中文 GitHub

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

Module READMEs describe source responsibilities and implementation files. Read the repository’s contribution guide before contributing.