david-swift / SettingsKit-macOS

Add a settings window to a SwiftUI macOS app

SettingsKit

User Manual · GitHub · Contributor Docs

SettingsKit makes it easier to add a settings window to a SwiftUI app for macOS.

Table of Contents

• Installation
• Usage
• Thanks

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.

• Getting Started

Usage

• Add a Settings Window
• Tabs & Subtabs
• Actions
• The Sidebar Design

Thanks

Dependencies

• SFSafeSymbols licensed under the MIT license
• SwiftLintPlugin licensed under the MIT license
• ColibriComponents licensed under the MIT license

Other Thanks

• The contributors
• SourceDocs used for generating the docs
• SwiftLint for checking whether code style conventions are violated
• The programming language Swift