Skip to content

Commit 601c997

Browse files
authored
Merge pull request #4315 from Shopify/fix/ca-docs-cleanup-2026-07-rc
Fix CA docs cleanup (2026-07-rc)
2 parents bc38ee3 + 5513981 commit 601c997

File tree

7 files changed

+36
-53
lines changed

7 files changed

+36
-53
lines changed

packages/ui-extensions/src/surfaces/checkout/components/MapMarker.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ declare const tagName = "s-map-marker";
4141
/** @publicDocs */
4242
export interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibilityLabel' | 'blockSize' | 'command' | 'commandFor' | 'clusterable' | 'inlineSize' | 'latitude' | 'longitude'> {
4343
/**
44-
* Sets the action the `commandFor` target should take when this marker is activated. See the documentation of particular components for the actions they support. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
44+
* Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
4545
*
4646
* - `--auto`: a default action for the target component.
4747
* - `--show`: shows the target component.
@@ -52,7 +52,7 @@ export interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibi
5252
*/
5353
command?: Extract<MapMarkerProps$1['command'], '--auto' | '--show' | '--hide' | '--toggle'>;
5454
/**
55-
* The ID of a component that should respond to activations (for example, clicks) on this component. Refer to the `command` property for how to control the behavior of the target. Learn more about the [`commandfor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
55+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
5656
*/
5757
commandFor?: MapMarkerProps$1['commandFor'];
5858
}

packages/ui-extensions/src/surfaces/checkout/components/Progress.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface ProgressElementProps extends Pick<ProgressProps$1, 'accessibili
2727
*/
2828
accessibilityLabel?: ProgressProps$1['accessibilityLabel'];
2929
/**
30-
* The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.
30+
* The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.
3131
*
3232
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
3333
*
@@ -44,7 +44,7 @@ export interface ProgressElementProps extends Pick<ProgressProps$1, 'accessibili
4444
*/
4545
tone?: Extract<ProgressProps$1['tone'], 'auto' | 'critical'>;
4646
/**
47-
* How much of the task has been completed. Must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
47+
* How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
4848
*
4949
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
5050
*/

packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1534,7 +1534,7 @@ export interface MultipleInputProps extends BaseInputProps {
15341534
*/
15351535
onInput?: (event: Event) => void;
15361536
/**
1537-
* An array of the `value`s of the selected options.
1537+
* An array of `value` attributes for the currently selected options.
15381538
*
15391539
* This is a convenience prop for setting the `selected` prop on child options.
15401540
*/
@@ -2044,9 +2044,8 @@ export type AutocompleteAddressGroup = "fax" | "home" | "mobile" | "pager";
20442044
export type AnyAutocompleteField = "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "current-password" | "email" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "new-password" | "nickname" | "one-time-code" | "organization-title" | "organization" | "photo" | "postal-code" | "sex" | "street-address" | "transaction-amount" | "transaction-currency" | "url" | "username" | "bday-day" | "bday-month" | "bday-year" | "bday" | "cc-additional-name" | "cc-expiry-month" | "cc-expiry-year" | "cc-expiry" | "cc-family-name" | "cc-given-name" | "cc-name" | "cc-number" | "cc-csc" | "cc-type" | `${AutocompleteAddressGroup} email` | "impp" | `${AutocompleteAddressGroup} impp` | "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`;
20452045
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">;
20462046
/**
2047-
* The type of consent policy being collected.
2048-
*
2049-
* - `'sms-marketing'`: Represents the policy for SMS marketing consent.
2047+
* The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.
2048+
* @publicDocs
20502049
*/
20512050
export type ConsentPolicy = "sms-marketing";
20522051
interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
@@ -2058,11 +2057,9 @@ interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
20582057
export type PhoneAutocompleteField = ExtractStrict<AnyAutocompleteField, "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`>;
20592058
interface PhoneFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<FieldDecorationProps, "accessory">, AutocompleteProps<PhoneAutocompleteField> {
20602059
/**
2061-
* The type of number to collect.
2062-
*
2063-
* Specific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.
2060+
* The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.
20642061
*
2065-
* @default '' meaning no specific kind of phone number
2062+
* @default ''
20662063
*/
20672064
type?: "mobile" | "";
20682065
}
@@ -2106,9 +2103,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
21062103
*/
21072104
type?: "single" | "multiple" | "range";
21082105
/**
2109-
* Dates that can be selected.
2110-
*
2111-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
2106+
* Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.
21122107
*
21132108
* The default `''` allows all dates.
21142109
*
@@ -2159,7 +2154,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
21592154
*/
21602155
disallow?: string;
21612156
/**
2162-
* Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
2157+
* Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.
21632158
*
21642159
* A comma-separated list of days. Whitespace is allowed after commas.
21652160
*
@@ -2239,10 +2234,8 @@ interface DateFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<DatePic
22392234
*
22402235
* Disallowed dates are considered invalid.
22412236
*
2242-
* It’s important to note that this callback will be called only when the user **finishes editing** the date,
2243-
* and it’s called right after the `onChange` callback.
2244-
* The field is **not** validated on every change to the input. Once the buyer has signalled that
2245-
* they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
2237+
* This callback fires only when the user finishes editing the date, right after the `change` callback.
2238+
* The field isn't validated on every change to the input. Once the user has finished editing the field (typically by blurring it), the field is validated and the callback fires if the value is invalid.
22462239
*/
22472240
onInvalid?: (event: Event) => void;
22482241
}
@@ -3073,13 +3066,13 @@ interface ProgressProps$1 extends GlobalProps {
30733066
*/
30743067
tone?: ToneKeyword;
30753068
/**
3076-
* How much of the task has been completed. Must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
3069+
* How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
30773070
*
30783071
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
30793072
*/
30803073
value?: number;
30813074
/**
3082-
* The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.
3075+
* The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.
30833076
*
30843077
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
30853078
*
@@ -3213,7 +3206,7 @@ interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEvent
32133206
/**
32143207
* Adjust the padding of all edges.
32153208
*
3216-
* - `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.
3209+
* - `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.
32173210
* - `none`: Removes all padding from the element. This can be useful when elements inside the sheet need to span to the edge of the sheet. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
32183211
*
32193212
* @default 'base'

packages/ui-extensions/src/surfaces/checkout/components/components.d.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1517,7 +1517,7 @@ export interface MultipleInputProps extends BaseInputProps {
15171517
*/
15181518
onInput?: (event: Event) => void;
15191519
/**
1520-
* An array of the `value`s of the selected options.
1520+
* An array of `value` attributes for the currently selected options.
15211521
*
15221522
* This is a convenience prop for setting the `selected` prop on child options.
15231523
*/
@@ -1907,7 +1907,7 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
19071907
/**
19081908
* Disables the clickable, meaning it cannot be clicked or receive focus.
19091909
*
1910-
* In this state, onClick will not fire.
1910+
* In this state, `click` won't fire.
19111911
* If the click event originates from a child element, the event will immediately stop propagating from this element.
19121912
*
19131913
* However, items within the clickable can still receive focus and be interacted with.
@@ -2094,9 +2094,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
20942094
*/
20952095
type?: "single" | "multiple" | "range";
20962096
/**
2097-
* Dates that can be selected.
2098-
*
2099-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
2097+
* Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.
21002098
*
21012099
* The default `''` allows all dates.
21022100
*
@@ -2147,7 +2145,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
21472145
*/
21482146
disallow?: string;
21492147
/**
2150-
* Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
2148+
* Restricts which days of the week the user can select. These intersect with the result of `allow` and `disallow`.
21512149
*
21522150
* A comma-separated list of days. Whitespace is allowed after commas.
21532151
*
@@ -3035,7 +3033,7 @@ interface ProgressProps$1 extends GlobalProps {
30353033
/**
30363034
* Specifies how much of the task has been completed.
30373035
*
3038-
* It must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted.
3036+
* It must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted.
30393037
* If there is no value attribute, the progress bar is indeterminate;
30403038
* this indicates that an activity is ongoing with no indication of how long it is expected to take.
30413039
*
@@ -3049,7 +3047,7 @@ interface ProgressProps$1 extends GlobalProps {
30493047
/**
30503048
* This attribute describes how much work the task indicated by the progress element requires.
30513049
*
3052-
* The `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.
3050+
* The `max` attribute, if present, must have a value greater than `0` and be a valid floating point number.
30533051
*
30543052
* @default 1
30553053
*
@@ -4334,7 +4332,7 @@ declare const tagName$v = "s-map-marker";
43344332
/** @publicDocs */
43354333
interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibilityLabel' | 'blockSize' | 'command' | 'commandFor' | 'clusterable' | 'inlineSize' | 'latitude' | 'longitude'> {
43364334
/**
4337-
* Sets the action the `commandFor` target should take when this marker is activated. See the documentation of particular components for the actions they support. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
4335+
* Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
43384336
*
43394337
* - `--auto`: a default action for the target component.
43404338
* - `--show`: shows the target component.
@@ -4345,7 +4343,7 @@ interface MapMarkerElementProps extends Pick<MapMarkerProps$1, 'accessibilityLab
43454343
*/
43464344
command?: Extract<MapMarkerProps$1['command'], '--auto' | '--show' | '--hide' | '--toggle'>;
43474345
/**
4348-
* The ID of a component that should respond to activations (for example, clicks) on this component. Refer to the `command` property for how to control the behavior of the target. Learn more about the [`commandfor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
4346+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
43494347
*/
43504348
commandFor?: MapMarkerProps$1['commandFor'];
43514349
}

packages/ui-extensions/src/surfaces/customer-account/api/docs.ts

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,21 @@ interface ButtonProps {
3737
*/
3838
accessibilityLabel?: string;
3939
/**
40-
* ID of a component that should respond to activations (e.g. clicks) on this component.
41-
*
42-
* See `command` for how to control the behavior of the target.
43-
*
44-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
40+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
4541
*/
4642
commandFor?: string;
4743
/**
48-
* Sets the action the `commandFor` should take when this clickable is activated.
44+
* Sets the action the `commandFor` target should take when this component is activated.
4945
*
50-
* See the documentation of particular components for the actions they support.
46+
* - `--auto`: A default action for the target component.
47+
* - `--show`: Shows the target component.
48+
* - `--hide`: Hides the target component.
49+
* - `--toggle`: Toggles the target component.
50+
* - `--copy`: Copies the target clipboard item.
5151
*
52-
* - `--auto`: a default action for the target component.
53-
* - `--show`: shows the target component.
54-
* - `--hide`: hides the target component.
55-
* - `--toggle`: toggles the target component.
56-
* - `--copy`: copies the target ClipboardItem.
52+
* Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
5753
*
5854
* @default '--auto'
59-
*
60-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
6155
*/
6256
command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';
6357
/**
@@ -360,7 +354,7 @@ export interface Docs_Page_Button_PrimaryAction
360354
*/
361355
command?: ButtonProps['command'];
362356
/**
363-
* The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.
357+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
364358
*/
365359
commandFor?: ButtonProps['commandFor'];
366360
/**
@@ -416,7 +410,7 @@ export interface Docs_Page_Button_SecondaryAction
416410
*/
417411
command?: ButtonProps['command'];
418412
/**
419-
* The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.
413+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
420414
*/
421415
commandFor?: ButtonProps['commandFor'];
422416
/**

packages/ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,8 +284,7 @@ export interface OrderStatusApi<Target extends ExtensionTarget> {
284284
* The identifier that specifies where in Shopify's UI your code is being injected. This will be one of the targets you have included in your extension's configuration file.
285285
*
286286
* @example 'customer-account.order-status.block.render'
287-
* @see /docs/api/customer-account-ui-extensions/extension-targets-overview
288-
* @see /docs/apps/app-extensions/configuration#targets
287+
* 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).
289288
*
290289
* @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.
291290
*/

0 commit comments

Comments
 (0)