- Notifications
You must be signed in to change notification settings - Fork923
feat: add load more notifications on inbox#17030
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -18,7 +18,7 @@ export const ScrollArea = React.forwardRef< | ||
| <ScrollAreaPrimitive.Viewport className="h-full w-full rounded-[inherit]"> | ||
| {children} | ||
| </ScrollAreaPrimitive.Viewport> | ||
| <ScrollBarclassName="z-10"/> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. It was getting behind the sticky header. | ||
| <ScrollAreaPrimitive.Corner /> | ||
| </ScrollAreaPrimitive.Root> | ||
| )); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -19,9 +19,12 @@ type InboxPopoverProps = { | ||
| notifications: readonly InboxNotification[] | undefined; | ||
| unreadCount: number; | ||
| error: unknown; | ||
| isLoadingMoreNotifications: boolean; | ||
| hasMoreNotifications: boolean; | ||
| onRetry: () => void; | ||
| onMarkAllAsRead: () => void; | ||
| onMarkNotificationAsRead: (notificationId: string) => void; | ||
| onLoadMoreNotifications: () => void; | ||
| defaultOpen?: boolean; | ||
| }; | ||
| @@ -30,9 +33,12 @@ export const InboxPopover: FC<InboxPopoverProps> = ({ | ||
| unreadCount, | ||
| notifications, | ||
| error, | ||
| isLoadingMoreNotifications, | ||
| hasMoreNotifications, | ||
| onRetry, | ||
| onMarkAllAsRead, | ||
| onMarkNotificationAsRead, | ||
| onLoadMoreNotifications, | ||
| }) => { | ||
| const [isOpen, setIsOpen] = useState(defaultOpen); | ||
| @@ -41,12 +47,21 @@ export const InboxPopover: FC<InboxPopoverProps> = ({ | ||
| <PopoverTrigger asChild> | ||
| <InboxButton unreadCount={unreadCount} /> | ||
| </PopoverTrigger> | ||
| <PopoverContent | ||
| className="w-[var(--radix-popper-available-width)] max-w-[466px]" | ||
| align="end" | ||
| > | ||
| {/* | ||
| * data-radix-scroll-area-viewport is used to set the max-height of the ScrollArea | ||
| * https://github.com/shadcn-ui/ui/issues/542#issuecomment-2339361283 | ||
| */} | ||
| <ScrollArea | ||
| className={cn([ | ||
| "[--bottom-offset:48px]", | ||
| "[--max-height:calc(var(--radix-popover-content-available-height)-var(--bottom-offset))]", | ||
| "[&>[data-radix-scroll-area-viewport]]:max-h-[var(--max-height)]", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Tried to make it easier to read the classes and reasoning about their values. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Do you know what happens if the result of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. To make that happen, the screen height would be 48px or less than that. Since this is not a real scenario, even it is possible, I think it is ok to not care about that. Makes sense? | ||
| ])} | ||
| > | ||
| <div | ||
| className={cn([ | ||
| "flex items-center justify-between p-3 border-0 border-b border-solid border-border", | ||
| @@ -94,6 +109,18 @@ export const InboxPopover: FC<InboxPopoverProps> = ({ | ||
| onMarkNotificationAsRead={onMarkNotificationAsRead} | ||
| /> | ||
| ))} | ||
| {hasMoreNotifications && ( | ||
| <Button | ||
| variant="subtle" | ||
| size="sm" | ||
| disabled={isLoadingMoreNotifications} | ||
| onClick={onLoadMoreNotifications} | ||
| className="w-full" | ||
| > | ||
| <Spinner loading={isLoadingMoreNotifications} size="sm" /> | ||
| Load more | ||
| </Button> | ||
| )} | ||
| </div> | ||
| ) : ( | ||
| <div className="p-6 flex items-center justify-center min-h-48"> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| import { watchInboxNotifications } from "api/api"; | ||
| import { getErrorDetail, getErrorMessage } from "api/errors"; | ||
| import type { | ||
| ListInboxNotificationsResponse, | ||
| @@ -11,10 +11,13 @@ import { useMutation, useQuery, useQueryClient } from "react-query"; | ||
| import { InboxPopover } from "./InboxPopover"; | ||
| const NOTIFICATIONS_QUERY_KEY = ["notifications"]; | ||
| const NOTIFICATIONS_LIMIT = 25; // This is hard set in the API | ||
| type NotificationsInboxProps = { | ||
| defaultOpen?: boolean; | ||
| fetchNotifications: ( | ||
| startingBeforeId?: string, | ||
| ) => Promise<ListInboxNotificationsResponse>; | ||
| markAllAsRead: () => Promise<void>; | ||
| markNotificationAsRead: ( | ||
| notificationId: string, | ||
| @@ -30,12 +33,12 @@ export const NotificationsInbox: FC<NotificationsInboxProps> = ({ | ||
| const queryClient = useQueryClient(); | ||
| const { | ||
| data:inboxRes, | ||
| error, | ||
| refetch, | ||
| } = useQuery({ | ||
| queryKey: NOTIFICATIONS_QUERY_KEY, | ||
| queryFn:() =>fetchNotifications(), | ||
| }); | ||
| const updateNotificationsCache = useEffectEvent( | ||
| @@ -75,6 +78,32 @@ export const NotificationsInbox: FC<NotificationsInboxProps> = ({ | ||
| }; | ||
| }, [updateNotificationsCache]); | ||
| const { | ||
| mutate: loadMoreNotifications, | ||
| isLoading: isLoadingMoreNotifications, | ||
| } = useMutation({ | ||
| mutationFn: async () => { | ||
| if (!inboxRes || inboxRes.notifications.length === 0) { | ||
| return; | ||
| } | ||
| const lastNotification = | ||
| inboxRes.notifications[inboxRes.notifications.length - 1]; | ||
| const newRes = await fetchNotifications(lastNotification.id); | ||
Comment on lines +89 to +90 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We want to make sure that | ||
| updateNotificationsCache((prev) => { | ||
| return { | ||
| unread_count: newRes.unread_count, | ||
| notifications: [...prev.notifications, ...newRes.notifications], | ||
| }; | ||
| }); | ||
| }, | ||
| onError: (error) => { | ||
| displayError( | ||
| getErrorMessage(error, "Error loading more notifications"), | ||
| getErrorDetail(error), | ||
| ); | ||
| }, | ||
| }); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I just found way easier to use a mutation to update the data than use the | ||
| const markAllAsReadMutation = useMutation({ | ||
| mutationFn: markAllAsRead, | ||
| onSuccess: () => { | ||
| @@ -122,12 +151,17 @@ export const NotificationsInbox: FC<NotificationsInboxProps> = ({ | ||
| return ( | ||
| <InboxPopover | ||
| defaultOpen={defaultOpen} | ||
| notifications={inboxRes?.notifications} | ||
| unreadCount={inboxRes?.unread_count ?? 0} | ||
| error={error} | ||
| isLoadingMoreNotifications={isLoadingMoreNotifications} | ||
| hasMoreNotifications={Boolean( | ||
| inboxRes && inboxRes.notifications.length === NOTIFICATIONS_LIMIT, | ||
| )} | ||
| onRetry={refetch} | ||
| onMarkAllAsRead={markAllAsReadMutation.mutate} | ||
| onMarkNotificationAsRead={markNotificationAsReadMutation.mutate} | ||
| onLoadMoreNotifications={loadMoreNotifications} | ||
| /> | ||
| ); | ||
| }; | ||
Uh oh!
There was an error while loading.Please reload this page.