Skip to main content

Getting Started

Requirements

The basic build only needs the .NET 10 SDK:

dotnet build

Running the real UI sample requires these Linux native dependencies:

  • libwebkitgtk-6.0.so.4
  • libjavascriptcoregtk-6.0.so.1
  • GTK 4
  • A working DISPLAY or WAYLAND_DISPLAY

Build

dotnet build

Or use the repository Makefile:

make

Run The Samples

All samples use .uui.csx views and the WebKitGTK render host:

dotnet run --project samples/Hello/Hello.csproj
dotnet run --project samples/Counter/Counter.csproj
dotnet run --project samples/Todo/Todo.csproj
dotnet run --project samples/CsxCard/CsxCard.csproj

Close the window or press Ctrl+C to exit a sample process.

Test

Offline tests do not open WebKitGTK:

dotnet test --filter Category!=Integration

Real renderer integration tests verify WebKitGTK mount, update, and event back-channel behavior:

dotnet test tests/UltimateUI.Hosting.Tests/UltimateUI.Hosting.Tests.csproj --filter Category=Integration