https://github.com/mrkai77/dynamicnotchkit

Seamlessly adapt your macOS app to the notch era.
https://github.com/mrkai77/dynamicnotchkit

dynamic-notch macos notch package swift swiftui

Last synced: 3 days ago
JSON representation

Seamlessly adapt your macOS app to the notch era.

• Host: GitHub
• URL: https://github.com/mrkai77/dynamicnotchkit
• Owner: MrKai77
• License: mit
• Created: 2023-08-26T00:13:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-25T02:45:08.000Z (20 days ago)
• Last Synced: 2024-10-26T16:12:37.484Z (18 days ago)
• Topics: dynamic-notch, macos, notch, package, swift, swiftui
• Language: Swift
• Homepage:
• Size: 29.1 MB
• Stars: 126
• Watchers: 5
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DynamicNotchKit

## Examples:

|  |  |

| -------- | ------- |

|   |  |

## Installation

Compatibility: **macOS 12+**

Add `https://github.com/MrKai77/DynamicNotchKit` in the [“Swift Package Manager” tab in Xcode](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).

## Usage

It's really easy! All the UI is handled by SwiftUI. That means, that you can use your existing views *directly* in DynamicNotchKit!

Here's an example:

```swift

let dynamicNotch = DynamicNotch {

    ContentView()

}

dynamicNotch.show(for: 2)

```

Where `ContentView` is a View.

Notice the `show(for: 2)`. This will cause the popover to be displayed on the primary screen for two seconds before hiding itself automatically.

The available methods to set the DynamicNotch's visibility are:

- `show(on screen: NSScreen = NSScreen.screens[0], for time: Double = 0)`

- `hide()`

- `toggle()`

DynamicNotchKit also supports Macs without a notch, meaning that this package supports _all_ Mac styles! You will see an example of that below.

## DynamicNotchInfo

In addition, there is also a `DynamicNotchInfo`, which is a fine-tuned version of the DynamicNotch specifically tailored to show general information:

```swift

let notch = DynamicNotchInfo(

    icon: Image(systemName: "figure"),

    title: "Figure",

    description: "Looks like a person"

)

notch.show(for: 2)

```

This will result in a popover as so:



Furthermore, there is a `.floating` style, which will **automatically** be used on Macs without a notch:



In fact, `DynamicNotchInfo` was used 3/4 of the examples above :D

Anyways, there are more methods available, which I haven't listed here, as this package is still in development. I have also added much more detailed documentation to each available public method in the code, so if you are curious, please check there for more usage information!

...I'm probably going to improve these docs later :)

Feel free to ask questions/report issues in the Issues tab!

# License

This project is licensed under the [MIT license](LICENSE).