Skip to content

Commit 5661d02

Browse files
mcvincimcvinci
authored
[Customer account UI extensions 2025-10]: Remove duplicate descriptions being pulled into docs (#4258)
* Remove duplicate descriptions being pulled into docs * Restore @publicdocs tags while keeping descriptions removed The previous commit removed both the descriptions and the @publicdocs tags. The tags are still needed for docs generation - only the duplicate description text should be removed. Made-with: Cursor * Fix incorrectly renamed interfaces back to original names The previous removal commit renamed IconProps to IconElementProps, ImageProps to ImageElementProps, PaymentIconProps to PaymentIconElementProps, and ProductThumbnailProps to ProductThumbnailElementProps. These renames break the files since all other references still use the original names. Made-with: Cursor
1 parent 32a4522 commit 5661d02

File tree

10 files changed

+20
-84
lines changed

10 files changed

+20
-84
lines changed

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,7 @@ declare const CHECKOUT_AVAILABLE_ICONS: readonly ["alert-circle", "alert-triangl
3939
export type ReducedIconTypes = (typeof CHECKOUT_AVAILABLE_ICONS)[number];
4040

4141
declare const tagName = "s-icon";
42-
/**
43-
* The icon component renders graphic symbols to visually communicate actions, status, and navigation throughout the interface. Use icon to reinforce button actions, indicate status states, or provide wayfinding cues that help users understand available functionality.
44-
*
45-
* Icons support multiple sizes, tones for semantic meaning, and can be integrated with other components like [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button), [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge), and [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip) to enhance visual communication.
46-
* @publicDocs
47-
*/
42+
/** @publicDocs */
4843
export interface IconProps extends Pick<IconProps$1, 'id' | 'size' | 'tone' | 'type'> {
4944
/**
5045
* The semantic meaning and color treatment of the icon.

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,7 @@ export interface BaseElementProps<TClass = HTMLElement> {
5353
}
5454

5555
declare const tagName = "s-image";
56-
/**
57-
* The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.
58-
*
59-
* Images support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/avatar).
60-
* @publicDocs
61-
*/
56+
/** @publicDocs */
6257
export interface ImageProps extends Pick<ImageProps$1, 'accessibilityRole' | 'alt' | 'aspectRatio' | 'border' | 'borderRadius' | 'borderStyle' | 'borderWidth' | 'id' | 'inlineSize' | 'loading' | 'objectFit' | 'sizes' | 'src' | 'srcSet'> {
6358
/**
6459
* A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border.

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
5454
}) | null;
5555

5656
declare const tagName = "s-map";
57-
/**
58-
* Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.
59-
* @publicDocs
60-
*/
57+
/** @publicDocs */
6158
export interface MapElementProps extends Pick<MapProps$1, 'accessibilityLabel' | 'apiKey' | 'blockSize' | 'id' | 'inlineSize' | 'latitude' | 'longitude' | 'maxBlockSize' | 'maxInlineSize' | 'maxZoom' | 'minBlockSize' | 'minInlineSize' | 'minZoom' | 'zoom'> {
6259
}
6360
/**
@@ -119,10 +116,7 @@ export interface MapViewChangeEvent extends MapLocationEvent {
119116
*/
120117
zoom?: number;
121118
}
122-
/**
123-
* Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).
124-
* @publicDocs
125-
*/
119+
/** @publicDocs */
126120
export interface MapElementEvents {
127121
/**
128122
* A callback fired when the visible map boundaries change, such as after a pan or zoom completes.

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

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
5454
}) | null;
5555

5656
declare const tagName = "s-modal";
57-
/**
58-
* Displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.
59-
* @publicDocs
60-
*/
57+
/** @publicDocs */
6158
export interface ModalElementProps extends Pick<ModalProps$1, 'accessibilityLabel' | 'heading' | 'id' | 'padding' | 'size'> {
6259
/**
6360
* The size of the modal.
@@ -73,10 +70,7 @@ export interface ModalElementProps extends Pick<ModalProps$1, 'accessibilityLabe
7370
*/
7471
size?: Extract<ModalProps$1['size'], 'small-100' | 'small' | 'base' | 'large-100' | 'large' | 'max'>;
7572
}
76-
/**
77-
* Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).
78-
* @publicDocs
79-
*/
73+
/** @publicDocs */
8074
export interface ModalElementSlots {
8175
/**
8276
* The main action button displayed in the modal footer, representing the primary action users should take. Only accepts a single button component.
@@ -93,16 +87,10 @@ export interface ModalElementSlots {
9387
*/
9488
export interface ModalEvents extends Pick<ModalProps$1, 'onAfterHide' | 'onAfterShow' | 'onHide' | 'onShow'> {
9589
}
96-
/**
97-
* Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).
98-
* @publicDocs
99-
*/
90+
/** @publicDocs */
10091
export interface ModalElementMethods extends Pick<ModalProps$1, 'hideOverlay'> {
10192
}
102-
/**
103-
* Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).
104-
* @publicDocs
105-
*/
93+
/** @publicDocs */
10694
export interface ModalElementEvents {
10795
/**
10896
* A callback fired when the modal is hidden, after any hide animations have completed.

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,7 @@ export interface BaseElementProps<TClass = HTMLElement> {
3030
}
3131

3232
declare const tagName = "s-payment-icon";
33-
/**
34-
* Displays icons representing payment methods. Use to visually communicate available or saved payment options clearly
35-
* @publicDocs
36-
*/
33+
/** @publicDocs */
3734
export interface PaymentIconProps extends PaymentIconProps$1 {
3835
}
3936
/** @publicDocs */

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
5454
}) | null;
5555

5656
declare const tagName = "s-popover";
57-
/**
58-
* Popovers are used to display content in an overlay that can be triggered by a button.
59-
* @publicDocs
60-
*/
57+
/** @publicDocs */
6158
export interface PopoverElementProps extends Pick<PopoverProps$1, 'id'> {
6259
/**
6360
* The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
@@ -102,10 +99,7 @@ export interface PopoverElementProps extends Pick<PopoverProps$1, 'id'> {
10299
*/
103100
export interface PopoverEvents extends Pick<PopoverProps$1, 'onHide' | 'onShow'> {
104101
}
105-
/**
106-
* Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).
107-
* @publicDocs
108-
*/
102+
/** @publicDocs */
109103
export interface PopoverElementEvents {
110104
/**
111105
* A callback fired immediately after the popover is hidden.

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,7 @@ export interface BaseElementProps<TClass = HTMLElement> {
3030
}
3131

3232
declare const tagName = "s-product-thumbnail";
33-
/**
34-
* Use ProductThumbnail to display a product thumbnail
35-
* @publicDocs
36-
*/
33+
/** @publicDocs */
3734
export interface ProductThumbnailProps extends Pick<ProductThumbnailProps$1, 'alt' | 'size' | 'sizes' | 'src' | 'srcSet' | 'totalItems'> {
3835
/**
3936
* The size of the product thumbnail image.

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,7 @@ export type CallbackEventListener<TTagName extends keyof HTMLElementTagNameMap,
4444
}) | null;
4545

4646
declare const tagName = "s-qr-code";
47-
/**
48-
* Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.
49-
* @publicDocs
50-
*/
47+
/** @publicDocs */
5148
export interface QRCodeElementProps extends QRCodeProps$1 {
5249
}
5350
/**
@@ -56,10 +53,7 @@ export interface QRCodeElementProps extends QRCodeProps$1 {
5653
*/
5754
export interface QRCodeEvents extends Pick<QRCodeProps$1, 'onError'> {
5855
}
59-
/**
60-
* Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).
61-
* @publicDocs
62-
*/
56+
/** @publicDocs */
6357
export interface QRCodeElementEvents {
6458
/**
6559
* A callback that's fired when the conversion of `content` to a QR code fails.

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

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,7 @@ export interface SheetElementProps extends Pick<SheetProps$1, 'defaultOpen' | 'h
6767
*/
6868
export interface SheetEvents extends Pick<SheetProps$1, 'onAfterHide' | 'onAfterShow' | 'onHide' | 'onShow'> {
6969
}
70-
/**
71-
* Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).
72-
* @publicDocs
73-
*/
70+
/** @publicDocs */
7471
export interface SheetElementEvents {
7572
/**
7673
* A callback fired when the sheet is hidden, after any hide animations have completed.
@@ -89,10 +86,7 @@ export interface SheetElementEvents {
8986
*/
9087
show?: CallbackEventListener<typeof tagName>;
9188
}
92-
/**
93-
* Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).
94-
* @publicDocs
95-
*/
89+
/** @publicDocs */
9690
export interface SheetElementSlots {
9791
/**
9892
* The main action button displayed in the sheet footer, representing the primary action users should take. Only accepts a single button component.
@@ -103,10 +97,7 @@ export interface SheetElementSlots {
10397
*/
10498
'secondary-actions'?: HTMLElement;
10599
}
106-
/**
107-
* Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).
108-
* @publicDocs
109-
*/
100+
/** @publicDocs */
110101
export interface SheetElementMethods extends Pick<SheetProps$1, 'hideOverlay'> {
111102
}
112103
/**

‎packages/ui-extensions/src/surfaces/customer-account/components.d.ts‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@ declare module 'preact' {
5555
}
5656
}
5757
}
58-
59-
/**
60-
* @publicDocs
61-
*/
58+
/** @publicDocs */
6259
export type ImageGroupPropsDocs = ImageGroupProps;
6360
export type ImageGroupElementDocs = ImageGroupElement;
6461

@@ -108,17 +105,11 @@ declare module 'preact' {
108105
}
109106
}
110107
}
111-
112-
/**
113-
* @publicDocs
114-
*/
108+
/** @publicDocs */
115109
export type AvatarElementPropsDocs = AvatarElementProps;
116110
export type AvatarPropsDocs = AvatarProps;
117111
export type AvatarElementDocs = AvatarElement;
118-
/**
119-
* Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).
120-
* @publicDocs
121-
*/
112+
/** @publicDocs */
122113
export type AvatarEventsDocs = AvatarEvents;
123114

124115
declare global {

0 commit comments

Comments
 (0)