docs(event): add events to jsdocs

AlaskaAirlines · May 1, 2024 · 344be6a · 344be6a
1 parent c10742b
commit 344be6a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/demo/api.md b/demo/api.md
@@ -22,9 +22,10 @@ The auro-checkbox-group element is a wrapper for auro-checkbox element.
 
 ## Events
 
-| Event   | Type               |
-|---------|--------------------|
-| [input](#input) | `CustomEvent<any>` |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroFormElement-validated` |                    | Notifies that the `validity` and `errorMessage` values have changed. |
+| [input](#input)                     | `CustomEvent<any>` |                                                  |
 
 ## Slots
 

diff --git a/docs/api.md b/docs/api.md
@@ -19,9 +19,10 @@ The auro-checkbox-group element is a wrapper for auro-checkbox element.
 
 ## Events
 
-| Event   | Type               |
-|---------|--------------------|
-| `input` | `CustomEvent<any>` |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroFormElement-validated` |                    | Notifies that the `validity` and `errorMessage` values have changed. |
+| `input`                     | `CustomEvent<any>` |                                                  |
 
 ## Slots
 

diff --git a/src/auro-checkbox-group.js b/src/auro-checkbox-group.js
@@ -28,6 +28,7 @@ import styleCss from "./auro-checkbox-group-css.js";
  * @slot {HTMLSlotElement} legend - Allows for the legend to be overridden.
  * @slot {HTMLSlotElement} optionalLabel - Allows for the optional label to be overridden.
  * @slot {HTMLSlotElement} helpText - Allows for the helper text to be overridden.
+ * @event auroFormElement-validated - Notifies that the `validity` and `errorMessage` values have changed.
  */
 
 export class AuroCheckboxGroup extends LitElement {