Fix CA docs cleanup (2025-10) by sordaz00 · Pull Request #4317 · Shopify/ui-extensions

sordaz00 · 2026-04-17T22:21:31Z

Cascaded from 2026-04. Fixes ConsentPolicy, commandFor, code formatting, and style issues.

25/26 fixes applied. shared.ts @see tags were already inlined on this branch.

Made with Cursor

github-actions · 2026-04-17T22:21:39Z

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

github-actions · 2026-04-17T22:21:44Z

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

mcvinci

Nice work, @sordaz00! Added a few minor suggestions.

mcvinci · 2026-04-17T23:58:43Z

 export type TextAutocompleteField = ExtractStrict<AnyAutocompleteField, "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "nickname" | "one-time-code" | "organization-title" | "organization" | "postal-code" | "sex" | "street-address" | "transaction-currency" | "username" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-type">;
-/** @publicDocs */
+/**
+ * The policy for which buyer consent is being collected. Used by consent components to identify the type of marketing permission requested.


Since consent components is a bit vague, maybe we can specifically call out the consent checkbox and consent phone field components?

mcvinci · 2026-04-17T23:59:39Z

 	disallow?: string;
 	/**
-	 * Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
+	 * Restricts which days of the week the user can select. These intersect with the result of `allow` and `disallow`.


How do these intersect with the result of allow and disallow? Maybe we can give a quick example?

mcvinci · 2026-04-17T23:59:58Z

-	 * It’s important to note that this callback will be called only when the user **finishes editing** the date,
-	 * and it’s called right after the `onChange` callback.
-	 * The field is **not** validated on every change to the input. Once the buyer has signalled that
+	 * This callback fires only when the user **finishes editing** the date, right after the `onChange` callback.


Suggested change

* This callback fires only when the user **finishes editing** the date, right after the `onChange` callback.

* This callback fires only when the user finishes editing the date, right after the `change` callback.

mcvinci · 2026-04-18T00:00:16Z

-	 * and it’s called right after the `onChange` callback.
-	 * The field is **not** validated on every change to the input. Once the buyer has signalled that
+	 * This callback fires only when the user **finishes editing** the date, right after the `onChange` callback.
+	 * The field is **not** validated on every change to the input. Once the user has signalled that


Suggested change

* The field is **not** validated on every change to the input. Once the user has signalled that

* The field isn't validated on every change to the input. Once the user has signalled that

mcvinci · 2026-04-18T00:00:28Z

 	 * Adjust the padding of all edges.
 	 *
-	 * - `base`: Applies padding that is appropriate for the element. Note that it may result in no padding if Shopify believes this is the right design decision in a particular context.
+	 * - `base`: Applies padding that is appropriate for the element. This may result in no padding if Shopify determines that is the right design decision for a particular context.


Suggested change

* - `base`: Applies padding that is appropriate for the element. This may result in no padding if Shopify determines that is the right design decision for a particular context.

* - `base`: Applies padding that is appropriate for the element. This might result in no padding if Shopify determines that is the right design decision for a particular context.

mcvinci · 2026-04-18T00:00:44Z

 	 * Disables the clickable, meaning it cannot be clicked or receive focus.
 	 *
-	 * In this state, onClick will not fire.
+	 * In this state, `onClick` will not fire.


Suggested change

* In this state, `onClick` will not fire.

* In this state, `click` won't fire.

mcvinci · 2026-04-18T00:01:22Z

   * @example 'customer-account.order-status.block.render'
-   * @see /docs/api/customer-account-ui-extensions/extension-targets-overview
-   * @see /docs/apps/app-extensions/configuration#targets
+   * Learn more about [extension targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview) and [target configuration](/docs/apps/app-extensions/configuration#targets).


Suggested change

* Learn more about [extension targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview) and [target configuration](/docs/apps/app-extensions/configuration#targets).

* Learn more about [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/targets) and [target configuration](/docs/api/customer-account-ui-extensions/{API_VERSION}#configuration).

…yle cleanup Made-with: Cursor

sordaz00 added the Customer account UI extensions label Apr 17, 2026

mcvinci approved these changes Apr 18, 2026

View reviewed changes

This was referenced Apr 18, 2026

Fix CA docs cleanup (2026-01) #4316

Merged

Fix CA docs cleanup (2026-07-rc) #4315

Merged

Fix CA docs: ConsentPolicy, commandFor alignment, code formatting, style cleanup #4314

Merged

Fix CA docs: ConsentPolicy, commandFor alignment, code formatting, st…

f037a24

…yle cleanup Made-with: Cursor

sordaz00 force-pushed the fix/ca-docs-cleanup-2025-10 branch from da465ce to f037a24 Compare April 20, 2026 01:35

sordaz00 merged commit 58b013f into 2025-10 Apr 20, 2026
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix CA docs cleanup (2025-10)#4317

Fix CA docs cleanup (2025-10)#4317
sordaz00 merged 1 commit into2025-10from
fix/ca-docs-cleanup-2025-10

sordaz00 commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026

Uh oh!

mcvinci left a comment

Uh oh!

mcvinci Apr 17, 2026

Uh oh!

mcvinci Apr 17, 2026

Uh oh!

mcvinci Apr 17, 2026

Uh oh!

mcvinci Apr 18, 2026

Uh oh!

mcvinci Apr 18, 2026

Uh oh!

mcvinci Apr 18, 2026

Uh oh!

mcvinci Apr 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	* This callback fires only when the user finishes editing the date, right after the `onChange` callback.
	* This callback fires only when the user finishes editing the date, right after the `change` callback.

	* The field is not validated on every change to the input. Once the user has signalled that
	* The field isn't validated on every change to the input. Once the user has signalled that

	* - `base`: Applies padding that is appropriate for the element. This may result in no padding if Shopify determines that is the right design decision for a particular context.
	* - `base`: Applies padding that is appropriate for the element. This might result in no padding if Shopify determines that is the right design decision for a particular context.

	* In this state, `onClick` will not fire.
	* In this state, `click` won't fire.

	* Learn more about [extension targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview) and [target configuration](/docs/apps/app-extensions/configuration#targets).
	* Learn more about [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/targets) and [target configuration](/docs/api/customer-account-ui-extensions/{API_VERSION}#configuration).

Conversation

sordaz00 commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

What should I do?

Uh oh!

github-actions Bot commented Apr 17, 2026

Uh oh!

mcvinci left a comment

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

mcvinci Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants