https://github.com/swiftuix/swiftuiz
Build incredible expansions to SwiftUI with this toolkit for framework developers.
https://github.com/swiftuix/swiftuiz
Last synced: 3 months ago
JSON representation
Build incredible expansions to SwiftUI with this toolkit for framework developers.
- Host: GitHub
- URL: https://github.com/swiftuix/swiftuiz
- Owner: SwiftUIX
- License: mit
- Created: 2023-10-30T08:09:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-20T08:06:30.000Z (4 months ago)
- Last Synced: 2025-03-25T15:49:11.627Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 753 KB
- Stars: 23
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> While a large portion of this package is production ready, the package and its documentation is still in alpha.
>
> Directly contact [@vmanot](http://twitter.com/vatsal_manot) for any queries related to this package.
# SwiftUIZ
A framework to support ambitious expansions to SwiftUI. Public API surface is production-ready.
> [!NOTE]
> This section is incomplete and is in active iteration.
# Usage
### `PreviewCatalogGroup`
`PreviewCatalogGroup` is a `Scene` that automatically generates a navigated list of previews.
Simply `import SwiftUIZ` and add `PreviewCatalogGroup()` to your `App`:
```swift
import SwiftUIZ
@main
struct MyProjectApp: App {
var body: some Scene {
// replace the WidowsGroup code with PreviewCatalogGroup()
// WindowGroup {
// ContentView()
// }
PreviewCatalogGroup()
}
}
```
To make a SwiftUI view discoverable, annotate it with the `@RuntimeDiscoverable` macro.
Runtime discoverable conform to `ViewPreview` instead of `View`. For example:
```swift
import SwiftUIZ
@RuntimeDiscoverable // property wrapper
struct MyView1: ViewPreview { // conforms to ViewPreview instead of View
// Optional - set custom title
// Name of the view (e.g. MyView1) is default
static var title: String {
"Custom Title for My View 1"
}
var body: some View {
Text("My View 1")
}
}
@RuntimeDiscoverable
struct MyView2: ViewPreview {
var body: some View {
Text("My View 2")
}
}
@RuntimeDiscoverable
struct MyView3: ViewPreview {
var body: some View {
Text("My View 3")
}
}
```
# Acknowledgments
This library wouldn't be possible without these incredible OSS projects that I'm building upon.
MarkdownUI by @gonzalezreal
- **Link**: (swift-markdown-ui)[https://github.com/gonzalezreal/swift-markdown-ui]
- **License**: [MIT License](https://github.com/gonzalezreal/swift-markdown-ui/blob/main/LICENSE)
- **Authors**: @gonzalezreal
- **Notes**:
- `BlockSequence` no longer uses a `VStack`, allowing for lazy loading of large Markdown content via `LazyVStack { ... }`.
- Integration of SwiftUIX for advanced view caching and Nuke for efficient remote image loading.
- The result builder DSL has been removed.
SwiftUI-Macros by @Wouter01
- **Link**: [SwiftUI-Macros-ui](https://github.com/Wouter01/SwiftUI-Macros)
- **License**: [MIT License](https://github.com/Wouter01/SwiftUI-Macros/blob/main/LICENSE)
- **Authors**: @Wouter01
- **Notes**:
- `EnvironmentValues`, `EnvironmentKey`, `EnvironmentStorage` and `EnvironmentValues` are used.
- Rather than add `Wouter01`'s (fantastic!) library to **SwiftUIZ** as a dependency, I chose to inline it for a couple of reasons:
- `swift-syntax` does not have a stable API surface as of writing this, resulting in irreconcilable conflicts during dependency resolution.
- SwiftPM is slow as f*** at package resolution, I'm going to avoid adding any dependencies for 1-3 file packages.
- The implementation is going to fork ways and leverage `SwiftSyntaxUtilities` from [Swallow](http://github.com/vmanot/Swallow) to make it even more concise.