Merge pull request #520 from NicolasGn/master

feat: add isOpen flag to useIntercom() (re-open)

Author: devrnt

README.md

@@ -115,7 +115,12 @@ Used to retrieve all methods bundled with Intercom. These are based on the offic
 
  Make sure `IntercomProvider` is wrapped around your component when calling `useIntercom()`. 
 
-**Remark** - You can't use `useIntercom()` in the same component where `IntercomProvider` is initialized. 
+**Remark** - You can't use `useIntercom()` in the same component where `IntercomProvider` is initialized.
+
+#### State
+| name                | type             | description                                                                             |
+|---------------------|------------------|-----------------------------------------------------------------------------------------|
+| isOpen              | boolean          | the visibility status of the messenger                                                  |
 
 #### Methods
 | name            | type                                       | description                                                                                                                         |

src/provider.tsx

@@ -75,12 +75,24 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
     [apiBase, appId, shouldInitialize],
   );
 
+  const [isOpen, setIsOpen] = React.useState(false);
+
+  const onHideWrapper = React.useCallback(() => {
+    setIsOpen(false);
+    if (onHide) onHide();
+  }, [onHide, setIsOpen]);
+
+  const onShowWrapper = React.useCallback(() => {
+    setIsOpen(true);
+    if (onShow) onShow();
+  }, [onShow, setIsOpen]);
+
   if (!isSSR && shouldInitialize && !isInitialized.current) {
     initialize(appId, initializeDelay);
 
     // attach listeners
-    if (onHide) IntercomAPI('onHide', onHide);
-    if (onShow) IntercomAPI('onShow', onShow);
+    IntercomAPI('onHide', onHideWrapper);
+    IntercomAPI('onShow', onShowWrapper);
     if (onUnreadCountChange)
       IntercomAPI('onUnreadCountChange', onUnreadCountChange);
 
@@ -231,6 +243,7 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
       update,
       hide,
       show,
+      isOpen,
       showMessages,
       showNewMessages,
       getVisitorId,
@@ -245,6 +258,7 @@ export const IntercomProvider: React.FC<React.PropsWithChildren<
     update,
     hide,
     show,
+    isOpen,
     showMessages,
     showNewMessages,
     getVisitorId,

src/types.ts

@@ -314,6 +314,10 @@ export type IntercomContextValues = {
    * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#section-intercomshow}
    */
   show: () => void;
+  /**
+   * The visibility status of the messenger.
+   */
+  isOpen: boolean;
   /**
    * Opens the Messenger with the message list.
    */