Forge KUI / 3.61.7
Documentation
Install, lay out, integrate and deploy. Find code and APIs for the task at hand.
Choose a language and SDK
Check architecture, versions and runtime.
Launch your first window
Create, build, run and troubleshoot.
Learn through a project
Layout, events, scripts, lists and desktop apps.
Start here
Choose an SDK and version
Choose a programming language, then check the package version, runtime and build requirements.
Run your first C++ window
Use the Windows x64 SDK from a standalone CMake project.
Use the C ABI
Manage windows and documents through public handles and the package examples.
Integrate the Go SDK
Windows x64 Full Profile with Go 1.22+ and the package build script.
Integrate the Rust SDK
Use kui and kui-sys with the Windows x64 MSVC toolchain.
Build interfaces
CSS, fonts and layout
Use the capability reference to check individual properties and values.
Pages, images, fonts and paths
Choose embedded or file-based pages and keep resources working outside the project folder.
Desktop windows and title bars
Configure native windows, custom title bars, controls and cleanup.
Forms and components
Forms, buttons, inputs, selections and popups combine KUI components with DOM behavior.
Canvas, WebGL and images
Canvas2D and WebGL use KUI graphics and scripting interfaces.
Keyboard, IME and accessibility
Interactive interfaces need keyboard focus, IME handling, selection state and accessibility semantics.
Connect your application
DOM, events and application data
Use the DOM to locate and update elements.
Lua scripting
Lua scripting is optional and controlled by KUI_ENABLE_SCRIPTING.
Windows, threads and lifecycle
Initialize the platform, create a window, load its document and run the event loop.
HTTP, asynchronous work and resources
HttpClient and binding-specific network APIs provide host data access.
Professional extensions
Extensions and media deployment
DOM element extensions use the kuiext_* C ABI.
Embed a code editor
kui_ext_editor provides an independent code-editor element.
PDF viewing and export
The PDF viewer is a PDFium-based kui_ext_pdf element extension.
Standalone 3D extension
kui_ext_3d is separate from the KUI core and connects through a C ABI, with backends including Filament and Bullet.
Audio, video and Lottie
KUI media adapters connect audio/video to their backends.
Develop and deliver
DevTools and MCP
The application must start DevTools and keep processing commands on the main thread.
MCP: edit UI and automate tests
Inspect, edit and test a running KUI app with an agent, using the captured site example, real tool arguments and acceptance checks.
Build KUI interfaces with an agent
Generate code from a working template, then inspect layout, events and visuals in the running KUI app.
Test the UI and application logic
Use model tests, real input, DOM assertions and screenshots to check different outcomes.
Record and analyze performance
Reproduce the slowdown with a fixed machine, window size, fonts and package version.
Deployment, CRT and runtime libraries
The C++ DLL ABI uses STL types.
Application and debugging security
DevTools is a privileged interface that can read DOM, logs, network data and scripts.
Troubleshoot common problems
Find checks for build, runtime, page, input and debugger connection failures.
Move a web interface to KUI
Keep HTML/CSS design patterns while identifying browser dependencies and native application work.
From HTML to a native window
Understand documents, frame updates and rendering boundaries before integrating KUI.
Look up an API
Find types, methods, CSS properties, Lua and extension APIs. Guides explain usage; reference entries retain declaration sources.
Open API & support reference →