Skip to content

[2025-10] Clarify NumberField and MoneyField event documentation #4707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnnie-chen merged 1 commit into from
Sep 22, 2026
+34 −62
Merged

[2025-10] Clarify NumberField and MoneyField event documentation #4707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95662,15 +95662,15 @@
"syntaxKind": "PropertySignature",
"name": "blur",
"value": "CallbackEventListener<typeof tagName>",
"description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n\nA callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).",
"description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).",
"isOptional": true
},
{
"filePath": "src/surfaces/checkout/components/MoneyField.ts",
"syntaxKind": "PropertySignature",
"name": "change",
"value": "CallbackEventListener<typeof tagName>",
"description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n\nA callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). ======= A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).",
"description": "A callback fired when the money field value is committed on blur or after pressing Enter. Also fired on each step when using the Up Arrow and Down Arrow keys.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).",
"isOptional": true
},
{
Expand All @@ -95686,11 +95686,11 @@
"syntaxKind": "PropertySignature",
"name": "input",
"value": "CallbackEventListener<typeof tagName>",
"description": "A callback fired when the user inputs data into the money field. >>>>>>> 8763c703b (Improve Forms component descriptions to match admin quality)\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).",
"description": "A callback fired when the user inputs data into the money field. Also fired on each step when using the Up Arrow and Down Arrow keys.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).",
"isOptional": true
}
],
"value": "export interface MoneyFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the user inputs data into the money field.\n>>>>>>> 8763c703b (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener<typeof tagName>;\n}"
"value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the money field value is committed on blur or after pressing Enter.\n * Also fired on each step when using the Up Arrow and Down Arrow keys.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the user inputs data into the money field.\n * Also fired on each step when using the Up Arrow and Down Arrow keys.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener<typeof tagName>;\n}"
}
},
"MoneyFieldElement": {
Expand Down Expand Up @@ -96256,15 +96256,15 @@
"syntaxKind": "PropertySignature",
"name": "blur",
"value": "CallbackEventListener<typeof tagName>",
"description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n\nA callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).",
"description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).",
"isOptional": true
},
{
"filePath": "src/surfaces/checkout/components/NumberField.ts",
"syntaxKind": "PropertySignature",
"name": "change",
"value": "CallbackEventListener<typeof tagName>",
"description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n\nA callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). ======= A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).",
"description": "A callback fired when the number field value is committed on blur or after pressing Enter. Also fired on each step when using the increment/decrement controls or the Up Arrow and Down Arrow keys.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).",
"isOptional": true
},
{
Expand All @@ -96280,11 +96280,11 @@
"syntaxKind": "PropertySignature",
"name": "input",
"value": "CallbackEventListener<typeof tagName>",
"description": "A callback fired when the user inputs data into the number field. >>>>>>> 8763c703b (Improve Forms component descriptions to match admin quality)\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).",
"description": "A callback fired when the user inputs data into the number field. Also fired on each step when using the increment/decrement controls or the Up Arrow and Down Arrow keys.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).",
"isOptional": true
}
],
"value": "export interface NumberFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the user inputs data into the number field.\n>>>>>>> 8763c703b (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener<typeof tagName>;\n}"
"value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the number field value is committed on blur or after pressing Enter.\n * Also fired on each step when using the increment/decrement controls or the Up Arrow and Down Arrow keys.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener<typeof tagName>;\n /**\n * A callback fired when the user inputs data into the number field.\n * Also fired on each step when using the increment/decrement controls or the Up Arrow and Down Arrow keys.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener<typeof tagName>;\n}"
}
},
"NumberFieldElementSlots": {
Expand Down
Loading
Loading