WinRT-XAML

A modern Rust library for creating beautiful Windows UIs using WinRT/XAML Islands

🎯 Production-Ready for UI Applications!

WinRT-XAML provides native WinRT/XAML rendering in Rust applications! 🎉

• ✅ Pure WinRT/XAML: Real XAML controls with native rendering
• ✅ XAML Islands: Modern UI hosted in Win32 windows
• ✅ Rich Controls: Button, TextBlock, TextBox, StackPanel, Grid, ScrollViewer
• ✅ Event Handling: Full click events and callbacks
• ✅ Modern Styling: Fluent Design with dark themes
• ✅ 15 Examples: Production-ready sample applications

View Status → | Architecture → | Build Guide →

# Try the scrollable list demo
cargo run --example scrollable_list

# Try the functional calculator
cargo run --example winrt_calculator_functional

🚀 Features

✅ Production-Ready Now

• 🎨 WinRT/XAML Controls: Button, TextBlock, TextBox, StackPanel, Grid, ScrollViewer
• 🏝️ XAML Islands: Full native XAML rendering in Win32 windows
• 🎯 Event Handling: Click events with Rust closures and callbacks
• ✨ Modern Styling: Fluent Design with colors, padding, margins, rounded corners
• 📜 Scrollable Content: ScrollViewer with vertical/horizontal scrolling
• 🔒 Memory Safe: Automatic COM lifetime management via RAII
• 🧵 Thread Safety: All types are Send + Sync
• ⚡ High Performance: Minimal FFI overhead with zero-cost abstractions
• 🎭 Dark Theme: Beautiful styled examples with modern design system

🚧 In Development

• ☑️ Additional Controls: CheckBox, RadioButton, ComboBox, Slider, ProgressBar
• 🎯 Data Binding: Reactive two-way binding support
• 📝 XAML Parsing: Load UI from XAML markup files
• 🎨 Advanced Styling: Resource dictionaries, templates, and animations

📦 Installation

Add to your Cargo.toml:

[dependencies]
winrt-xaml = "0.1.0"

🎯 Quick Start

Try the Examples

# Scrollable list with 30 items
cargo run --example scrollable_list

# Functional calculator
cargo run --example winrt_calculator_functional

# Chat interface
cargo run --example chat_interface

# Interactive counter
cargo run --example counter

Create Your First App

use winrt_xaml::error::Result;
use winrt_xaml::xaml_native::*;
use windows::Win32::System::Com::{CoInitializeEx, COINIT_APARTMENTTHREADED};

fn main() -> Result<()> {
    // Initialize COM for WinRT
    unsafe {
        CoInitializeEx(None, COINIT_APARTMENTTHREADED).ok()?;
    }

    // Initialize XAML
    let _xaml_manager = XamlManager::new()?;

    // Create host window
    let hwnd = create_host_window("My App", 600, 400)?;

    // Create XAML source and attach
    let mut xaml_source = XamlSource::new()?;
    let island_hwnd = xaml_source.attach_to_window(hwnd)?;

    // Create UI
    let panel = XamlStackPanel::new()?;
    panel.set_vertical(true)?;
    panel.set_spacing(20.0)?;
    panel.set_background(0xFF1A1A1A)?; // Dark theme
    panel.set_padding(30.0, 30.0, 30.0, 30.0)?;

    let button = XamlButton::new()?;
    button.set_content("Click Me!")?;
    button.set_size(150.0, 50.0)?;
    button.set_background(0xFF0078D4)?; // Microsoft blue
    button.on_click(|| println!("Button clicked!"))?;

    panel.add_child(&button.as_uielement())?;
    xaml_source.set_content_element(&panel.as_uielement())?;

    // Show and run
    unsafe {
        ShowWindow(island_hwnd, SW_SHOW);
        ShowWindow(hwnd, SW_SHOW);
    }

    // Message loop...
    Ok(())
}

See examples/ for complete, working examples.

📚 Examples

See the examples/ directory for 15 comprehensive examples:

Featured Examples

• scrollable_list.rs - ✨ ScrollViewer with 30 items, color-coded badges
• winrt_calculator_functional.rs - ✨ Fully functional calculator with events
• chat_interface.rs - ✨ Chat UI with text input/output
• winrt_controls_demo.rs - Showcase of all controls
• winrt_counter.rs - Interactive counter with state
• counter.rs - Counter with 4 operations (inc/dec/reset/double)
• counter_simple.rs - Minimal counter example

Application Examples

• todo_app.rs - Todo list with add/clear functionality
• form_demo.rs - Multi-field registration form
• settings_panel.rs - Settings UI with theme toggles
• color_picker.rs - Color selection interface
• calculator.rs - Calculator UI (non-interactive)

Basic Examples

• basic_window.rs - Simple click counter
• simple_window.rs - Hello World with styling
• controls_demo.rs - Basic controls showcase

All examples feature modern dark themes with Fluent Design styling!

# Run any example
cargo run --example scrollable_list
cargo run --example winrt_calculator_functional
cargo run --example chat_interface

⚡ Performance

WinRT-XAML provides minimal FFI overhead with zero-cost abstractions:

Key Performance Features:

• Zero-cost abstractions over WinRT
• RAII-based memory management (no GC)
• Direct C++/WinRT integration
• Incremental compilation support

🔧 Development

Prerequisites

• Rust 1.70 or later
• Windows 10/11 (Version 10.0.19041.0+)
• CMake 3.15 or later
• Visual Studio Build Tools 2019 or later with "Desktop development with C++"
• Windows SDK 10.0.19041.0 or later

Building

Complete Build Process (first time):

# 1. Build C++ helper DLL
cd xaml_islands_helper
mkdir build
cd build
cmake ..
cmake --build . --config Debug
cd ../..

# 2. Build Rust library and examples
cargo build --all-targets

# 3. Run an example
cargo run --example scrollable_list

Incremental Builds (after initial setup):

# Just rebuild Rust (C++ DLL already built)
cargo build --all-targets

# Rebuild specific example
cargo build --example chat_interface

See BUILD_SYSTEM.md for comprehensive build documentation.

Testing

# Run tests (when implemented)
cargo test --lib

# Test by running examples
cargo run --example scrollable_list

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Quick Contribution Guide

1. Fork the repository

2. Create a feature branch (git checkout -b feature/amazing-feature)

3. Make your changes

4. Run tests and benchmarks

5. Commit your changes (git commit -m 'Add amazing feature')

6. Push to the branch (git push origin feature/amazing-feature)

7. Open a Pull Request

📖 Documentation

Getting Started

• Project Status - ⭐ Current progress and roadmap
• Architecture - ⭐ System design and data flow
• Build System - ⭐ Comprehensive build guide
• Examples - 15 working examples

Reference

• API Documentation (Coming soon)
• Testing Guide
• Contributing
• Changelog

🛡️ Security

For security concerns, please see SECURITY.md.

📝 License

Licensed under either of:

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

🙏 Acknowledgments

• Built on Microsoft's windows-rs
• Benchmarking powered by Criterion.rs
• Inspired by modern UI frameworks

💰 Support

Support this project:

Status: ✅ Production-Ready Core | Version: 0.1.0 | Rust: 1.70+ | Windows: 10/11

🎯 Examples → | 📖 Status → | 🏗️ Architecture → | 🔨 Build →