@shopify/ui-extensions 2025.10.13 → 2025.10.15

package/src/surfaces/admin/components/Stack.d.ts

@@ -18,6 +18,9 @@ import type {
   AlignContentKeyword,
 } from './shared.d.ts';
 
+/**
+ * A type that allows a value to be responsive using container query syntax.
+ */
 export type MakeResponsive<T> = T | `@container${string}`;
 /**
  * Makes a property's value potentially responsive.
@@ -39,7 +42,13 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
   [P in TProperty]: MakeResponsive<TType[P]>;
 };
 
+/**
+ * A version of the box properties with all fields required.
+ */
 export type RequiredBoxProps = Required<BoxProps$1>;
+/**
+ * The allowed border radius values for a box component.
+ */
 export type BoxBorderRadii = Extract<
   RequiredBoxProps['borderRadius'],
   | 'none'
@@ -51,10 +60,16 @@ export type BoxBorderRadii = Extract<
   | 'large-100'
   | 'large-200'
 >;
+/**
+ * The allowed border style values for a box component.
+ */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
   'none' | 'solid' | 'dashed' | 'auto'
 >;
+/**
+ * The box properties that support responsive values through container queries.
+ */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
   | 'padding'
@@ -87,7 +102,7 @@ export interface BoxProps
     | 'overflow'
   > {
   /**
-   * Adjust the background of the component.
+   * The background color of the stack container.
    *
    * @default 'transparent'
    */
@@ -96,7 +111,10 @@ export interface BoxProps
     'transparent' | 'base' | 'subdued' | 'strong'
   >;
   /**
-   * Adjust the width of the border.
+   * Controls the thickness of the border on all sides.
+   *
+   * When set, this overrides the width value specified in the `border` property.
+   * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side.
    *
    * @default '' - meaning no override
    */
@@ -109,7 +127,10 @@ export interface BoxProps
       >
     | Extract<RequiredBoxProps['borderWidth'], ''>;
   /**
-   * Adjust the style of the border.
+   * Controls the visual style of the border on all sides (solid, dashed, auto, or none).
+   *
+   * When set, this overrides the style value specified in the `border` property.
+   * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side.
    *
    * @default '' - meaning no override
    */
@@ -117,7 +138,10 @@ export interface BoxProps
     | MaybeAllValuesShorthandProperty<BoxBorderStyles>
     | Extract<RequiredBoxProps['borderStyle'], ''>;
   /**
-   * Adjust the color of the border.
+   * Controls the color of the border using the design system's color scale.
+   *
+   * When set, this overrides the color value specified in the `border` property.
+   * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
    *
    * @default '' - meaning no override
    */
@@ -126,13 +150,15 @@ export interface BoxProps
     'subdued' | 'base' | 'strong' | ''
   >;
   /**
-   * Adjust the radius of the border.
+   * Controls the roundedness of the element's corners using the design system's radius scale.
+   *
+   * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different radii per corner. Use this to create rounded corners or fully rounded elements.
    *
    * @default 'none'
    */
   borderRadius: MaybeAllValuesShorthandProperty<BoxBorderRadii>;
   /**
-   * Adjust the padding of all edges.
+   * The padding applied to all edges of the stack container.
    *
    * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
    *
@@ -148,71 +174,71 @@ 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/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `padding` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default 'none'
    */
   padding: ResponsiveBoxProps['padding'];
   /**
-   * Adjust the block-padding.
+   * The padding applied to the block axis (top and bottom in horizontal writing modes).
    *
    * - `large none` means block-start padding is `large`, block-end padding is `none`.
    *
    * This overrides the block value of `padding`.
    *
-   * `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
   paddingBlock: ResponsiveBoxProps['paddingBlock'];
   /**
-   * Adjust the block-start padding.
+   * The padding applied to the block-start edge (top in horizontal writing modes).
    *
    * This overrides the block-start value of `paddingBlock`.
    *
-   * `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
   paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
   /**
-   * Adjust the block-end padding.
+   * The padding applied to the block-end edge (bottom in horizontal writing modes).
    *
    * This overrides the block-end value of `paddingBlock`.
    *
-   * `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
   paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd'];
   /**
-   * Adjust the inline padding.
+   * The padding applied to the inline axis (left and right in horizontal writing modes).
    *
    * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
    *
    * This overrides the inline value of `padding`.
    *
-   * `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
   paddingInline: ResponsiveBoxProps['paddingInline'];
   /**
-   * Adjust the inline-start padding.
+   * The padding applied to the inline-start edge (left in left-to-right languages).
    *
    * This overrides the inline-start value of `paddingInline`.
    *
-   * `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
   paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
   /**
-   * Adjust the inline-end padding.
+   * The padding applied to the inline-end edge (right in left-to-right languages).
    *
    * This overrides the inline-end value of `paddingInline`.
    *
-   * `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value.
+   * `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
    *
    * @default '' - meaning no override
    */
@@ -227,48 +253,62 @@ export interface BoxProps
    */
   display: ResponsiveBoxProps['display'];
   /**
-   * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
+   * The vertical size of the stack in standard layouts (height in left-to-right or right-to-left writing modes).
+   *
+   * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height;
+   * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.
+   *
+   * Learn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
    *
    * @default 'auto'
    */
   blockSize: SizeUnitsOrAuto;
   /**
-   * Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
+   * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the stack container.
    *
    * @default '0'
    */
   minBlockSize: SizeUnits;
   /**
-   * Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
+   * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the stack container.
    *
    * @default 'none'
    */
   maxBlockSize: SizeUnitsOrNone;
   /**
-   * Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
+   * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the stack container.
    *
    * @default 'auto'
    */
   inlineSize: SizeUnitsOrAuto;
   /**
-   * Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
+   * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the stack container.
    *
    * @default '0'
    */
   minInlineSize: SizeUnits;
   /**
-   * Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
+   * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the stack container.
    *
    * @default 'none'
    */
   maxInlineSize: SizeUnitsOrNone;
 }
 
+/**
+ * A version of the stack properties with all fields required.
+ */
 export type AlignedStackProps = Required<StackProps$1>;
+/**
+ * The stack properties that support responsive values through container queries.
+ */
 export type ResponsiveStackProps = MakeResponsivePick<
   AlignedStackProps,
   'gap' | 'rowGap' | 'columnGap' | 'direction'
 >;
+/**
+ * The properties for the stack component. A stack arranges its children in a single direction with controlled spacing and alignment along both axes.
+ */
 export interface StackProps
   extends BoxProps,
     Pick<
@@ -276,95 +316,113 @@ export interface StackProps
       'justifyContent' | 'alignItems' | 'alignContent'
     > {
   /**
-   * Aligns the Stack's children along the inline axis.
+   * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).
+   *
+   * Use this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines.
    *
    * @default 'normal'
    */
   justifyContent: JustifyContentKeyword;
   /**
-   * Aligns the Stack's children along the block axis.
+   * Controls the alignment of children along the block axis (vertically in horizontal writing modes).
+   *
+   * Use this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks.
    *
    * @default 'normal'
    */
   alignItems: AlignItemsKeyword;
   /**
-   * Aligns the Stack's children along the block axis.
+   * Controls the distribution of lines along the block axis when content wraps into multiple lines.
    *
-   * This overrides the block value of `alignContent`.
+   * This property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead.
    *
    * @default 'normal'
    */
   alignContent: AlignContentKeyword;
   /**
-   * Adjust spacing between elements.
-   *
-   * `gap` can either accept:
-   * - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value applied to both axes (e.g. `large-100`)
-   * - OR a pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively
-   * - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value.
+   * The spacing between children in the stack. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for the block and inline axes. This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
    *
    * @default 'none'
    */
   gap: ResponsiveStackProps['gap'];
   /**
-   * Adjust spacing between elements in the block axis.
-   *
-   * This overrides the row value of `gap`.
-   * `rowGap` either accepts:
-   * - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`)
-   * - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value.
+   * The spacing between children in the block axis (vertical in horizontal writing modes). This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
    *
    * @default '' - meaning no override
    */
   rowGap: ResponsiveStackProps['rowGap'];
   /**
-   * Adjust spacing between elements in the inline axis.
-   *
-   * This overrides the column value of `gap`.
-   * `columnGap` either accepts:
-   * - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`)
-   * - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value.
+   * The spacing between children in the inline axis (horizontal in left-to-right languages). This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
    *
    * @default '' - meaning no override
    */
   columnGap: ResponsiveStackProps['columnGap'];
   /**
-   * Sets how the Stack's children are placed within the Stack.
-   *
-   * `direction` either accepts:
-   * - a single value either `inline` or `block`
-   * - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value.
+   * The direction in which the stack's children are laid out. Use `'inline'` to arrange children horizontally (with wrapping enabled), or `'block'` to arrange them vertically (without wrapping). This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
    *
    * @default 'block'
    *
-   * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
+   * @implementation The content will wrap if the direction is `'inline'`, and won't wrap if the direction is `'block'`.
    */
   direction: ResponsiveStackProps['direction'];
 }
 
+/**
+ * A string containing CSS styles for a custom element.
+ */
 export type Styles = string;
+/**
+ * The configuration for rendering a custom element with Preact.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The optional CSS styles to apply to the shadow root.
+   */
   styles?: Styles;
 };
+/**
+ * An interface representing the properties of an activation event, such as a click or keypress.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the control key was pressed during the event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
+   */
   button: number;
 }
+/**
+ * The options for triggering a synthetic click event.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked.
    */
   sourceEvent?: ActivationEventEsque;
 }
 /**
- * Base class for creating custom elements with Preact.
+ * The base class for creating custom elements with Preact.
  * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
  * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
  */
 declare const BaseClass: typeof globalThis.HTMLElement;
+/**
+ * An abstract base class for creating custom elements that render with Preact.
+ */
 declare abstract class PreactCustomElement extends BaseClass {
   /** @private */
   static get observedAttributes(): string[];
@@ -402,57 +460,174 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The base element class for Box components with all Box properties as accessors.
+ */
 declare class BoxElement extends PreactCustomElement implements BoxProps {
   constructor(renderImpl: RenderImpl);
+  /**
+   * The ARIA role that defines the semantic meaning of the stack for assistive technologies.
+   */
   accessor accessibilityRole: BoxProps['accessibilityRole'];
+  /**
+   * The background color of the stack using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`.
+   */
   accessor background: BoxProps['background'];
+  /**
+   * The height of the stack in horizontal writing modes, or width in vertical writing modes.
+   * Use this for flow-relative sizing that adapts to text direction.
+   */
   accessor blockSize: BoxProps['blockSize'];
+  /**
+   * The minimum height of the stack in horizontal writing modes, or minimum width in vertical writing modes.
+   * Prevents the stack from shrinking below this size.
+   */
   accessor minBlockSize: BoxProps['minBlockSize'];
+  /**
+   * The maximum height of the stack in horizontal writing modes, or maximum width in vertical writing modes.
+   * Prevents the stack from growing beyond this size.
+   */
   accessor maxBlockSize: BoxProps['maxBlockSize'];
+  /**
+   * The width of the stack in horizontal writing modes, or height in vertical writing modes.
+   * Use this for flow-relative sizing that adapts to text direction.
+   */
   accessor inlineSize: BoxProps['inlineSize'];
+  /**
+   * The minimum width of the stack in horizontal writing modes, or minimum height in vertical writing modes.
+   * Prevents the stack from shrinking below this size.
+   */
   accessor minInlineSize: BoxProps['minInlineSize'];
+  /**
+   * The maximum width of the stack in horizontal writing modes, or maximum height in vertical writing modes.
+   * Prevents the stack from growing beyond this size.
+   */
   accessor maxInlineSize: BoxProps['maxInlineSize'];
+  /**
+   * Controls how content that exceeds the stack's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries.
+   */
   accessor overflow: BoxProps['overflow'];
+  /**
+   * The spacing applied inside the stack on all sides, creating distance between the stack's edges and its content.
+   */
   accessor padding: BoxProps['padding'];
+  /**
+   * The vertical padding (top and bottom) in horizontal writing modes.
+   * Use this for flow-relative padding that adapts to text direction.
+   */
   accessor paddingBlock: BoxProps['paddingBlock'];
+  /**
+   * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
+   */
   accessor paddingBlockStart: BoxProps['paddingBlockStart'];
+  /**
+   * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes.
+   */
   accessor paddingBlockEnd: BoxProps['paddingBlockEnd'];
+  /**
+   * The horizontal padding (left and right) in horizontal writing modes.
+   * Use this for flow-relative padding that adapts to text direction.
+   */
   accessor paddingInline: BoxProps['paddingInline'];
+  /**
+   * The padding at the left in left-to-right languages, or at the right in right-to-left languages.
+   */
   accessor paddingInlineStart: BoxProps['paddingInlineStart'];
+  /**
+   * The padding at the right in left-to-right languages, or at the left in right-to-left languages.
+   */
   accessor paddingInlineEnd: BoxProps['paddingInlineEnd'];
+  /**
+   * Applies a border using shorthand syntax to specify width, color, and style in a single property.
+   */
   accessor border: BoxProps['border'];
+  /**
+   * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
+   */
   accessor borderWidth: BoxProps['borderWidth'];
+  /**
+   * Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property.
+   */
   accessor borderStyle: BoxProps['borderStyle'];
+  /**
+   * Controls the color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.
+   */
   accessor borderColor: BoxProps['borderColor'];
+  /**
+   * Controls the roundedness of the element's corners using the design system's radius scale.
+   */
   accessor borderRadius: BoxProps['borderRadius'];
+  /**
+   * A text description of the stack for screen readers, used when the visual context isn't sufficient for understanding.
+   */
   accessor accessibilityLabel: BoxProps['accessibilityLabel'];
+  /**
+   * Controls the visibility of the stack for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers.
+   */
   accessor accessibilityVisibility: BoxProps['accessibilityVisibility'];
+  /**
+   * Controls how the stack is displayed in the layout, such as block, inline, or none.
+   */
   accessor display: BoxProps['display'];
 }
 
-/** Used when an element does not have children. */
+/**
+ * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A stack is a layout component that arranges its children in a single direction with controlled spacing and alignment.
+ */
 declare class Stack extends BoxElement implements StackProps {
   constructor();
+  /**
+   * The direction in which the stack's children are arranged.
+   */
   accessor direction: StackProps['direction'];
+  /**
+   * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).
+   */
   accessor justifyContent: StackProps['justifyContent'];
+  /**
+   * Controls the alignment of children along the block axis (vertically in horizontal writing modes).
+   */
   accessor alignItems: StackProps['alignItems'];
+  /**
+   * Controls the distribution of lines along the block axis when content wraps into multiple lines.
+   */
   accessor alignContent: StackProps['alignContent'];
+  /**
+   * The spacing between the stack's children.
+   */
   accessor gap: StackProps['gap'];
+  /**
+   * The spacing between rows in the stack.
+   */
   accessor rowGap: StackProps['rowGap'];
+  /**
+   * The spacing between columns in the stack.
+   */
   accessor columnGap: StackProps['columnGap'];
 }
 declare global {
@@ -469,11 +644,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-stack';
+/**
+ * The properties for the stack component when it's used in JSX.
+ */
 export interface StackJSXProps
   extends Partial<StackProps>,
     Pick<StackProps$1, 'id' | 'children'> {
   /**
-   * The content of the Stack.
+   * The child elements to render inside the stack.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/StandardComponents.ts

@@ -1,3 +1,6 @@
+/**
+ * The standard set of UI components available in most admin extensions. These components provide the building blocks for creating extension interfaces including layout elements, form inputs, data display, navigation, and interactive controls. Use these components to build consistent, accessible UIs that match the Shopify admin design system.
+ */
 export type StandardComponents =
   | 'Avatar'
   | 'Badge'

package/src/surfaces/admin/components/Switch/examples/disabled-switch.html

@@ -1,6 +1,6 @@
 <s-switch
   id="disabled-switch"
   label="Feature locked (Premium plan required)"
-  checked="true"
-  disabled="true"
+  checked
+  disabled
 ></s-switch>

package/src/surfaces/admin/components/Switch/examples/form-integration.html

@@ -1,14 +1,17 @@
 <form>
-  <s-switch
-    id="email-notifications"
-    label="Email notifications"
-    name="emailNotifications"
-    value="enabled"
-  ></s-switch>
-  <s-switch
-    id="sms-notifications"
-    label="SMS notifications"
-    name="smsNotifications"
-    value="enabled"
-  ></s-switch>
+  <s-stack gap="base">
+    <s-switch
+      id="email-notifications"
+      label="Email notifications"
+      name="emailNotifications"
+      value="enabled"
+    ></s-switch>
+    <s-switch
+      id="sms-notifications"
+      label="SMS notifications"
+      name="smsNotifications"
+      value="enabled"
+    ></s-switch>
+    <s-button type="submit">Save preferences</s-button>
+  </s-stack>
 </form>

package/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html

@@ -2,5 +2,5 @@
   id="hidden-label-switch"
   labelAccessibilityVisibility="exclusive"
   label="Toggle feature"
-  checked="true"
+  checked
 ></s-switch>

package/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html

@@ -4,6 +4,6 @@
   <s-switch
     id="analytics-setting"
     label="Usage analytics"
-    checked="true"
+    checked
   ></s-switch>
 </s-stack>