From 5576c7ce84e4fd444033b494c08a93b88f6d693a Mon Sep 17 00:00:00 2001
From: metonym <ericyl.us@gmail.com>
Date: Thu, 12 May 2022 20:23:16 -0700
Subject: [PATCH] fix(header-action): type missing "open" event (#1293)

* fix(header-action): type missing "open" event

* Run "yarn build:docs"

* test(header-utilities): assert "open" and "close" events
---
 COMPONENT_INDEX.md                     | 9 +++++----
 docs/src/COMPONENT_API.json            | 5 +++--
 src/UIShell/HeaderAction.svelte        | 5 +++++
 tests/HeaderUtilities.test.svelte      | 2 ++
 types/UIShell/HeaderAction.svelte.d.ts | 6 +++++-
 5 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
index 192fffe4..24a32634 100644
--- a/COMPONENT_INDEX.md
+++ b/COMPONENT_INDEX.md
@@ -1608,10 +1608,11 @@ None.
 
 ### Events
 
-| Event name | Type       | Detail |
-| :--------- | :--------- | :----- |
-| click      | forwarded  | --     |
-| close      | dispatched | --     |
+| Event name | Type       | Detail            |
+| :--------- | :--------- | :---------------- |
+| open       | dispatched | <code>null</code> |
+| close      | dispatched | <code>null</code> |
+| click      | forwarded  | --                |
 
 ## `HeaderActionLink`
 
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
index 6f71b1c1..2310113f 100644
--- a/docs/src/COMPONENT_API.json
+++ b/docs/src/COMPONENT_API.json
@@ -4573,8 +4573,9 @@
         }
       ],
       "events": [
-        { "type": "forwarded", "name": "click", "element": "button" },
-        { "type": "dispatched", "name": "close" }
+        { "type": "dispatched", "name": "open", "detail": "null" },
+        { "type": "dispatched", "name": "close", "detail": "null" },
+        { "type": "forwarded", "name": "click", "element": "button" }
       ],
       "typedefs": [],
       "rest_props": { "type": "Element", "name": "button" }
diff --git a/src/UIShell/HeaderAction.svelte b/src/UIShell/HeaderAction.svelte
index da47c6da..03fdb613 100644
--- a/src/UIShell/HeaderAction.svelte
+++ b/src/UIShell/HeaderAction.svelte
@@ -1,4 +1,9 @@
 <script>
+  /**
+   * @event {null} open
+   * @event {null} close
+   */
+
   /** Set to `true` to open the panel */
   export let isOpen = false;
 
diff --git a/tests/HeaderUtilities.test.svelte b/tests/HeaderUtilities.test.svelte
index c8bbaa9e..755b2fc5 100644
--- a/tests/HeaderUtilities.test.svelte
+++ b/tests/HeaderUtilities.test.svelte
@@ -33,6 +33,8 @@
     <HeaderGlobalAction aria-label="Settings" icon="{SettingsAdjust}" />
     <HeaderAction
       bind:isOpen
+      on:open
+      on:close
       transition="{{ duration: 400, easing: quintOut }}"
     >
       <HeaderPanelLinks>
diff --git a/types/UIShell/HeaderAction.svelte.d.ts b/types/UIShell/HeaderAction.svelte.d.ts
index 89c801c0..7f3ab00b 100644
--- a/types/UIShell/HeaderAction.svelte.d.ts
+++ b/types/UIShell/HeaderAction.svelte.d.ts
@@ -46,6 +46,10 @@ export interface HeaderActionProps
 
 export default class HeaderAction extends SvelteComponentTyped<
   HeaderActionProps,
-  { click: WindowEventMap["click"]; close: CustomEvent<any> },
+  {
+    open: CustomEvent<null>;
+    close: CustomEvent<null>;
+    click: WindowEventMap["click"];
+  },
   { default: {}; closeIcon: {}; icon: {}; text: {} }
 > {}