feat(neuron-ui): add notification panel

Keith-CY · Keith-CY · commit f7984b004382 · 2019-07-31T18:45:09.000+08:00
show all warnings and alerts in the notification panel
diff --git a/packages/neuron-ui/src/components/NetworkEditor/hooks.ts b/packages/neuron-ui/src/components/NetworkEditor/hooks.ts
@@ -1,7 +1,7 @@
 import { useState, useEffect, useMemo, useCallback } from 'react'
 
-import { AppActions, StateDispatch } from 'states/stateProvider/reducer'
-import { createNetwork, updateNetwork } from 'states/stateProvider/actionCreators'
+import { StateDispatch } from 'states/stateProvider/reducer'
+import { createNetwork, updateNetwork, addNotification } from 'states/stateProvider/actionCreators'
 
 import { Message, MAX_NETWORK_NAME_LENGTH } from 'utils/const'
 
@@ -68,15 +68,9 @@ export const useInitialize = (
       if (network) {
         initialize(network)
       } else {
-        dispatch({
-          type: AppActions.AddNotification,
-          payload: {
-            networks: {
-              type: 'warning',
-              timestamp: Date.now(),
-              content: i18n.t('messages.network-is-not-found'),
-            },
-          },
+        addNotification({
+          type: 'warning',
+          content: i18n.t('messages.network-is-not-found'),
         })
       }
     }
@@ -126,72 +120,54 @@ export const useHandleSubmit = (
 ) =>
   useCallback(async () => {
     const warning = {
-      type: 'warning',
+      type: 'warning' as 'warning',
       timestamp: Date.now(),
       content: '',
     }
     if (!name) {
-      return dispatch({
-        type: AppActions.AddNotification,
-        payload: {
-          ...warning,
-          content: i18n.t(Message.NameRequired),
-        },
-      })
+      return addNotification({
+        ...warning,
+        content: i18n.t(Message.NameRequired),
+      })(dispatch)
     }
     if (name.length > MAX_NETWORK_NAME_LENGTH) {
-      return dispatch({
-        type: AppActions.AddNotification,
-        payload: {
-          ...warning,
-          content: i18n.t(Message.LengthOfNameShouldBeLessThanOrEqualTo, {
-            length: MAX_NETWORK_NAME_LENGTH,
-          }),
-        },
-      })
+      return addNotification({
+        ...warning,
+        content: i18n.t(Message.LengthOfNameShouldBeLessThanOrEqualTo, {
+          length: MAX_NETWORK_NAME_LENGTH,
+        }),
+      })(dispatch)
     }
     if (!remote) {
-      return dispatch({
-        type: AppActions.AddNotification,
-        payload: {
-          ...warning,
-          content: i18n.t(Message.URLRequired),
-        },
-      })
+      return addNotification({
+        ...warning,
+        content: i18n.t(Message.URLRequired),
+      })(dispatch)
     }
     if (!remote.startsWith('http')) {
-      return dispatch({
-        type: AppActions.AddNotification,
-        payload: {
-          ...warning,
-          content: i18n.t(Message.ProtocolRequired),
-        },
-      })
+      return addNotification({
+        ...warning,
+        content: i18n.t(Message.ProtocolRequired),
+      })(dispatch)
     }
     // verification, for now, only name is unique
     if (id === 'new') {
       if (networks.some(network => network.name === name)) {
-        return dispatch({
-          type: AppActions.AddNotification,
-          payload: {
-            ...warning,
-            content: i18n.t(Message.NetworkNameUsed),
-          },
-        })
+        return addNotification({
+          ...warning,
+          content: i18n.t(Message.NetworkNameUsed),
+        })(dispatch)
       }
       return createNetwork({
         name,
         remote,
       })(dispatch, history)
     }
     if (networks.some(network => network.name === name && network.id !== id)) {
-      return dispatch({
-        type: AppActions.AddNotification,
-        payload: {
-          ...warning,
-          content: i18n.t(Message.NetworkNameUsed),
-        },
-      })
+      return addNotification({
+        ...warning,
+        content: i18n.t(Message.NetworkNameUsed),
+      })(dispatch)
     }
     return updateNetwork({
       networkID: id!,
diff --git a/packages/neuron-ui/src/containers/Notification/index.tsx b/packages/neuron-ui/src/containers/Notification/index.tsx
@@ -1,10 +1,15 @@
-import React, { useContext, useCallback } from 'react'
+import React, { useContext, useMemo, useCallback, MouseEventHandler } from 'react'
 import { createPortal } from 'react-dom'
 import { RouteComponentProps } from 'react-router-dom'
 import { useTranslation } from 'react-i18next'
-import { MessageBar, MessageBarType, IconButton } from 'office-ui-fabric-react'
+import { Stack, MessageBar, MessageBarType, IconButton, Panel, PanelType, Text } from 'office-ui-fabric-react'
 import { NeuronWalletContext } from 'states/stateProvider'
-import { StateWithDispatch, AppActions } from 'states/stateProvider/reducer'
+import { StateWithDispatch, StateDispatch } from 'states/stateProvider/reducer'
+import {
+  toggleAllNotificationVisibility,
+  toggleTopAlertVisibility,
+  dismissNotification,
+} from 'states/stateProvider/actionCreators'
 import styles from './Notification.module.scss'
 
 const notificationType = (type: 'success' | 'warning' | 'alert') => {
@@ -24,27 +29,61 @@ const notificationType = (type: 'success' | 'warning' | 'alert') => {
   }
 }
 
-const DismissButton = ({ onDismiss }: { onDismiss: React.MouseEventHandler<HTMLButtonElement> }) => (
+const DismissTopAlertButton = ({ onDismiss }: { onDismiss: React.MouseEventHandler<HTMLButtonElement> }) => (
   <IconButton iconProps={{ iconName: 'Dismiss' }} onClick={onDismiss} />
 )
 
-const NoticeContent = ({ dispatch }: React.PropsWithoutRef<StateWithDispatch & RouteComponentProps>) => {
+const TopAlertActions = ({
+  count = 0,
+  dispatch,
+  onDismiss,
+}: {
+  count: number
+  dispatch: StateDispatch
+  onDismiss: MouseEventHandler
+}) => (
+  <Stack horizontal verticalAlign="center">
+    {count > 1 ? (
+      <IconButton
+        iconProps={{ iconName: 'More' }}
+        onClick={() => {
+          toggleAllNotificationVisibility()(dispatch)
+        }}
+      >
+        more
+      </IconButton>
+    ) : null}
+    <DismissTopAlertButton onDismiss={onDismiss} />
+  </Stack>
+)
+
+export const NoticeContent = ({ dispatch }: React.PropsWithoutRef<StateWithDispatch & RouteComponentProps>) => {
   const {
-    app: { notifications = [], popups = [] },
+    app: { notifications = [], popups = [], showTopAlert = false, showAllNotifications = false },
   } = useContext(NeuronWalletContext)
   const [t] = useTranslation()
-  const onDismiss = useCallback(() => {
-    dispatch({
-      type: AppActions.ClearNotifications,
-      payload: null,
-    })
+
+  const notificationsInDesc = useMemo(() => [...notifications].reverse(), [notifications])
+  const notification: State.Message | undefined = notificationsInDesc[0]
+
+  const onTopAlertDismiss = useCallback(() => {
+    toggleTopAlertVisibility(false)(dispatch)
   }, [dispatch])
 
-  const notification = notifications[0]
+  const onPanelDismiss = useCallback(() => {
+    toggleAllNotificationVisibility()(dispatch)
+  }, [dispatch])
+
+  const onNotificationDismiss = useCallback(
+    (timestamp: number) => () => {
+      dismissNotification(timestamp)(dispatch)
+    },
+    [dispatch]
+  )
 
   return (
     <div>
-      {notifications.length ? (
+      {showTopAlert && notificationsInDesc.length ? (
         <MessageBar
           messageBarType={notificationType(notification.type)}
           styles={{
@@ -56,18 +95,70 @@ const NoticeContent = ({ dispatch }: React.PropsWithoutRef<StateWithDispatch & R
               marginRight: '12px',
             },
           }}
-          actions={<DismissButton onDismiss={onDismiss} />}
+          actions={
+            <TopAlertActions dispatch={dispatch} count={notificationsInDesc.length} onDismiss={onTopAlertDismiss} />
+          }
         >
           {t(notification.content)}
         </MessageBar>
       ) : null}
+
       <div className={styles.autoDismissMessages}>
         {popups.map(popup => (
           <MessageBar key={`${popup.timestamp}`} messageBarType={MessageBarType.success}>
             {t(popup.text)}
           </MessageBar>
         ))}
       </div>
+
+      <Panel
+        isOpen={showAllNotifications}
+        type={PanelType.smallFixedFar}
+        onDismiss={onPanelDismiss}
+        headerText={t('notification-panel.title')}
+        isHiddenOnDismiss
+        isLightDismiss
+        styles={{
+          header: {
+            padding: '0 5px!important',
+          },
+          content: {
+            padding: '0!important',
+          },
+          navigation: {
+            display: 'none',
+          },
+        }}
+      >
+        {notificationsInDesc.map(n => {
+          return (
+            <Stack
+              key={n.timestamp}
+              styles={{
+                root: {
+                  padding: '5px 15px',
+                  boxShadow: '1px 1px 3px rgba(0,0,0,0.1)',
+                  borderLeft: `4px solid`,
+                  borderLeftColor: n.type === 'warning' ? '#fff176ba' : '#ff3d00ba',
+                  margin: '10px 0',
+                },
+              }}
+            >
+              <Stack horizontal horizontalAlign="space-between" verticalAlign="center">
+                <Text
+                  styles={{
+                    root: [{ textTransform: 'capitalize' }],
+                  }}
+                >
+                  {t(`message-types.${n.type}`)}
+                </Text>
+                <IconButton iconProps={{ iconName: 'Dismiss' }} onClick={onNotificationDismiss(n.timestamp)} />
+              </Stack>
+              <Text as="p">{t(n.content)}</Text>
+            </Stack>
+          )
+        })}
+      </Panel>
     </div>
   )
 }
diff --git a/packages/neuron-ui/src/locales/en.json b/packages/neuron-ui/src/locales/en.json
@@ -193,6 +193,14 @@
       "cancel": "Cancel",
       "save": "Save"
     },
+    "notification-panel": {
+      "title": "Notifications"
+    },
+    "message-types": {
+      "warning": "warning",
+      "alert": "alert",
+      "success": "success"
+    },
     "messages": {
       "at-least-one-address-needed": "At least one address needed",
       "name-required": "Name is required",
diff --git a/packages/neuron-ui/src/locales/zh.json b/packages/neuron-ui/src/locales/zh.json
@@ -193,6 +193,14 @@
       "cancel": "取消",
       "save": "保存"
     },
+    "notification-panel": {
+      "title": "通知中心"
+    },
+    "message-types": {
+      "warning": "警告",
+      "alert": "错误",
+      "success": "成功"
+    },
     "messages": {
       "at-least-one-address-needed": "需要至少一个地址",
       "name-required": "缺少名称",
diff --git a/packages/neuron-ui/src/states/initStates/app.ts b/packages/neuron-ui/src/states/initStates/app.ts
@@ -39,6 +39,8 @@ const appState: State.App = {
     transactionList: false,
     updateDescription: false,
   },
+  showTopAlert: false,
+  showAllNotifications: false,
 }
 
 export default appState
diff --git a/packages/neuron-ui/src/states/stateProvider/actionCreators/app.ts b/packages/neuron-ui/src/states/stateProvider/actionCreators/app.ts
@@ -74,7 +74,22 @@ export const initAppState = () => (dispatch: StateDispatch, history: any) => {
     })
 }
 
-export const addNotification = ({ type, content }: { type: 'alert'; content: string }) => (dispatch: StateDispatch) => {
+export const addPopup = (text: string) => (dispatch: StateDispatch) => {
+  dispatch({
+    type: AppActions.PopIn,
+    payload: { text: `messages.${text}`, timestamp: Date.now() },
+  })
+  setTimeout(() => {
+    dispatch({
+      type: AppActions.PopOut,
+      payload: null,
+    })
+  }, 8000)
+}
+
+export const addNotification = ({ type, content }: { type: 'alert' | 'warning'; content: string }) => (
+  dispatch: StateDispatch
+) => {
   dispatch({
     type: AppActions.AddNotification,
     payload: {
@@ -84,22 +99,32 @@ export const addNotification = ({ type, content }: { type: 'alert'; content: str
     },
   })
 }
+export const dismissNotification = (timestamp: number) => (dispatch: StateDispatch) => {
+  dispatch({
+    type: AppActions.DismissNotification,
+    payload: timestamp,
+  })
+}
 
-export const addPopup = (text: string) => (dispatch: StateDispatch) => {
+export const toggleTopAlertVisibility = (show?: boolean) => (dispatch: StateDispatch) => {
   dispatch({
-    type: AppActions.PopIn,
-    payload: { text: `messages.${text}`, timestamp: Date.now() },
+    type: AppActions.ToggleTopAlertVisibility,
+    payload: show,
+  })
+}
+
+export const toggleAllNotificationVisibility = (show?: boolean) => (dispatch: StateDispatch) => {
+  dispatch({
+    type: AppActions.ToggleAllNotificationVisibility,
+    payload: show,
   })
-  setTimeout(() => {
-    dispatch({
-      type: AppActions.PopOut,
-      payload: null,
-    })
-  }, 8000)
 }
 
 export default {
   initAppState,
   addNotification,
   addPopup,
+  dismissNotification,
+  toggleTopAlertVisibility,
+  toggleAllNotificationVisibility,
 }
diff --git a/packages/neuron-ui/src/states/stateProvider/reducer.ts b/packages/neuron-ui/src/states/stateProvider/reducer.ts
diff --git a/packages/neuron-ui/src/types/App/index.d.ts b/packages/neuron-ui/src/types/App/index.d.ts
diff --git a/packages/neuron-ui/src/utils/loadTheme.tsx b/packages/neuron-ui/src/utils/loadTheme.tsx

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ const appState: State.App = {`
`39`	`39`	`transactionList: false,`
`40`	`40`	`updateDescription: false,`
`41`	`41`	`},`
	`42`	`+ showTopAlert: false,`
	`43`	`+ showAllNotifications: false,`
`42`	`44`	`}`
`43`	`45`
`44`	`46`	`export default appState`