feat: add notification API wrapper#3096
Merged
MartinCupela merged 12 commits intomasterfrom Apr 8, 2026
Merged
Conversation
…ionApi.startNotificationTimeout
MartinCupela
changed the title
|
Size Change: +5.95 kB (+0.98%) Total Size: 614 kB 📦 View Changed
ℹ️ View Unchanged
|
…age-notification props - move message action success/error notifications to MessageActions defaults - bubble action handler errors to callers (no hook-level notification side effects) - add notification types + context payloads for message and channel-list actions - add Reminder/SaveForLater notification handling - allow custom Notification component override with forwardRef typing in ComponentContext - add examples/tests for translator-based notification customization BREAKING CHANGE: - Removed legacy notification text callback props from Message props: getDeleteMessageErrorNotification, getFetchReactionsErrorNotification, getFlagMessageErrorNotification, getFlagMessageSuccessNotification, getMarkMessageUnreadErrorNotification, getMarkMessageUnreadSuccessNotification, getMuteUserErrorNotification, getMuteUserSuccessNotification, getPinMessageErrorNotification. Notification customization must now be done through notification translators (Streami18n translationBuilder topic: "notification") and/or custom MessageActions. BREAKING CHANGE: - Message action handlers no longer publish notifications internally. Errors now propagate to call sites, which are responsible for success/error notifications.
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #3096 +/- ##
==========================================
+ Coverage 80.52% 80.82% +0.29%
==========================================
Files 415 417 +2
Lines 11948 12035 +87
Branches 3858 3873 +15
==========================================
+ Hits 9621 9727 +106
+ Misses 2327 2308 -19 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- add addSystemNotification function to the useNotificationApi interface BREAKING CHANGE: - Removed ConnectionStatus component. Connection notification UI is app responsibility now.
oliverlaz
approved these changes
Apr 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE:
getDeleteMessageErrorNotification,
getFetchReactionsErrorNotification,
getFlagMessageErrorNotification,
getFlagMessageSuccessNotification,
getMarkMessageUnreadErrorNotification,
getMarkMessageUnreadSuccessNotification,
getMuteUserErrorNotification,
getMuteUserSuccessNotification,
getPinMessageErrorNotification.
Notification customization must now be done through notification translators
(Streami18n translationBuilder topic: "notification") and/or custom MessageActions.
BREAKING CHANGE:
Errors now propagate to call sites, which are responsible for success/error notifications.
BREAKING CHANGE:
🎯 Goal
Summary
This PR introduces a new notifications facade hook:
useNotificationApiat src/components/Notifications/hooks/useNotificationApi.ts, and migrates notification API usage insrcto use it.This PR completes the notification-system migration for message and channel-list actions by removing legacy Message-level notification props and moving notification publishing/customization to the modern notification pipeline (
Notification+ translation builders + customizable action components).What changed
useNotificationApi(): NotificationApi.AddNotificationParamsNotificationIncidentDescriptorAddNotificationRemoveNotificationStartNotificationTimeoutNotificationApiaddNotificationabstraction overclient.notifications.addmessage,emitter,severity,duration,actions,error,context,tags,targetPanels,type,incident.useNotificationTargetby default.targetPanels(including multiple panels).targetPanelsare provided, inferred panel is ignored.typeas-is.typeis omitted andincidentis provided, type is generated from incident descriptor.typeis provided,incidentis optional and not required.removeNotification(id)delegates toclient.notifications.remove(id).startNotificationTimeout(id)delegates toclient.notifications.startTimeout(id).addSystemNotification(options)adds Notification with specificsystemtagAdded
useSystemNotificationshook that filters only notifications with tagsystemMigrated direct notification manager usage
client.notificationspublish calls insrcwithuseNotificationApi().addNotification.IconMinuscomponent and used it inNumericInputsrc/components/MessageActions/MessageActions.defaults.tsxsrc/components/MessageActions/RemindMeSubmenu.tsxpin/unpinmark unreadflagmute/unmutedeleteremind me set/removesave for later add/removetype(API-ish event key; message actions useapi:*)context: { message }errorattached on error notifications (when available)useFlagHandleras requested.src/components/Reactions/hooks/useFetchReactions.tsNotificationoverride support viaComponentContextand wiredNotificationListto use it.ComponentContext.Notificationtype to support forwarded refs:ForwardRefExoticComponent<...RefAttributes<HTMLDivElement>>).context: { channel }to channel-list action notifications in:src/components/ChannelListItem/ChannelListItemActionButtons.defaults.tsxSystemNotificationcomponent to the demo appWhy
client.notificationsacross components.