Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/david-swift/settingskit-macos
Add a settings window to a SwiftUI macOS app
https://github.com/david-swift/settingskit-macos
macos settings swift swiftui
Last synced: about 23 hours ago
JSON representation
Add a settings window to a SwiftUI macOS app
- Host: GitHub
- URL: https://github.com/david-swift/settingskit-macos
- Owner: david-swift
- License: mit
- Created: 2023-02-17T21:03:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T16:01:21.000Z (5 months ago)
- Last Synced: 2024-12-18T14:12:16.158Z (8 days ago)
- Topics: macos, settings, swift, swiftui
- Language: Swift
- Homepage: https://david-swift.github.io/SettingsKit-macOS/
- Size: 4.75 MB
- Stars: 91
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
SettingsKit
_SettingsKit_ makes it easier to add a settings window to a SwiftUI app for macOS.
![GitHub Banner][image-1]
## Table of Contents
- [Installation][1]
- [Usage][2]
- [Thanks][3]
## Installation
### Swift Package
1. Open your Swift package in Xcode.
2. Navigate to `File > Add Packages`.
3. Paste this URL into the search field: `https://github.com/david-swift/SettingsKit-macOS`
4. Click on `Copy Dependency`.
5. Navigate to the `Package.swift` file.
6. In the `Package` initializer, under `dependencies`, paste the dependency into the array.
### Xcode Project
1. Open your Xcode project in Xcode.
2. Navigate to `File > Add Packages`.
3. Paste this URL into the search field: `https://github.com/david-swift/SettingsKit-macOS`
4. Click on `Add Package`.
## Usage
An example app project is available [here.][4] Browse the documentation [here.](https://david-swift.github.io/SettingsKit-macOS/)
## Thanks
### Dependencies
- [SwiftLintPlugin][12] licensed under the [MIT license][13]
### Other Thanks
- [SwiftLint][19] for checking whether code style conventions are violated
- The programming language [Swift][20]
[1]: #installation
[2]: #usage
[3]: #thanks
[4]: /Tests/Examples/
[10]: https://github.com/SFSafeSymbols/SFSafeSymbols
[11]: https://github.com/SFSafeSymbols/SFSafeSymbols/blob/stable/LICENSE
[12]: https://github.com/lukepistrol/SwiftLintPlugin
[13]: https://github.com/lukepistrol/SwiftLintPlugin/blob/main/LICENSE
[14]: https://github.com/david-swift/ColibriComponents-macOS
[15]: https://github.com/david-swift/ColibriComponents-macOS/blob/main/LICENSE.md
[18]: Documentation/Reference/SettingsKit-macOS/README.md
[19]: https://github.com/realm/SwiftLint
[20]: https://github.com/apple/swift
[image-1]: Icons/GitHubBanner.png