Fix EuiOutsideClickDetector to work when its nested inside itself (#1039

)

* Fix EuiOutsideClickDetector to work when its nested inside itself

* changelog

CHANGELOG.md

@@ -7,6 +7,7 @@
 **Bug fixes**
 
 - Fixed `EuiContextMenuPanel` calling `ref` after being unmounted ([#1038](https://github.com/elastic/eui/pull/1038))
+- `EuiOutsideClickDetector` supports nested detectors in the DOM tree ([#1039](https://github.com/elastic/eui/pull/1039))
 
 **Bug Fixes**
 

src/components/outside_click_detector/outside_click_detector.js

@@ -32,7 +32,7 @@ export class EuiOutsideClickDetector extends Component {
     // virtual DOM and executes EuiClickDetector's onClick handler,
     // stamping the id even though the event originates outside
     // this component's reified DOM tree.
-    this.id = htmlIdGenerator();
+    this.id = htmlIdGenerator()();
   }
 
   onClickOutside = event => {
@@ -45,7 +45,7 @@ export class EuiOutsideClickDetector extends Component {
       return;
     }
 
-    if (event.euiGeneratedBy === this.id) {
+    if (event.euiGeneratedBy && event.euiGeneratedBy.includes(this.id)) {
       return;
     }
 
@@ -61,7 +61,13 @@ export class EuiOutsideClickDetector extends Component {
   }
 
   onChildClick = event => {
-    event.nativeEvent.euiGeneratedBy = this.id;
+    // to support nested click detectors, build an array
+    // of detector ids that have been encountered
+    if (event.nativeEvent.hasOwnProperty('euiGeneratedBy')) {
+      event.nativeEvent.euiGeneratedBy.push(this.id);
+    } else {
+      event.nativeEvent.euiGeneratedBy = [this.id];
+    }
     if (this.props.onClick) this.props.onClick(event);
   }
 

src/components/outside_click_detector/outside_click_detector.test.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import { render } from 'enzyme';
+import { render, mount } from 'enzyme';
 
 import { EuiOutsideClickDetector } from './outside_click_detector';
 
@@ -14,4 +14,45 @@ describe('EuiOutsideClickDetector', () => {
     expect(component)
       .toMatchSnapshot();
   });
+
+  describe('behavior', () => {
+    test('nested detectors', () => {
+      const unrelatedDetector = jest.fn();
+      const parentDetector = jest.fn();
+      const childDetector = jest.fn();
+
+      // enzyme doesn't mount the components into the global jsdom `document`
+      // but that's where the click detector listener is,
+      // pass the top-level mounted component's click event on to document
+      const triggerDocumentClick = e => {
+        const event = new Event('click');
+        event.euiGeneratedBy = e.nativeEvent.euiGeneratedBy;
+        document.dispatchEvent(event);
+      };
+
+      const component = mount(
+        <div onClick={triggerDocumentClick}>
+          <div>
+            <EuiOutsideClickDetector onOutsideClick={parentDetector}>
+              <div>
+                <EuiOutsideClickDetector onOutsideClick={childDetector}>
+                  <div data-test-subj="target"/>
+                </EuiOutsideClickDetector>
+              </div>
+            </EuiOutsideClickDetector>
+          </div>
+
+          <EuiOutsideClickDetector onOutsideClick={unrelatedDetector}>
+            <div/>
+          </EuiOutsideClickDetector>
+        </div>
+      );
+
+      component.find('[data-test-subj="target"]').simulate('click');
+
+      expect(unrelatedDetector).toHaveBeenCalledTimes(1);
+      expect(parentDetector).toHaveBeenCalledTimes(0);
+      expect(childDetector).toHaveBeenCalledTimes(0);
+    });
+  });
 });