fix(events): update help text event and event docs

AlaskaAirlines · May 10, 2024 · 966f7bb · 966f7bb
1 parent f168a8c
commit 966f7bb
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 11 deletions.
diff --git a/demo/api.md b/demo/api.md
@@ -28,10 +28,11 @@
 
 ## Events
 
-| Event                   | Type               | Description                                      |
-|-------------------------|--------------------|--------------------------------------------------|
-| `auroCombobox-ready`    | `CustomEvent<any>` | Notifies that the component has finished initializing. |
-| `auroCombobox-valueSet` | `CustomEvent<any>` | Notifies that the component has a new value set. |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroCombobox-ready`        | `CustomEvent<any>` | Notifies that the component has finished initializing. |
+| `auroCombobox-valueSet`     | `CustomEvent<any>` | Notifies that the component has a new value set. |
+| `auroFormElement-validated` |                    | Notifies that the component value(s) have been validated. |
 
 ## Slots
 

diff --git a/docs/api.md b/docs/api.md
@@ -25,10 +25,11 @@
 
 ## Events
 
-| Event                   | Type               | Description                                      |
-|-------------------------|--------------------|--------------------------------------------------|
-| `auroCombobox-ready`    | `CustomEvent<any>` | Notifies that the component has finished initializing. |
-| `auroCombobox-valueSet` | `CustomEvent<any>` | Notifies that the component has a new value set. |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroCombobox-ready`        | `CustomEvent<any>` | Notifies that the component has finished initializing. |
+| `auroCombobox-valueSet`     | `CustomEvent<any>` | Notifies that the component has a new value set. |
+| `auroFormElement-validated` |                    | Notifies that the component value(s) have been validated. |
 
 ## Slots
 

diff --git a/src/auro-combobox.js b/src/auro-combobox.js
@@ -40,8 +40,9 @@ import styleCss from "./style-css.js";
  * @slot - Default slot for the menu content.
  * @slot label - Defines the content of the label.
  * @slot helpText - Defines the content of the helpText.
- * @event auroCombobox-ready - Notifies that the component has finished initializing.
- * @event auroCombobox-valueSet - Notifies that the component has a new value set.
+ * @fires auroCombobox-ready - Notifies that the component has finished initializing.
+ * @fires auroCombobox-valueSet - Notifies that the component has a new value set.
+ * @fires auroFormElement-validated - Notifies that the component value(s) have been validated.
  */
 
 // build the component class
@@ -432,7 +433,7 @@ export class AuroCombobox extends LitElement {
       }
     });
 
-    this.input.addEventListener('auroInput-helpText', (evt) => {
+    this.input.addEventListener('auroFormElement-validated', (evt) => {
       this.auroInputHelpText = evt.detail.message;
     });
   }