docs!: deprecate internal-tab event and remove it from JSDoc (#7889)

vaadin · Sep 30, 2024 · f5b1dc8 · f5b1dc8
1 parent 783abaa
commit f5b1dc8
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 2 deletions.
diff --git a/packages/custom-field/src/vaadin-custom-field.d.ts b/packages/custom-field/src/vaadin-custom-field.d.ts
@@ -33,6 +33,7 @@ export type CustomFieldValidatedEvent = CustomEvent<{ valid: boolean }>;
 
 /**
  * Fired on Tab keydown triggered from the internal inputs, meaning focus will not leave the inputs.
+ * @deprecated
  */
 export type CustomFieldInternalTabEvent = Event & {
   target: CustomField;
@@ -91,7 +92,6 @@ export interface CustomFieldEventMap extends HTMLElementEventMap, CustomFieldCus
  * See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
  *
  * @fires {Event} change - Fired when the user commits a value change for any of the internal inputs.
- * @fires {Event} internal-tab - Fired on Tab keydown triggered from the internal inputs, meaning focus will not leave the inputs.
  * @fires {CustomEvent} invalid-changed - Fired when the `invalid` property changes.
  * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
  * @fires {CustomEvent} validated - Fired whenever the field is validated.

diff --git a/packages/custom-field/src/vaadin-custom-field.js b/packages/custom-field/src/vaadin-custom-field.js
@@ -51,7 +51,6 @@ registerStyles('vaadin-custom-field', customFieldStyles, { moduleId: 'vaadin-cus
  * See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
  *
  * @fires {Event} change - Fired when the user commits a value change for any of the internal inputs.
- * @fires {Event} internal-tab - Fired on Tab keydown triggered from the internal inputs, meaning focus will not leave the inputs.
  * @fires {CustomEvent} invalid-changed - Fired when the `invalid` property changes.
  * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
  * @fires {CustomEvent} validated - Fired whenever the field is validated.