https://github.com/codeeditapp/aboutwindow

An about window for macOS applications.
https://github.com/codeeditapp/aboutwindow

appkit macos swift swiftui

Last synced: 5 months ago
JSON representation

An about window for macOS applications.

• Host: GitHub
• URL: https://github.com/codeeditapp/aboutwindow
• Owner: CodeEditApp
• License: mit
• Created: 2025-06-01T21:26:58.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-07-07T19:07:23.000Z (7 months ago)
• Last Synced: 2025-08-29T04:19:43.524Z (5 months ago)
• Topics: appkit, macos, swift, swiftui
• Language: Swift
• Homepage: https://codeeditapp.github.io/AboutWindow/documentation/aboutwindow/
• Size: 4.72 MB
• Stars: 16
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

  
AboutWindow




  

    

  

  

    

  

  

    

  



A customizable About window for macOS applications, featuring an app icon, version info, up to three action buttons, and footer text. Supports in-window navigation to custom pages, making it easy to showcase details, acknowledgments, or licensing information in a native, polished interface.

![GitHub release](https://img.shields.io/github/v/release/CodeEditApp/AboutWindow?color=orange&label=latest%20release&sort=semver&style=flat-square)

![Github Tests](https://img.shields.io/github/actions/workflow/status/CodeEditApp/AboutWindow/CI-push.yml?branch=main&label=tests&style=flat-square)

![GitHub Repo stars](https://img.shields.io/github/stars/CodeEditApp/AboutWindow?style=flat-square)

![GitHub forks](https://img.shields.io/github/forks/CodeEditApp/AboutWindow?style=flat-square)

[![Discord Badge](https://img.shields.io/discord/951544472238444645?color=5865F2&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/vChUXVf9Em)



  



## Documentation

This package is fully documented [here](https://codeeditapp.github.io/AboutWindow/documentation/aboutwindow/).

## Usage

To use `AboutWindow`, simply add it to your app.

```swift

AboutWindow(actions: {

    AboutButton(title: "Contributors", destination: {

        ContributorsView()

    })

    AboutButton(title: "Acknowledgements", destination: {

        AcknowledgementsView()

    })

    SomeActionButton(title: "Some Custom Stuff") {

        MatchedTitle("Hello")

    }

}, footer: {

    FooterView(

        primaryView: {

            Link(destination: URL(string: "https://opensource.org/licenses/MIT")!) {

                Text("MIT License")

                    .underline()

            }

        },

        secondaryView: {

            Text("© 2025 Example Inc.")

        }

    )

})

```

## License

Licensed under the [MIT license](https://github.com/CodeEditApp/AboutWindow/blob/main/LICENSE.md)