Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/divadretlaw/windowkit
🪟 Easily present SwiftUI views in their own UIWindow
https://github.com/divadretlaw/windowkit
swift swiftui uiwindow window
Last synced: 4 months ago
JSON representation
🪟 Easily present SwiftUI views in their own UIWindow
- Host: GitHub
- URL: https://github.com/divadretlaw/windowkit
- Owner: divadretlaw
- License: mit
- Created: 2023-10-15T09:16:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-05T17:54:17.000Z (5 months ago)
- Last Synced: 2024-10-12T18:02:42.752Z (4 months ago)
- Topics: swift, swiftui, uiwindow, window
- Language: Swift
- Homepage:
- Size: 85.9 KB
- Stars: 20
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WindowKit
[](https://swiftpackageindex.com/divadretlaw/WindowKit)
[](https://swiftpackageindex.com/divadretlaw/WindowKit)
Handle `UIWindow` & `UIWindowScene` within SwifUI and present SwiftUI Views in their own window.
## Usage
### `windowCover(isPresented:content:)`
Present a modal view within it's own `UIWindow` from any SwiftUI view.
Usage is similar to `fullscreenCover(isPresented:content:)`
```swift
.windowCover(isPresented: $isPresented) {
MyWindowCover()
}
```
You can also configure the window presentation
```swift
.windowCover(isPresented: $isPresented) {
MyWindowCover()
} configure { configuration in
// Customize the window cover presentation
}
```
#### Environment
In order to dismiss the window cover, use the `dismissWindowCover` from the environment
```swift
@Environment(\.dismissWindowCover) var dismiss
```
In case the current view is not presented within a window cover the `dismissWindowCover` action will do nothing.
### `windowOverlay(content:)`
Present a modal view within it's own `UIWindow` from any SwiftUI view.
Usage is similar to `overlay(content:)`
```swift
.windowOverlay {
MyWindowOverlay()
}
```
You can also configure the window presentation
```swift
.windowOverlay {
MyWindowOverlay()
} configure { configuration in
// Customize the window overlay presentation
}
```
### [`WindowReader`](https://github.com/divadretlaw/WindowReader)
Read the current `UIWindow` or `NSWindow` with `WindowReader`
```swift
@main
struct MyView: View {
var body: some Scene {
WindowReader { window in
...
}
}
}
```
On child views the `UIWindow` or `NSWindow` will be available in the `Environment`
#### Environment
```swift
@Environment(\.window) var window
```
### [`WindowSceneReader`](https://github.com/divadretlaw/WindowSceneReader)
#### SwiftUI Lifecycle
Read the current `UIWindowScene` with `WindowSceneReader`
```swift
@main
struct MyApp: App {
var body: some Scene {
WindowGroup {
WindowSceneReader { windowScene in
ContentView()
}
}
}
}
```
alternatively, just add `windowScene()` if you only need the window scene on child views.
```swift
@main
struct MyApp: App {
var body: some Scene {
WindowGroup {
ContentView()
.windowScene()
}
}
}
```
On child views the `UIWindowScene` will be available in the `Environment`
#### UIKit Lifecycle
```swift
class SceneDelegate: UIResponder, UIWindowSceneDelegate {
var window: UIWindow?
func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
if let windowScene = scene as? UIWindowScene {
let rootView = ContentView()
.windowScene(windowScene)
let window = UIWindow(windowScene: windowScene)
window.rootViewController = UIHostingController(rootView: rootView)
self.window = window
window.makeKeyAndVisible()
}
}
```
#### Environment
```swift
@Environment(\.windowScene) var windowScene
```
The `@Environment(\.windowScene) var windowScene` defaults to the first connected `UIWindowScene` or `nil` if no `UIWindowScene` is connected.
## License
See [LICENSE](LICENSE)