https://github.com/astzweig/swiftui-launcher-window

🚄 Launcher window Scene for SwiftUI. Launch your app with style.
https://github.com/astzweig/swiftui-launcher-window

launcher macos-app swift swiftui

Last synced: 24 days ago
JSON representation

🚄 Launcher window Scene for SwiftUI. Launch your app with style.

• Host: GitHub
• URL: https://github.com/astzweig/swiftui-launcher-window
• Owner: astzweig
• License: eupl-1.2
• Created: 2023-04-26T20:02:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-11T23:33:14.000Z (6 months ago)
• Last Synced: 2024-11-24T17:11:53.814Z (about 1 month ago)
• Topics: launcher, macos-app, swift, swiftui
• Language: Swift
• Homepage:
• Size: 309 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LauncherWindow

![Launcher window on macOS](Examples/Launcher-Window.png)

LauncherWindow adds a new window scenes to SwiftUI. Launcher windows are

[frameless windows] that display a welcome message and let the user choose

an item from a list i.e. a database or a folder from many recent ones.

[frameless windows]: /astzweig/swiftui-frameless-window#framelesswindow

> [!NOTE]

> By default a launcher window is non resizable. If you want it to be resizable use the `.windowResizability` view modifier.

## Usage

Create a launcher window:

```swift

import SwiftUI

import LauncherWindow

@main

struct YourApp: App {

    var body: some Scene {

        LauncherWindow(withId: "launcher") {

            ActionItemsView()

        } listItems: {

            ListItemsView()

        }

    }

}

```

## Documentation

The library has enriched symbol documentation for [DocC].

[DocC]: https://www.swift.org/documentation/docc/documenting-a-swift-framework-or-package

## Testing `LauncherWindow`

LauncherWindow includes an executable target that launches a SwiftUI app to

test `LauncherWindow`. Either execute it with

```sh

$ swift run

```

or select the `LauncherWindowTestApp` under `Product > Scheme` in Xcode.

## Adding `LauncherWindow` as a Dependency

To use the `LauncherWindow` library in a SwiftUI project, 

add it to the dependencies for your package:

```swift

let package = Package(

    // name, platforms, products, etc.

    dependencies: [

        // other dependencies

        .package(url: "https://github.com/astzweig/swiftui-launcher-window", from: "1.0.0"),

    ],

    targets: [

        .executableTarget(name: "", dependencies: [

            // other dependencies

            .product(name: "LauncherWindow", package: "swiftui-launcher-window"),

        ]),

        // other targets

    ]

)

```

### Supported Versions

The minimum Swift version supported by swiftui-launcher-window releases are detailed below:

swiftui-launcher-window   | Minimum Swift Version

---------------------------|----------------------

`0.0.1 ...`                | 5.7