@shopify/ui-extensions 2025.10.13 → 2025.10.15

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

@@ -7,28 +7,67 @@
 /// <reference lib="DOM" />
 import type {AdminPrintActionProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the admin print action component. These properties configure the source URL for printing content within admin extensions.
+ *
+ * @publicDocs
+ */
 export interface AdminPrintActionProps
   extends Pick<AdminPrintActionProps$1, 'src'> {}
 
 declare const tagName = 's-admin-print-action';
+
+/**
+ * The JSX props for the admin print action component. These properties extend `AdminPrintActionProps` with an optional `id` for element identification in JSX rendering.
+ */
 export interface AdminPrintActionJSXProps
   extends Partial<AdminPrintActionProps>,
     Pick<AdminPrintActionProps$1, 'id'> {}
 
+/**
+ * The CSS styles as a string, used for styling web components within their shadow DOM.
+ */
 export type Styles = string;
+/**
+ * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The render function that returns Preact/JSX elements to display in the component's shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The optional CSS styles to inject into the component's shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the activation event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the activation event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click).
+   */
   button: number;
 }
+/**
+ * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab.
    */
   sourceEvent?: ActivationEventEsque;
 }
@@ -75,11 +114,18 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The admin print action custom element class that renders a print interface in the Shopify admin. This component enables merchants to print content from a specified source URL using the browser's print functionality.
+ */
 declare class AdminPrintAction
   extends PreactCustomElement
   implements AdminPrintActionProps
 {
+  /**
+   * The source URL of the content to print. This should point to the document or page that'll be sent to the printer when the merchant initiates the print action.
+   */
   src: string;
+
   constructor();
 }
 declare global {

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

@@ -8,37 +8,90 @@
 /// <reference lib="DOM" />
 import type {AvatarProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the avatar component. An avatar displays a user or entity image with fallback initials when the image isn't available. Properties include `src` for the image URL, `initials` for the fallback text, `alt` for accessibility text, and `size` for controlling the avatar dimensions.
+ */
 export interface AvatarProps
   extends Required<Pick<AvatarProps$1, 'initials' | 'src' | 'alt' | 'size'>> {
+  /**
+   * The initials to display when no image is provided or if the image fails to load. This typically includes the first letter of a user's first and last name (for example, `'JD'` for John Doe).
+   */
+  initials: AvatarProps$1['initials'];
+  /**
+   * The URL of the avatar image to display. You can provide an absolute or relative URL pointing to the image file.
+   */
+  src: AvatarProps$1['src'];
+  /**
+   * Alternative text that describes the avatar for screen readers. This text should identify who or what the avatar represents.
+   */
+  alt: AvatarProps$1['alt'];
+  /**
+   * The size of the avatar. Choose from `'small-200'`, `'small'`, `'base'`, `'large'`, or `'large-200'` to control the avatar dimensions.
+   *
+   * @default 'base'
+   */
   size: Extract<
     AvatarProps$1['size'],
     'small-200' | 'small' | 'base' | 'large' | 'large-200'
   >;
 }
 
+/**
+ * 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[];
@@ -60,8 +113,8 @@ declare abstract class PreactCustomElement extends BaseClass {
   /** @private */
   adoptedCallback(): void;
   /**
-   * Queue a run of the render function.
-   * You shouldn't need to call this manually - it should be handled by changes to @property values.
+   * Queues a run of the render function.
+   * You shouldn't need to call this manually - it should be handled by changes to `@property` values.
    * @private
    */
   queueRender(): void;
@@ -69,37 +122,75 @@ declare abstract class PreactCustomElement extends BaseClass {
    * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
    *
    * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
-   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
+   * components will attempt to produce the desired behavior on links, such as opening the page in a background tab.
    * @private
    * @param options
    */
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * A callback event that's typed to a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that currently has the event listener attached.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * An event listener for callback events, typed to a specific HTML element.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
-/** 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>;
 }
 
+/**
+ * An avatar displays a user or entity image with fallback initials when the image isn't available.
+ */
 declare class Avatar extends PreactCustomElement implements AvatarProps {
+  /**
+   * The initials to display when no image is provided or if the image fails to load.
+   */
   accessor initials: AvatarProps['initials'];
+  /**
+   * The URL of the avatar image to display.
+   */
   accessor src: AvatarProps['src'];
+  /**
+   * The size of the avatar.
+   */
   accessor size: AvatarProps['size'];
+  /**
+   * Alternative text that describes the avatar for screen readers.
+   */
   accessor alt: AvatarProps['alt'];
+  /**
+   * A callback that's fired when the avatar image has loaded successfully.
+   */
   accessor onload: CallbackEventListener<typeof tagName> | null;
+  /**
+   * A callback that's fired when the avatar image fails to load.
+   */
   accessor onerror: OnErrorEventHandler;
   constructor();
 }
@@ -117,10 +208,19 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-avatar';
+/**
+ * The properties for the avatar component when it's used in JSX.
+ */
 export interface AvatarJSXProps
   extends Partial<AvatarProps>,
     Pick<AvatarProps$1, 'id'> {
+  /**
+   * A callback that's fired when the avatar image has loaded successfully.
+   */
   onLoad?: () => void;
+  /**
+   * A callback that's fired when the avatar image fails to load.
+   */
   onError?: () => void;
 }
 

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

@@ -13,48 +13,144 @@ import type {
   IconType,
 } from './shared.d.ts';
 
+/**
+ * The configuration for icons used within Badge components. Defines the visual appearance, size, and semantic meaning of icons displayed in badges.
+ */
 export interface IconProps
   extends Pick<
     IconProps$1,
     'type' | 'tone' | 'color' | 'size' | 'interestFor'
   > {
   /**
-   * Specifies the type of icon that will be displayed.
+   * The type of icon to display inside the badge. Use any valid icon name from the admin icon set, an empty string for no icon, or `'empty'` to reserve space for an icon without displaying one.
    */
   type: '' | IconType | 'empty';
+  /**
+   * Determines the color used for the icon based on semantic meaning. Available options:
+   * - `'auto'` - Lets the system automatically choose the appropriate tone based on context.
+   * - `'neutral'` - Gray styling for general information.
+   * - `'info'` - Blue styling for informational content.
+   * - `'success'` - Green styling for positive states.
+   * - `'caution'` - Yellow styling for situations that need attention.
+   * - `'warning'` - Orange styling for important notices.
+   * - `'critical'` - Red styling for errors and urgent issues.
+   *
+   * @default 'auto'
+   */
   tone: Extract<
     IconProps$1['tone'],
     'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
   >;
+  /**
+   * Controls the visual prominence of the icon. Available options:
+   * - `'base'` - Standard color intensity for normal emphasis.
+   * - `'subdued'` - Reduced color intensity for less emphasis.
+   *
+   * @default 'base'
+   */
   color: Extract<IconProps$1['color'], 'base' | 'subdued'>;
+  /**
+   * Determines the size of the icon. Available options:
+   * - `'small'` - Smaller icon size for compact layouts.
+   * - `'base'` - Standard icon size for most use cases.
+   *
+   * @default 'base'
+   */
   size: Extract<IconProps$1['size'], 'small' | 'base'>;
 }
 
+/**
+ * The properties for the badge component. Badges display status information through compact visual indicators with customizable tones, sizes, and optional icons.
+ *
+ * @publicDocs
+ */
 export interface BadgeProps
   extends Pick<BadgeProps$1, 'color' | 'icon' | 'size' | 'tone'> {
+  /**
+   * Controls the visual weight and emphasis of the badge. Available options:
+   * - `'base'` - Standard weight with moderate emphasis, suitable for most use cases.
+   * - `'strong'` - Increased visual weight for higher emphasis and prominence.
+   *
+   * @default 'base'
+   */
   color: Extract<BadgeProps$1['color'], 'base' | 'strong'>;
+  /**
+   * The icon to display inside the badge. Accepts any valid icon type or an empty string to display no icon.
+   *
+   * @default ''
+   */
   icon: IconProps['type'] | '';
+  /**
+   * Determines the size of the badge. Available options:
+   * - `'base'` - Standard size for most use cases.
+   * - `'large'` - Larger size for increased visibility and prominence.
+   * - `'large-100'` - Extra large size for maximum visibility in specific contexts.
+   *
+   * @default 'base'
+   */
   size: Extract<BadgeProps$1['size'], 'base' | 'large' | 'large-100'>;
+  /**
+   * Determines the visual appearance and semantic meaning of the badge. Badges rely on the tone system for semantic meaning, so using custom styling might not clearly convey meaning to merchants. Available options:
+   * - `'auto'` - Lets the system automatically choose the appropriate tone based on context.
+   * - `'neutral'` - Gray styling for general status information that doesn't require emphasis.
+   * - `'info'` - Blue styling for informational content and neutral updates.
+   * - `'success'` - Green styling for positive states, completed actions, and successful operations.
+   * - `'caution'` - Yellow styling for situations that need attention but aren't urgent.
+   * - `'warning'` - Orange styling for important notices that require merchant awareness.
+   * - `'critical'` - Red styling for errors, failures, and urgent issues requiring immediate action.
+   *
+   * @default 'auto'
+   */
   tone: Extract<
     BadgeProps$1['tone'],
     'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
   >;
 }
 
+/**
+ * The CSS styles as a string, used for styling web components within their shadow DOM.
+ */
 export type Styles = string;
+/**
+ * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The render function that returns Preact/JSX elements to display in the component's shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The optional CSS styles to inject into the component's shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the activation event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the activation event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click).
+   */
   button: number;
 }
+/**
+ * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab.
    */
   sourceEvent?: ActivationEventEsque;
 }
@@ -100,26 +196,76 @@ declare abstract class PreactCustomElement extends BaseClass {
    */
   click({sourceEvent}?: ClickOptions): void;
 }
+export interface ClickOptions {
+  /**
+   * The event you want to influence the synthetic click.
+   */
+  sourceEvent?: ActivationEventEsque;
+}
+/**
+ * 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;
+declare abstract class PreactCustomElement extends BaseClass {
+  /** @private */
+  static get observedAttributes(): string[];
+  constructor({
+    styles,
+    ShadowRoot: renderFunction,
+    delegatesFocus,
+    ...options
+  }: RenderImpl);
+}
 
-/** Used when an element does not have children. */
+/**
+ * The base properties for Preact elements without children. Provides key, ref, and slot properties for element identification, DOM access, and slot-based positioning.
+ */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * A unique identifier for the element when used in lists. Preact uses keys for efficient rendering and reconciliation when lists change.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element. Typically created with `useRef()` to access the element directly for imperative operations like focusing or measuring.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * 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).
+   */
   slot?: Lowercase<string>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements with children. Extends `PreactBaseElementProps` with the ability to render child elements.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
+  /**
+   * The child elements to render within this component.
+   */
   children?: preact.ComponentChildren;
 }
 
+/**
+ * The badge custom element class that renders status indicators in the Shopify admin interface. This component displays compact visual indicators with customizable tones, sizes, and optional icons to communicate status information to merchants.
+ */
 declare class Badge extends PreactCustomElement implements BadgeProps {
+  /**
+   * The visual weight of the badge. Available options: `'base'` for standard weight or `'strong'` for increased emphasis.
+   */
   accessor color: BadgeProps['color'];
+  /**
+   * The icon to display inside the badge. Accepts any valid icon type from the admin icon set, or an empty string to display no icon.
+   */
   accessor icon: BadgeProps['icon'];
+  /**
+   * The size of the badge. Available options: `'base'` for standard size, `'large'` for larger size, or `'large-100'` for extra large size.
+   */
   accessor size: BadgeProps['size'];
+  /**
+   * The tone that determines the badge's visual appearance and semantic meaning. Available options: `'auto'`, `'neutral'`, `'info'`, `'success'`, `'caution'`, `'warning'`, or `'critical'`.
+   */
   accessor tone: BadgeProps['tone'];
   constructor();
 }
@@ -137,11 +283,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-badge';
+/**
+ * The JSX props for the badge component. These properties extend `BadgeProps` with an optional `id` and `children` for rendering badge content in JSX.
+ */
 export interface BadgeJSXProps
   extends Partial<BadgeProps>,
     Pick<BadgeProps$1, 'id' | 'children'> {
   /**
-   * The content of the Badge.
+   * The text content to display inside the badge. Typically a short status label like "Fulfilled", "Draft", or "Active".
    */
   children?: ComponentChildren;
 }