DynamicNotchKit Documentation

DynamicNotchKit is a framework designed to help macOS developers integrate their applications with the MacBook notch. It provides tools to display notifications and updates in a visually appealing way, mimicking the behavior of iOS's Dynamic Island.

Key capabilities include:

• Managing the complexities of the notch area.
• Drawing custom windows specifically for notch interactions.
• Handling content insets and safe areas automatically.
• Providing a fallback 'floating window' style for devices that do not have a notch, ensuring a consistent experience across different MacBook models.

DynamicNotchKit requires macOS 13+. To install, add the following repository URL in the Swift Package Manager tab in Xcode:

https://github.com/MrKai77/DynamicNotchKit

You can integrate any SwiftUI View into the notch area using DynamicNotch. This allows you to display custom content, notifications, or updates directly in the notch. Use the .expand() method to trigger the expansion animation.

let notch = DynamicNotch {
    ContentView()
}
await notch.expand()

For displaying general information (like an icon, title, and description) in a pre-configured popover style, use DynamicNotchInfo. This is a fine-tuned version of DynamicNotch designed for quick status updates or info snippets.

On Macs without a notch, DynamicNotchInfo automatically uses a .floating style to ensure compatibility.

let notch = DynamicNotchInfo(
    icon: .init(systemName: "figure"),
    title: "Figure",
    description: "Looks like a person"
)
await notch.expand()