@@ -483,4 +483,100 @@ This is an open-source project, contributions are welcome! The goal of StreamUI
483
483
* ** [ Remotion] ( https://www.remotion.dev ) **
484
484
* ** [ Revideo] ( https://re.video ) **
485
485
* ** Google Stadia**
486
- * ** [ Phoenix LiveView] ( https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html ) **
486
+ * ** [ Phoenix LiveView] ( https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html ) **
487
+
488
+ * # OpenSwiftUI
489
+
490
+ [ ![ ] ( 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 )
491
+
492
+ OpenSwiftUI is an open source implementation of Apple's [ SwiftUI] ( https://developer.apple.com/documentation/swiftui )
493
+
494
+ The project is for the following purposes:
495
+ - Build GUI app on non-Apple platform (eg. Linux & Windows)
496
+ - Diagnose and debug SwiftUI issues on Apple platform
497
+
498
+ And the API design is to stay the same as the original SwiftUI API as possible.
499
+
500
+ Currently, this project is in early development.
501
+
502
+ You can find the API [ documentation] ( https://swiftpackageindex.com/OpenSwiftUIProject/OpenSwiftUI/main/documentation/openswiftui ) here.
503
+
504
+ > [ !WARNING]
505
+ > This package use a lot of hidden API and private framework on Apple platform.
506
+ >
507
+ > Please ** DO NOT** use this package in Apple's production environment(eg. App Store).
508
+ >
509
+ > Otherwize it may break your build or crash your app at any future SDK/OS update.
510
+
511
+ ## Usage
512
+
513
+ See Example folder and try it with ExampleApp
514
+
515
+ > [ !IMPORTANT]
516
+ > Clone OpenGraph in the same directory before running the example.
517
+ >
518
+ > See [ Example/README.md] ( Example/README.md ) for more detail.
519
+
520
+ ## Build
521
+
522
+ ### Build without testing framework
523
+
524
+ ```
525
+ ./Scripts/build
526
+ ```
527
+
528
+ ### Build with Library Evolution
529
+
530
+ ```
531
+ ./Scripts/openswiftui_swiftinterface
532
+ ```
533
+
534
+ ## Supported platforms
535
+
536
+ The table below describes the current level of support that ` OpenSwiftUI ` has
537
+ for various platforms:
538
+
539
+ | ** Platform** | ** CI Status** | ** Support Status** | Build | Test | Deploy |
540
+ | -| :-| -| -| -| -|
541
+ | ** SwiftUI Compatibility** | [ ![ Compatibility tests] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/compatibility_tests.yml/badge.svg )] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/compatibility_tests.yml ) | | | | |
542
+ | ** macOS** | [ ![ macOS] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/macos.yml/badge.svg )] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/macos.yml ) | ⭐️⭐️⭐️ * [ ^ 1 ] | ✅ | ✅ | ✅ |
543
+ | ** iOS** | [ ![ iOS] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/ios.yml/badge.svg )] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/ios.yml ) | ⭐️⭐️⭐️⭐️ * [ ^ 2 ] | ✅ | ✅ | ✅ |
544
+ | ** Ubuntu 22.04** | [ ![ Ubuntu] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/ubuntu.yml/badge.svg )] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/ubuntu.yml ) | ⭐️⭐️ * [ ^ 3 ] | ✅ | ✅ | ❌ |
545
+ | ** Wasm** | [ ![ Ubuntu] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/wasm.yml/badge.svg )] ( https://github.com/OpenSwiftUIProject/OpenSwiftUI/actions/workflows/wasm.yml ) | ⭐️ * [ ^ 4 ] | ✅ | ❌ | ❌ |
546
+ | ** Windows** | None | Not supported yet | ❌ | ❌ | ❌ |
547
+
548
+
549
+ [ ^ 1 ] : AppKit and other UI framework backend is not intergrated yet.
550
+
551
+ [ ^ 2 ] : UIKit intergration is partly implemented. No Render support yet.
552
+
553
+ [ ^ 3 ] : Build and test is supported. But some feature is cut due to known Swift compiler issue.
554
+
555
+ [ ^ 4 ] : Build is supported. Test is not supported yet dut to upstream issue.
556
+
557
+ > [ !NOTE]
558
+ > The cross-platform OpenGraph is not fully implemented.
559
+ >
560
+ > It is only API compatible with AttributeGraph now.
561
+ >
562
+ > So most of the core feature is only available on Apple platform built with
563
+ > AttributeGraph varient.
564
+
565
+ ## License
566
+
567
+ See LICENSE file - MIT
568
+
569
+ ## Related Projects
570
+
571
+ - https://github.com/Cosmo/OpenSwiftUI
572
+ - https://github.com/helbertgs/OpenSwiftUI
573
+
574
+ ## Star History
575
+
576
+ <a href =" https://star-history.com/#StreamUI/StreamUI&Date " >
577
+ <picture >
578
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=StreamUI/StreamUI&type=Date&theme=dark" />
579
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=StreamUI/StreamUI&type=Date" />
580
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=StreamUI/StreamUI&type=Date" />
581
+ </picture >
582
+ </a >
0 commit comments