@shopify/ui-extensions 2025.10.13 → 2025.10.14

package/build/ts/surfaces/admin/components/Box.d.ts

@@ -14,6 +14,9 @@ import type {
   SizeUnitsOrNone,
 } 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.
@@ -35,7 +38,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'
@@ -47,10 +56,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'
@@ -62,6 +77,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * The properties for the box component. A box provides control over layout, spacing, sizing, borders, and background styling for its content.
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -83,7 +101,7 @@ export interface BoxProps
     | 'overflow'
   > {
   /**
-   * Adjust the background of the component.
+   * The background color of the box. You can choose from `'transparent'`, `'base'`, `'subdued'`, or `'strong'` to control the visual emphasis of the background.
    *
    * @default 'transparent'
    */
@@ -92,7 +110,16 @@ 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.
+   *
+   * - `small`: Thin border for subtle definition.
+   * - `small-100`: Extra thin border for minimal emphasis.
+   * - `base`: Standard border width.
+   * - `large`: Thick border for strong emphasis.
+   * - `large-100`: Extra thick border for maximum prominence.
+   * - `none`: No border.
+   *
+   * 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
    */
@@ -105,7 +132,11 @@ 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: one value applies to all sides,
+   * two values apply to block and inline sides, and so on.
    *
    * @default '' - meaning no override
    */
@@ -113,7 +144,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
    */
@@ -122,167 +156,161 @@ 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.
+   * One value applies to all corners, two values apply to opposite corners, and so on.
    *
    * @default 'none'
    */
   borderRadius: MaybeAllValuesShorthandProperty<BoxBorderRadii>;
   /**
-   * Adjust the padding of all edges.
-   *
-   * [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:
-   *
-   * - 4 values: `block-start inline-end block-end inline-start`
-   * - 3 values: `block-start inline block-end`
-   * - 2 values: `block inline`
-   *
-   * For example:
-   * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
-   * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
-   * - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
-   * - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
-   *
-   * 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.
+   * The padding on all sides of the box. The [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported, using flow-relative values in the order `block-start inline-end block-end inline-start`. For example, `'large'` applies large padding to all sides, while `'large none'` applies large padding to the block axis and no padding to the inline axis. A value of `'auto'` will use the default padding from the closest container that has had its padding removed. This property also accepts responsive values using container query syntax.
    *
    * @default 'none'
    */
   padding: ResponsiveBoxProps['padding'];
   /**
-   * Adjust the block-padding.
-   *
-   * - `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.
+   * The padding on the block axis (top and bottom in horizontal writing modes). This property overrides the block-axis value set by the `padding` property. For example, `'large none'` applies large padding to the block-start and no padding to the block-end. This property also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingBlock: ResponsiveBoxProps['paddingBlock'];
   /**
-   * Adjust the block-start padding.
-   *
-   * 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.
+   * The padding at the start of the block axis (top in horizontal writing modes). This property overrides the block-start value set by the `paddingBlock` property. It also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
   /**
-   * Adjust the block-end padding.
-   *
-   * 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.
+   * The padding at the end of the block axis (bottom in horizontal writing modes). This property overrides the block-end value set by the `paddingBlock` property. It also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd'];
   /**
-   * Adjust the inline padding.
-   *
-   * - `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.
+   * The padding on the inline axis (left and right in horizontal writing modes). This property overrides the inline-axis value set by the `padding` property. For example, `'large none'` applies large padding to the inline-start and no padding to the inline-end. This property also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingInline: ResponsiveBoxProps['paddingInline'];
   /**
-   * Adjust the inline-start padding.
-   *
-   * 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.
+   * The padding at the start of the inline axis (left in left-to-right writing modes). This property overrides the inline-start value set by the `paddingInline` property. It also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
   /**
-   * Adjust the inline-end padding.
-   *
-   * 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.
+   * The padding at the end of the inline axis (right in left-to-right writing modes). This property overrides the inline-end value set by the `paddingInline` property. It also accepts responsive values using container query syntax.
    *
    * @default '' - meaning no override
    */
   paddingInlineEnd: ResponsiveBoxProps['paddingInlineEnd'];
   /**
-   * Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
-   *
-   * - `auto` the component's initial value. The actual value depends on the component and context.
-   * - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
+   * The outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component, which controls how it participates in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). Use `'auto'` for the component's default behavior, or `'none'` to hide the component completely and remove it from the accessibility tree.
    *
    * @default 'auto'
    */
   display: ResponsiveBoxProps['display'];
   /**
-   * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
+   * The vertical size of the box 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) of the box (minimum height in horizontal writing modes).
    *
    * @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) of the box (maximum height in horizontal writing modes).
    *
    * @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) of the box (width in horizontal writing modes).
    *
    * @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) of the box (minimum width in horizontal writing modes).
    *
    * @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) of the box (maximum width in horizontal writing modes).
    *
    * @default 'none'
    */
   maxInlineSize: SizeUnitsOrNone;
 }
 
+/**
+ * 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;
 };
+/**
+ * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the meta key (Command on Mac, Windows key on Windows) 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.
+ * 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[];
@@ -320,49 +348,146 @@ 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 box for assistive technologies.
+   */
   accessor accessibilityRole: BoxProps['accessibilityRole'];
+  /**
+   * The background color of the box using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`.
+   */
   accessor background: BoxProps['background'];
+  /**
+   * The height of the box 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 box in horizontal writing modes, or minimum width in vertical writing modes.
+   * Prevents the box from shrinking below this size.
+   */
   accessor minBlockSize: BoxProps['minBlockSize'];
+  /**
+   * The maximum height of the box in horizontal writing modes, or maximum width in vertical writing modes.
+   * Prevents the box from growing beyond this size.
+   */
   accessor maxBlockSize: BoxProps['maxBlockSize'];
+  /**
+   * The width of the box 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 box in horizontal writing modes, or minimum height in vertical writing modes.
+   * Prevents the box from shrinking below this size.
+   */
   accessor minInlineSize: BoxProps['minInlineSize'];
+  /**
+   * The maximum width of the box in horizontal writing modes, or maximum height in vertical writing modes.
+   * Prevents the box from growing beyond this size.
+   */
   accessor maxInlineSize: BoxProps['maxInlineSize'];
+  /**
+   * Controls how content that exceeds the box's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries.
+   */
   accessor overflow: BoxProps['overflow'];
+  /**
+   * The padding on all sides of the box.
+   */
   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'];
+  /**
+   * The accessibility label for screen readers.
+   */
   accessor accessibilityLabel: BoxProps['accessibilityLabel'];
+  /**
+   * Controls the visibility of the box 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 box 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> {
+  /** The child elements to render inside this element. */
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A box is a container component that provides control over layout, spacing, and styling.
+ */
 declare class Box extends BoxElement implements BoxProps {
   constructor();
 }
@@ -380,11 +505,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-box';
+/**
+ * The properties for the box component when it's used in JSX.
+ */
 export interface BoxJSXProps
   extends Partial<BoxProps>,
     Pick<BoxProps$1, 'id' | 'children'> {
   /**
-   * The content of the Box.
+   * The child elements to render inside the box.
    */
   children?: ComponentChildren;
 }

package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Button.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Button/Button.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA6UX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Button.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Button/Button.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAkNX,CAAC;AAEF,eAAe,IAAI,CAAC"}