OpenSwiftUI

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="Example/Shared/Assets/Assets.xcassets/framework.imageset/logo_dark.png" />
    <img alt="OpenSwiftUI" src="Example/Shared/Assets/Assets.xcassets/framework.imageset/logo_light.png" width="256" />
  </picture>
</p>

# OpenSwiftUI

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FOpenSwiftUIProject%2FOpenSwiftUI%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/OpenSwiftUIProject/OpenSwiftUI) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FOpenSwiftUIProject%2FOpenSwiftUI%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/OpenSwiftUIProject/OpenSwiftUI) [![codecov](https://codecov.io/gh/OpenSwiftUIProject/OpenSwiftUI/graph/badge.svg?token=S63P3YUCAJ)](https://codecov.io/gh/OpenSwiftUIProject/OpenSwiftUI) [![API coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fopenswiftuiproject.github.io%2FInterfaceCoverage%2Fbadges%2Fopenswiftui-ios-ios-18-5-swiftui-swiftuicore-default.json)](https://openswiftuiproject.github.io/InterfaceCoverage/?project=OpenSwiftUI&target=iOS&scope=SwiftUI%20%2B%20SwiftUICore&baseline=iOS%2018.5)

OpenSwiftUI is an open source implementation of Apple's [SwiftUI](https://developer.apple.com/documentation/swiftui)

The project is for the following purposes:
- Build GUI app on non-Apple platform (eg. Linux & Windows)
- Diagnose and debug SwiftUI issues on Apple platform

And the API design and documentation is to stay as compatible with the original SwiftUI API as possible.

> [!TIP]
> "Why join the navy if you can be a pirate?" — Steve Jobs
>
> :)

Currently, this project is in early development.

The full API [documentation](https://docs.openswiftuiproject.org/main/documentation/openswiftui/) is available on the OpenSwiftUI documentation site.

## Notes

this project is for learning and research purposes only.

If you choose to use this project, you do so at your own risk and are responsible for compliance with any applicable laws.

The author of this project is not responsible for any consequences that may arise from your use of this project.

> [!WARNING]
> This package use a lot of hidden API and private framework on Apple platform.
>
> Please **DO NOT** use this package in Apple's production environment(eg. App Store).
> 
> Otherwize it may break your build or crash your app at any future SDK/OS update.

## Usage

### Integration Guide

To integrate OpenSwiftUI into your own Xcode project, see **[INTEGRATION.md](INTEGRATION.md)** for detailed step-by-step instructions.

### Example Application

See Example folder and try it with ExampleApp

> [!IMPORTANT]
> Clone OpenAttributeGraph in the same directory before running the example.
>
> See [Example/README.md](Example/README.md) for more detail.

## Build

The current suggested toolchain to build the project is Swift 6.3.3 / Xcode 26.6.

### Build without testing fra