Global Notification System

[austincondiff]

Description

This PR introduces a global notification system in CodeEdit that allows users to receive and manage notifications across all open workspaces. Notifications provide important alerts and updates while ensuring consistency across multiple instances of the application.

Note

To test, go to Settings, press F12. Go to the Developer page and toggle on "Show Internal Development Inspector". In a workspace, in the inspector, open the new internal development inspector by clicking the hammer icon.

Key Features

• Temporary Notifications:

  • Displayed at the top-right corner of the active workspace.
  • Automatically hide after 5 seconds, unless hovered over.

• Sticky Notifications:

  • Persist in the UI until manually dismissed.
  • Useful for critical alerts or alerts where user action or attention is required.

• Notification Button & Popover:

  • Added to the toolbar in each workspace.
  • Displays a notification count for unread notifications.
  • Clicking the button opens a popove* containing all notifications.
  • When opening popover, all notifications are hidden. Sticky notifications that are not dismissed are restored over the UI after popover is closed.

Behavior:

• Notifications do not persist after the application is quit.
• All open workspaces stay in sync with the latest notifications.
• Interacting with a notification (e.g., dismissing it) updates all workspaces.
• Hovering over a temporary notification pauses and resets its hide timer.
• When CodeEdit is not in focus, notifications are redirected to the system Notification Center.
• Clicking the system notification action button focuses CodeEdit, executes the action, and dismisses the corresponding CodeEdit notification.
• Dismissing a CodeEdit notification also dismisses its corresponding system notification (if one exists), and vice versa.
• The notification panel closes when clicking outside of it, behaving like other menus.

Screenshots

Screen.Recording.2025-02-14.at.4.09.29.PM.mp4

Screen.Recording.2025-02-14.at.5.36.32.PM.mov

The following screen recording showcases the first iteration. In the design channel on Discord, @thecoolwinter suggested moving in this direction. While it required a bit more effort, I agree that it ultimately results in a much cleaner and more polished look.

Screen.Recording.2025-02-12.at.12.42.55.PM.mov

Usage

With a symbol (works with both SF Symbols and CodeEditSymbols)

NotificationManager.shared.post(
    iconSymbol: "bell",
    title: "New Notification Created",
    description: "Successfully created new notification",
    actionButtonTitle: "Action",
    action: {
        print("Action taken")
    }
)

The icon defaults to the users accent color if one isn't specified however you can specify a color here...

NotificationManager.shared.post(
    iconSymbol: "bell",
    iconColor: .red,
    title: "New Notification Created",
    description: "Successfully created new notification",
    actionButtonTitle: "Action",
    action: {
        print("Action taken")
    }
)

With a custom image...

NotificationManager.shared.post(
    iconImage: Image("GitHubIcon"),
    title: "New Notification Created",
    description: "Successfully created new notification",
    actionButtonTitle: "Action",
    action: {
        print("Action taken")
    }
)

With an emoji...

NotificationManager.shared.post(
    iconText: "👋",
    title: "New Notification Created",
    description: "Successfully created new notification",
    actionButtonTitle: "Action",
    action: {
        print("Action taken")
    }
)

With text...

NotificationManager.shared.post(
    iconText: "A",
    iconTextColor: .white,
    iconColor: .red,
    title: "New Notification Created",
    description: "Successfully created new notification",
    actionButtonTitle: "Action",
    action: {
        print("Action taken")
    }
)

Future Considerations

Currently, NotificationManager is shared between workspaces. This is intentional because notifications should generally speaking be global and not workspace specific. We may at some point allow for workspace specific notifications in addition to global notifications.

Related Issues

• closes ✨ Global Notification System #1983

Checklist

• I read and understood the contributing guide as well as the code of conduct
• The issues this PR addresses are related to each other
• My changes generate no new warnings
• My code builds and runs on my machine
• My changes are all related to the related issue above
• I documented my code

[thecoolwinter]

A few nitpicks and a suggestion for some duplicated initializers. Adding the FeatureIcon was a good idea! Documentation is also top notch.

[thecoolwinter]

One last question, and reopened a comment that I think was mistakenly resolved

[austincondiff]

Oh whoops. I closed it not by mistake. I created the OverlayButtonStyle but didn't realize I left CloseButtobStyle there. I'll remove it.