add event documentation

department-of-veterans-affairs · Jan 7, 2025 · 6968d5d · 6968d5d
1 parent 768070c
commit 6968d5d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/web-components/src/components.d.ts b/packages/web-components/src/components.d.ts
@@ -3219,6 +3219,9 @@ declare namespace LocalJSX {
           * If `true`, doesn't fire the CustomEvent which can be used for analytics tracking.
          */
         "disableAnalytics"?: boolean;
+        /**
+          * The event will fire when the Expand/Collapse All button is clicked. It will emit the status of the accordion items as either "allOpen" or "allClosed".
+         */
         "onAccordionExpandCollapseAll"?: (event: VaAccordionCustomEvent<any>) => void;
         /**
           * The event used to track usage of the component. This is emitted when an accordion item is toggled and disableAnalytics is not true.

diff --git a/packages/web-components/src/components/va-accordion/va-accordion.tsx b/packages/web-components/src/components/va-accordion/va-accordion.tsx
@@ -85,6 +85,10 @@ export class VaAccordion {
   })
   componentLibraryAnalytics: EventEmitter;
 
+  /**
+   * The event will fire when the Expand/Collapse All button is clicked. It will
+   * emit the status of the accordion items as either "allOpen" or "allClosed".
+   */
   @Event({
     composed: true,
     bubbles: true,