Skip to content

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

Merged
johnnie-chen merged 1 commit into
Shopify:2025-10from
johnnie-chen:johnnie/clarify-number-money-field-events-2025-10
Sep 22, 2026
Merged

johnnie-chen merged 1 commit into
Shopify:2025-10from
johnnie-chen:johnnie/clarify-number-money-field-events-2025-10

Conversation

@johnnie-chen

Copy link
Copy Markdown
Contributor

Background

NumberField and MoneyField event descriptions omit that stepping a value fires both input and change. This documents the existing shared Checkout/Customer Accounts behavior for API version 2025-10.

Backport of #4703. Source documentation change: https://meteorite.shopify.io/repos/shop/world/pulls/2079504

Solution

Clarify blur/Enter commitment and per-step input and change events. NumberField covers increment/decrement controls and arrow keys; MoneyField covers arrow keys. Update the two declaration comments and generated reference data for both surfaces. There are no runtime changes or changes to the distinct event names, optionality, or callback types.

The two event interfaces on this branch contain committed merge-conflict fragments in their JSDoc. Clean up those fragments while adding the clarification, preserving the existing callback types and MDN links. The corrupted blocks also contain duplicate blur and change declarations; retain one declaration of each with the same optional callback types. This cleanup is limited to NumberField and MoneyField; it does not change the six other affected field interfaces.

Regenerate both surfaces and retain only the two affected event-interface entries. This includes cleaning the corrupted blur descriptions as well as clarifying change/input descriptions; unrelated generator drift is excluded.

🎩

  • yarn docs:checkout 2025-10 and yarn docs:customer-account 2025-10 completed.
  • Confirmed that each generated JSON changes only the two event interfaces and that the distinct event names, optionality, and callback types are unchanged.
  • yarn lint, yarn build, yarn type-check, and git diff --check passed. Lint ran before build to avoid the existing generated-entrypoint ignore-pattern issue.
  • The identical descriptions were visually verified on all four 2026-07 local pages in [2026-07] Clarify NumberField and MoneyField event documentation #4703. This backport's generated entries were checked structurally; its pages have not been separately previewed in a browser.

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

@johnnie-chen
johnnie-chen merged commit eaec162 into Shopify:2025-10 Sep 22, 2026
9 of 10 checks passed
@johnnie-chen
johnnie-chen deleted the johnnie/clarify-number-money-field-events-2025-10 branch September 23, 2026 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants