docs(jsdocs): update jsdocs

BREAKING CHANGE: The auroInput-validated and auroInput-helpText events have been deprecated and replaced by auroFormElement-validated.
AlaskaAirlines · May 9, 2024 · 4352348 · 4352348
1 parent 4454f73
commit 4352348
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 18 deletions.
diff --git a/demo/api.md b/demo/api.md
@@ -79,13 +79,12 @@
 
 ## Events
 
-| Event                      | Type               | Description                                      |
-|----------------------------|--------------------|--------------------------------------------------|
-| `auroInput-helpText`       |                    | Notifies that the helpText message has changed.  |
-| `auroInput-ready`          | `CustomEvent<any>` | Notifies that the component has finished initializing. |
-| `auroInput-validated`      |                    | Notifies that the `validity` value has changed.  |
-| `auroInput-validityChange` | `CustomEvent<any>` |                                                  |
-| [input](#input)                    |                    | Event fires when the value of an `auro-input` has been changed. |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroFormElement-validated` |                    | Notifies that the `validity` and `errorMessage` value has changed. |
+| `auroInput-ready`           | `CustomEvent<any>` |                                                  |
+| `auroInput-validityChange`  | `CustomEvent<any>` |                                                  |
+| [input](#input)                     |                    | Event fires when the value of an `auro-input` has been changed. |
 
 ## Slots
 

diff --git a/docs/api.md b/docs/api.md
@@ -58,13 +58,12 @@
 
 ## Events
 
-| Event                      | Type               | Description                                      |
-|----------------------------|--------------------|--------------------------------------------------|
-| `auroInput-helpText`       |                    | Notifies that the helpText message has changed.  |
-| `auroInput-ready`          | `CustomEvent<any>` | Notifies that the component has finished initializing. |
-| `auroInput-validated`      |                    | Notifies that the `validity` value has changed.  |
-| `auroInput-validityChange` | `CustomEvent<any>` |                                                  |
-| `input`                    |                    | Event fires when the value of an `auro-input` has been changed. |
+| Event                       | Type               | Description                                      |
+|-----------------------------|--------------------|--------------------------------------------------|
+| `auroFormElement-validated` |                    | Notifies that the `validity` and `errorMessage` value has changed. |
+| `auroInput-ready`           | `CustomEvent<any>` |                                                  |
+| `auroInput-validityChange`  | `CustomEvent<any>` |                                                  |
+| `input`                     |                    | Event fires when the value of an `auro-input` has been changed. |
 
 ## Slots
 

diff --git a/src/base-input.js b/src/base-input.js
@@ -71,11 +71,8 @@ import AuroFormValidation from '@aurodesignsystem/auro-formvalidation/src/valida
  * @csspart helpText - Use for customizing the style of the helpText element
  * @csspart accentIcon - Use for customizing the style of the accentIcon element (e.g. credit card icon, calendar icon)
  * @csspart iconContainer - Use for customizing the style of the iconContainer (e.g. X icon for clearing input value)
- *
  * @event input - Event fires when the value of an `auro-input` has been changed.
- * @event auroInput-helpText - Notifies that the helpText message has changed.
- * @event auroInput-ready - Notifies that the component has finished initializing.
- * @event auroInput-validated - Notifies that the `validity` value has changed.
+ * @event auroFormElement-validated - Notifies that the `validity` and `errorMessage` value has changed.
  */
 
 export default class BaseInput extends LitElement {