Skip to content

Commit e70b142

Browse files
authored
docs: document custom field internal-tab event (#4061)
1 parent ddf79a5 commit e70b142

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

‎packages/custom-field/src/vaadin-custom-field.d.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,19 @@ export type CustomFieldInvalidChangedEvent = CustomEvent<{ value: boolean }>;
3535
*/
3636
export type CustomFieldValueChangedEvent = CustomEvent<{ value: string }>;
3737

38+
/**
39+
* Fired on Tab keydown triggered from the internal inputs, meaning focus will not leave the inputs.
40+
*/
41+
export type CustomFieldInternalTabEvent = Event & {
42+
target: CustomField;
43+
};
44+
3845
export interface CustomFieldCustomEventMap {
3946
'invalid-changed': CustomFieldInvalidChangedEvent;
4047

4148
'value-changed': CustomFieldValueChangedEvent;
49+
50+
'internal-tab': CustomFieldInternalTabEvent;
4251
}
4352

4453
export interface CustomFieldEventMap extends HTMLElementEventMap, CustomFieldCustomEventMap {

‎packages/custom-field/test/typings/custom-field.types.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import '../../vaadin-custom-field.js';
22
import {
33
CustomField,
44
CustomFieldChangeEvent,
5+
CustomFieldInternalTabEvent,
56
CustomFieldInvalidChangedEvent,
67
CustomFieldValueChangedEvent,
78
} from '../../vaadin-custom-field.js';
@@ -24,3 +25,8 @@ customField.addEventListener('value-changed', (event) => {
2425
assertType<CustomFieldValueChangedEvent>(event);
2526
assertType<string>(event.detail.value);
2627
});
28+
29+
customField.addEventListener('internal-tab', (event) => {
30+
assertType<CustomFieldInternalTabEvent>(event);
31+
assertType<CustomField>(event.target);
32+
});

0 commit comments

Comments
 (0)