https://github.com/orchetect/maccontrolcenterui

SwiftUI menu builder DSL & controls that mimic macOS Control Center.
https://github.com/orchetect/maccontrolcenterui

control-center controlcenter macos swiftui swiftui-components

Last synced: 1 day ago
JSON representation

SwiftUI menu builder DSL & controls that mimic macOS Control Center.

• Host: GitHub
• URL: https://github.com/orchetect/maccontrolcenterui
• Owner: orchetect
• License: mit
• Created: 2022-12-21T09:20:09.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-13T20:07:34.000Z (11 days ago)
• Last Synced: 2024-12-23T12:14:40.401Z (1 day ago)
• Topics: control-center, controlcenter, macos, swiftui, swiftui-components
• Language: Swift
• Homepage:
• Size: 2.62 MB
• Stars: 109
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mac Control Center UI

[![Platforms | macOS 11](https://img.shields.io/badge/platforms-macOS%2011-blue.svg?style=flat)](https://developer.apple.com/swift) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Forchetect%2FMacControlCenterUI%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/orchetect/MacControlCenterUI) [![Xcode 14](https://img.shields.io/badge/Xcode-14-blue.svg?style=flat)](https://developer.apple.com/swift) [![License: MIT](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](https://github.com/orchetect/MacControlCenterUI/blob/main/LICENSE)



A **menu builder** and **suite of SwiftUI controls** that closely mimic the feel of **macOS Control Center** menus.

Integrates seamlessly with Swift's new `MenuBarExtra`.

Both **Dark** and **Light Mode** are fully supported.

## Getting Started

### Swift Package Manager (SPM)

1. Add MacControlCenterUI as a dependency using Swift Package Manager.

   - In an app project or framework, in Xcode:

     Select the menu: **File → Swift Packages → Add Package Dependency...**

     Enter this URL: `https://github.com/orchetect/MacControlCenterUI`

   - In a Swift Package, add it to the Package.swift dependencies:

     ```swift

     .package(url: "https://github.com/orchetect/MacControlCenterUI", from: "2.3.0")

     ```

2. Import the library:

   ```swift

   import MacControlCenterUI

   ```

3. Try the [Demo](Demo) example project to see all of the available controls in action.

## Requirements

Minimum requirements to compile: Xcode 14 on macOS 12.5 or newer.

Supports macOS 11.0+ once compiled.

## Known Issues

- Due to the lacklustre implementation of window resize behavior in SwiftUI, it is currently not possible to get smooth window resize animations without a tremendous amount of work. For that reason, most MacControlCenterUI controls whose Control Center counterparts use animation will instead use safer static view size changes.

## Author

Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself [@orchetect](https://github.com/orchetect).

## License

Licensed under the MIT license. See [LICENSE](https://github.com/orchetect/MacControlCenterUI/blob/master/LICENSE) for details.

## Sponsoring

If you enjoy using MacControlCenterUI and want to contribute to open-source financially, GitHub sponsorship is much appreciated. Feedback and code contributions are also welcome.

## Contributions

Contributions are welcome. Posting in [Discussions](https://github.com/orchetect/MacControlCenterUI/discussions) first prior to new submitting PRs for features or modifications is encouraged.