Skip to content

Fix broken web components links in Admin API descriptions (2026-01) #4539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sordaz00 merged 1 commit into from
Jul 6, 2026
Merged

Fix broken web components links in Admin API descriptions (2026-01) #4539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 44 additions & 44 deletions ...nsions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json
View file
Open in desktop

Large diffs are not rendered by default.

88 changes: 44 additions & 44 deletions packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json
View file
Open in desktop

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions packages/ui-extensions/src/surfaces/admin/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5368,7 +5368,7 @@ export interface BoxProps
*
* **Examples:** `base`, `large none`, `base large-100 base small`
*
* Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default 'none'
*/
Expand All @@ -5380,23 +5380,23 @@ export interface BoxProps
*
* **Example:** `large none` applies `large` to the top and `none` to the bottom.
*
* Overrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
paddingBlock: ResponsiveBoxProps['paddingBlock'];
/**
* The block-start padding (top in horizontal writing modes).
*
* Overrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
/**
* The block-end padding (bottom in horizontal writing modes).
*
* Overrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -5408,23 +5408,23 @@ export interface BoxProps
*
* **Example:** `large none` applies `large` to the left and `none` to the right.
*
* Overrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
paddingInline: ResponsiveBoxProps['paddingInline'];
/**
* The inline-start padding (left in LTR writing modes, right in RTL).
*
* Overrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
/**
* The inline-end padding (right in LTR writing modes, left in RTL).
*
* Overrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* Overrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand Down Expand Up @@ -6826,9 +6826,9 @@ export interface GridProps
* Adjusts spacing between elements.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value applied to both axes, such as `large-100`
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`
* - A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default 'none'
*/
Expand All @@ -6837,8 +6837,8 @@ export interface GridProps
* s spacing between elements in the block axis. This overrides the row value of `gap`.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default '' - meaning no override
*/
Expand All @@ -6847,8 +6847,8 @@ export interface GridProps
* Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default '' - meaning no override
*/
Expand All @@ -6858,7 +6858,7 @@ export interface GridProps
*
* Accepts:
* - [Track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes), such as `1fr auto`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported track sizing values as a query value
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value
*
* @default 'none'
*/
Expand All @@ -6868,7 +6868,7 @@ export interface GridProps
*
* Accepts:
* - [Track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes), such as `1fr auto`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported track sizing values as a query value
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value
*
* @default 'none'
*/
Expand Down Expand Up @@ -8343,9 +8343,9 @@ export interface StackProps
* Adjusts spacing between elements.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value applied to both axes, such as `large-100`
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`
* - A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default 'none'
*/
Expand All @@ -8354,8 +8354,8 @@ export interface StackProps
* Adjusts spacing between elements in the block axis. This overrides the row value of `gap`.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default '' - meaning no override
*/
Expand All @@ -8364,8 +8364,8 @@ export interface StackProps
* Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.
*
* Accepts:
* - A single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported SpacingKeyword as a query value
* - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
*
* @default '' - meaning no override
*/
Expand All @@ -8375,7 +8375,7 @@ export interface StackProps
*
* Accepts:
* - A single value, either `inline` or `block`
* - A [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported direction values as a query value
* - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported direction values as a query value
*
* @default 'block'
*
Expand Down
2 changes: 1 addition & 1 deletion packages/ui-extensions/src/surfaces/admin/components/Badge.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
*/
ref?: preact.Ref<TClass>;
/**
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/app-ui/using-web-components#slots).
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
*/
slot?: Lowercase<string>;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui-extensions/src/surfaces/admin/components/Button.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
*/
ref?: preact.Ref<TClass>;
/**
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/app-ui/using-web-components#slots).
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
*/
slot?: Lowercase<string>;
}
Expand Down
14 changes: 7 additions & 7 deletions packages/ui-extensions/src/surfaces/admin/components/Clickable.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ export interface BoxProps
*
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
*
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default 'none'
*/
Expand All @@ -236,7 +236,7 @@ export interface BoxProps
*
* This overrides the block value of `padding`.
*
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -246,7 +246,7 @@ export interface BoxProps
*
* This overrides the block-start value of `paddingBlock`.
*
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -256,7 +256,7 @@ export interface BoxProps
*
* This overrides the block-end value of `paddingBlock`.
*
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -268,7 +268,7 @@ export interface BoxProps
*
* This overrides the inline value of `padding`.
*
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -278,7 +278,7 @@ export interface BoxProps
*
* This overrides the inline-start value of `paddingInline`.
*
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand All @@ -288,7 +288,7 @@ export interface BoxProps
*
* This overrides the inline-end value of `paddingInline`.
*
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
*
* @default '' - meaning no override
*/
Expand Down
Loading
Loading