Conversation
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
|
We detected some changes in |
| 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. |
There was a problem hiding this comment.
Since consent components is a bit vague, maybe we can specifically call out the consent checkbox and consent phone field components?
| 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`. |
There was a problem hiding this comment.
How do these intersect with the result of allow and disallow? Maybe we can give a quick example?
| * 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. |
There was a problem hiding this comment.
| * 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. |
| * 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 |
There was a problem hiding this comment.
| * 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 |
| * 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. |
There was a problem hiding this comment.
| * - `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. |
| * 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. |
There was a problem hiding this comment.
| * In this state, `onClick` will not fire. | |
| * In this state, `click` won't fire. |
| * @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). |
There was a problem hiding this comment.
| * 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
force-pushed
the
fix/ca-docs-cleanup-2025-10
branch
from
da465ce to
f037a24
Compare
2 participants
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