From 4352348ea81ddf752a27af11b3669a1fe2f54480 Mon Sep 17 00:00:00 2001 From: Jordan Jones Date: Tue, 30 Apr 2024 08:27:56 -0700 Subject: [PATCH] docs(jsdocs): update jsdocs BREAKING CHANGE: The auroInput-validated and auroInput-helpText events have been deprecated and replaced by auroFormElement-validated. --- demo/api.md | 13 ++++++------- docs/api.md | 13 ++++++------- src/base-input.js | 5 +---- 3 files changed, 13 insertions(+), 18 deletions(-) diff --git a/demo/api.md b/demo/api.md index c0e8bca..fce471b 100644 --- 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` | Notifies that the component has finished initializing. | -| `auroInput-validated` | | Notifies that the `validity` value has changed. | -| `auroInput-validityChange` | `CustomEvent` | | -| [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` | | +| `auroInput-validityChange` | `CustomEvent` | | +| [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 index 3fe388a..f9bdebb 100644 --- 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` | Notifies that the component has finished initializing. | -| `auroInput-validated` | | Notifies that the `validity` value has changed. | -| `auroInput-validityChange` | `CustomEvent` | | -| `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` | | +| `auroInput-validityChange` | `CustomEvent` | | +| `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 index a049129..8bca42b 100644 --- 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 {