Skip to content

Commit 3ac0424

Browse files
committed
Add Documentation Landing Page
1 parent 64ac5b0 commit 3ac0424

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# ``AboutWindow``
2+
3+
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.
4+
5+
## Overview
6+
7+
To use `AboutWindow`, simply add it to your app.
8+
9+
```swift
10+
AboutWindow(actions: {
11+
AboutButton(title: "Contributors", destination: {
12+
ContributorsView()
13+
})
14+
AboutButton(title: "Acknowledgements", destination: {
15+
AcknowledgementsView()
16+
})
17+
SomeActionButton(title: "Some Custom Stuff") {
18+
MatchedTitle("Hello")
19+
}
20+
}, footer: {
21+
FooterView(
22+
primaryView: {
23+
Link(destination: URL(string: "https://opensource.org/licenses/MIT")!) {
24+
Text("MIT License")
25+
.underline()
26+
}
27+
},
28+
secondaryView: {
29+
Text("© 2025 Example Inc.")
30+
}
31+
)
32+
})
33+
```
34+
35+
## Topics
36+
37+
### SwiftUI Scene
38+
39+
- ``AboutWindow``
40+
41+
### Default Buttons
42+
43+
- ``AboutButton``

Sources/AboutWindow/Views/AboutButton.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
//
77
import SwiftUI
88

9+
/// The default `AboutWindow` button to add to the about window.
10+
/// Performs a given action when pressed.
911
public struct AboutButton: View {
1012

1113
private let id = UUID()

Sources/AboutWindow/Views/AboutWindow.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
import SwiftUI
99

10+
/// A `SwiftUI` Scene presenting an app icon, buttons, and more, in a stylized window.
1011
public struct AboutWindow<Footer: View, SubtitleView: View>: Scene {
1112
private let actions: () -> AboutActions
1213
let footer: () -> Footer

0 commit comments

Comments
 (0)