fix(popover): fire "click:outside" event when clicking sibling elements (#1570)

COMPONENT_INDEX.md

@@ -2805,8 +2805,8 @@ None.
 ### Events
 
 | Event name    | Type       | Detail                                |
-| :------------ | :--------- | :---------------- |
+| :------------ | :--------- | :------------------------------------ |
-| click:outside | dispatched | <code>null</code> |
+| click:outside | dispatched | <code>{ target: HTMLElement; }</code> |
 
 ## `ProgressBar`
 

docs/src/COMPONENT_API.json

@@ -8908,7 +8908,11 @@
       "moduleExports": [],
       "slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
       "events": [
-        { "type": "dispatched", "name": "click:outside", "detail": "null" }
+        {
+          "type": "dispatched",
+          "name": "click:outside",
+          "detail": "{ target: HTMLElement; }"
+        }
       ],
       "typedefs": [],
       "rest_props": { "type": "Element", "name": "div" }

docs/src/pages/components/Popover.svx

@@ -36,6 +36,12 @@ Set `closeOnOutsideClick` to set `open` to `false` when clicking outside of the
     </Popover>
 </div>
 
+## Manage open state with a Button
+
+You can bind the `open` prop and manage the open state of the popover with an external button.
+
+<FileSource src="/framed/Popover/WithButton" />
+
 ## Popover alignment
 
 Customize the popover alignment using the `align` prop. Valid values include: `"top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-bottom" | "left-top" | "right" | "right-bottom" | "right-top"`.

docs/src/pages/framed/Popover/WithButton.svelte

@@ -0,0 +1,37 @@
+<script>
+  import { Popover, Button } from "carbon-components-svelte";
+
+  let open = true;
+  let containerRef = null;
+</script>
+
+<div data-outline>
+  <div
+    bind:this="{containerRef}"
+    style:position="relative"
+    style:display="inline-block"
+  >
+    <Button on:click="{() => (open = !open)}">Click to open</Button>
+    <Popover
+      bind:open
+      align="bottom-left"
+      on:click:outside="{({ detail }) => {
+        console.log('on:click:outside');
+        if (!containerRef.contains(detail.target)) {
+          open = false;
+        }
+      }}"
+    >
+      <div style="padding: var(--cds-spacing-05)">Content</div>
+    </Popover>
+  </div>
+  <div>
+    <br />
+    Anim eu laboris veniam in est elit ullamco enim irure id. Lorem est culpa ex
+    in enim enim. Culpa quis incididunt magna officia et aliqua. Ullamco deserunt
+    aute enim cupidatat. Culpa quis enim sint sint anim qui irure exercitation labore
+    occaecat in reprehenderit proident. Nisi laborum ut et amet commodo amet ullamco
+    commodo non aliqua magna ad eu. Ad aliquip minim nostrud id enim elit velit ullamco
+    pariatur eu excepteur pariatur cillum.
+  </div>
+</div>

src/Popover/Popover.svelte

@@ -1,4 +1,8 @@
 <script>
+  /**
+   * @event {{ target: HTMLElement; }} click:outside
+   */
+
   /** Set to `true` to display the popover */
   export let open = false;
 
@@ -33,8 +37,8 @@
 <svelte:window
   on:click="{(e) => {
     if (!open) return;
-    if (e.target.contains(ref)) {
+    if (!ref.contains(e.target)) {
-      dispatch('click:outside');
+      dispatch('click:outside', { target: e.target });
       if (closeOnOutsideClick) open = false;
     }
   }}"

types/Popover/Popover.svelte.d.ts

@@ -60,6 +60,6 @@ export interface PopoverProps
 
 export default class Popover extends SvelteComponentTyped<
   PopoverProps,
-  { ["click:outside"]: CustomEvent<null> },
+  { ["click:outside"]: CustomEvent<{ target: HTMLElement }> },
   { default: {} }
 > {}