@shopify/ui-extensions 2025.10.13 → 2025.10.14

package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html

@@ -3,7 +3,19 @@
     Your order will be processed within 2-3 business days.
   </s-paragraph>
 
-  <s-paragraph tone="success" color="subdued">
+  <s-paragraph tone="success" color="base">
     Payment successfully processed.
   </s-paragraph>
+
+  <s-paragraph tone="caution" color="base">
+    Review shipping address before processing.
+  </s-paragraph>
+
+  <s-paragraph tone="warning" color="base">
+    Inventory levels are running low for this product.
+  </s-paragraph>
+
+  <s-paragraph tone="critical" color="base">
+    This order requires immediate attention due to shipping delays.
+  </s-paragraph>
 </s-section>

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

@@ -8,6 +8,9 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, ParagraphProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the paragraph component. These properties define blocks of text content with consistent spacing and styling for readable body copy.
+ */
 export interface ParagraphProps
   extends Required<
     Pick<
@@ -20,23 +23,72 @@ export interface ParagraphProps
       | 'lineClamp'
     >
   > {
+  /**
+   * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
+  tone: Extract<
+    ParagraphProps$1['tone'],
+    'info' | 'success' | 'caution' | 'warning' | 'critical'
+  >;
+  /**
+   * The color of the paragraph text. Available options:
+   * - `'base'` - The default text color.
+   * - `'subdued'` - A lighter text color for secondary information.
+   */
   color: Extract<ParagraphProps$1['color'], 'base' | 'subdued'>;
 }
 
+/**
+ * A string containing CSS styles.
+ */
 export type Styles = string;
+/**
+ * The configuration for rendering a custom element with a shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow DOM content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * Optional CSS styles to apply to the shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * An object that represents the state of modifier keys and mouse button
+ * during an activation event like a click.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the meta (Command on Mac, Windows key on PC) key was pressed.
+   */
   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;
 }
+/**
+ * Options for customizing click behavior on an element.
+ */
 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;
 }
@@ -83,31 +135,65 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
-/** 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 custom element for displaying blocks of text content with consistent spacing and styling for readable body copy. Use Paragraph to render longer text content with proper line height and spacing between paragraphs.
+ */
 declare class Paragraph extends PreactCustomElement implements ParagraphProps {
+  /**
+   * The numeric font variant for the paragraph text.
+   */
   accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];
+  /**
+   * The maximum number of lines to display before the text is truncated with an ellipsis.
+   */
   accessor lineClamp: ParagraphProps['lineClamp'];
-  accessor tone: Extract<
-    ParagraphProps['tone'],
-    'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
-  >;
+  /**
+   * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
+  accessor tone: ParagraphProps['tone'];
 
+  /**
+   * The color of the paragraph text.
+   */
   accessor color: ParagraphProps['color'];
+  /**
+   * The text direction (left-to-right or right-to-left).
+   */
   accessor dir: ParagraphProps['dir'];
+  /**
+   * The visibility of the element to assistive technologies.
+   */
   accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility'];
   constructor();
 }
@@ -126,11 +212,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-paragraph';
+/**
+ * The JSX properties for the paragraph component. These properties define how a paragraph is rendered in Preact or JSX.
+ */
 export interface ParagraphJSXProps
   extends Partial<ParagraphProps>,
     Pick<ParagraphProps$1, 'id' | 'children'> {
   /**
-   * The content of the Paragraph.
+   * The content of the paragraph.
    */
   children?: ComponentChildren;
 }

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

@@ -12,44 +12,109 @@ import type {
   ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * An event object with a strongly-typed currentTarget property that references the specific HTML element type.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The DOM element that the event listener is attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * An event listener function or null that receives a typed callback event.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
+      /**
+       * The callback function that's invoked when the event fires.
+       */
       (event: CallbackEvent<T>): void;
     })
   | null;
+/**
+ * The React-style event handler props for form field components.
+ */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
+  /**
+   * A callback that's triggered when the field's value changes as the user types.
+   */
   onInput?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's triggered when the field's value changes and the field loses focus.
+   */
   onChange?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's triggered when the field receives focus.
+   */
   onFocus?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's triggered when the field loses focus.
+   */
   onBlur?: ((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>;
 }
 
+/**
+ * A string containing CSS styles to be applied to the component.
+ */
 export type Styles = string;
+/**
+ * The implementation details for rendering a custom element with a shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * A function that renders the component's shadow DOM content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
   styles?: Styles;
 };
+/**
+ * An object containing information about keyboard and mouse button states during an activation event.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta (Command on Mac, Windows key on PC) key was pressed during the event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the event.
+   */
   button: number;
 }
+/**
+ * The options for programmatically triggering a click event on an element.
+ */
 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;
 }
@@ -97,26 +162,57 @@ declare abstract class PreactCustomElement extends BaseClass {
 }
 
 declare const internals: unique symbol;
+/**
+ * The required props for input elements that all form controls must implement.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/**
+ * The base class for form input elements that participate in form submission.
+ */
 declare class PreactInputElement
   extends PreactCustomElement
   implements PreactInputProps
 {
+  /** @private */
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * The callback that's triggered when the input value changes and the field loses focus.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * The callback that's triggered when the input value changes as the user types.
+   */
   accessor oninput: CallbackEventListener<'input'>;
+  /**
+   * Whether the input is disabled and can't be interacted with.
+   */
   accessor disabled: PreactInputProps['disabled'];
+  /**
+   * The unique identifier for the input element.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * The name of the input, used when submitting form data.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value of the input.
+   */
   get value(): PreactInputProps['value'];
+  /**
+   * The current value of the input.
+   */
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The common props shared by all form field components in the admin UI.
+ */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
     Required<
@@ -133,17 +229,17 @@ export type PreactFieldProps<Autocomplete extends string = string> =
       >
     > & {
       /**
-       * A hint as to the intended content of the field.
+       * A hint about the intended content of the field for browser autofill.
        *
        * When set to `on` (the default), this property indicates that the field should support
-       * autofill, but you do not have any more semantic information on the intended
+       * autofill, but you don't have any more semantic information on the intended
        * contents.
        *
-       * When set to `off`, you are indicating that this field contains sensitive
+       * When set to `off`, you're indicating that this field contains sensitive
        * information, or contents that are never saved, like one-time codes.
        *
-       * Alternatively, you can provide value which describes the
-       * specific data you would like to be entered into this field during autofill.
+       * Alternatively, you can provide a value which describes the
+       * specific data you'd like to be entered into this field during autofill.
        *
        * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers.
        *
@@ -154,27 +250,63 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        */
       autocomplete: Autocomplete;
     };
+/**
+ * The base class for form field elements that includes label, error, and validation support.
+ */
 declare class PreactFieldElement<Autocomplete extends string = string>
   extends PreactInputElement
   implements PreactFieldProps<Autocomplete>
 {
+  /**
+   * The callback that's triggered when the field loses focus.
+   */
   accessor onblur: CallbackEventListener<'input'>;
+  /**
+   * The callback that's triggered when the field receives focus.
+   */
   accessor onfocus: CallbackEventListener<'input'>;
+  /**
+   * A hint about the intended content of the field for browser autofill.
+   */
   accessor autocomplete: PreactFieldProps<Autocomplete>['autocomplete'];
+  /**
+   * The initial value of the field when it's first rendered.
+   */
   accessor defaultValue: PreactFieldProps['defaultValue'];
+  /**
+   * The additional text displayed below the field to provide helpful context.
+   */
   accessor details: PreactFieldProps['details'];
+  /**
+   * The error message displayed when the field validation fails.
+   */
   accessor error: PreactFieldProps['error'];
+  /**
+   * The text label displayed above the field.
+   */
   accessor label: PreactFieldProps['label'];
+  /**
+   * The visibility of the label for accessibility purposes. Available values: `hidden`, `visible`.
+   */
   accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility'];
+  /**
+   * The hint text displayed inside the field when it's empty.
+   */
   accessor placeholder: PreactFieldProps['placeholder'];
+  /**
+   * Whether the field is read-only and can't be edited by the user.
+   */
   accessor readOnly: PreactFieldProps['readOnly'];
+  /**
+   * Whether the field must be filled out before the form can be submitted.
+   */
   accessor required: PreactFieldProps['required'];
   /**
    * Global keyboard event handlers for things like key bindings typically
    * ignore keystrokes originating from within input elements. Unfortunately,
-   * these never account for a Custom Element being the input element.
+   * these never account for a custom element being the input element.
    *
-   * To fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement
+   * To fix this, we spoof getAttribute and hasAttribute to make a PreactFieldElement
    * appear as a contentEditable "input" when it contains a focused input element.
    * @private technically not private, but we don't want to expose this as public API
    */
@@ -184,8 +316,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
    */
   hasAttribute(qualifiedName: string): boolean;
   /**
-   * Checks if the shadow tree contains a focused input (input, textarea, select, <x contentEditable>).
-   * Note: this does _not_ return true for focussed non-field form elements like buttons.
+   * Checks if the shadow tree contains a focused input (input, textarea, select, contentEditable element).
+   * Note: this doesn't return true for focused non-field form elements like buttons.
    * @private
    */
   get isContentEditable(): boolean;
@@ -196,6 +328,9 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The properties for the password field component. These properties configure a secure input field that collects sensitive password input from merchants with masked characters.
+ */
 export type PasswordFieldProps = PreactFieldProps<
   Required<PasswordFieldProps$1>['autocomplete']
 > &
@@ -218,12 +353,26 @@ export type PasswordFieldProps = PreactFieldProps<
     >
   >;
 
+/**
+ * The password field custom element class that renders a password input field in the Shopify admin interface. This component allows merchants to enter passwords securely with characters automatically masked for privacy.
+ */
 declare class PasswordField
   extends PreactFieldElement<PasswordFieldProps['autocomplete']>
   implements PasswordFieldProps
 {
+  /**
+   * The maximum number of characters allowed in the password.
+   */
   accessor maxLength: PasswordFieldProps['maxLength'];
+  /**
+   * The minimum number of characters required in the password.
+   */
   accessor minLength: PasswordFieldProps['minLength'];
+  /**
+   * The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.
+   */
+  get value(): string;
+  set value(value: string);
   constructor();
 }
 declare global {
@@ -240,6 +389,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-password-field';
+/**
+ * The JSX props for the password field component. These properties extend `PasswordFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ */
 export interface PasswordFieldJSXProps
   extends Partial<PasswordFieldProps>,
     Pick<PasswordFieldProps$1, 'id'>,

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

@@ -1,5 +1,8 @@
 import {StandardComponents} from './StandardComponents';
 
+/**
+ * The components available for building print action extensions. Includes all standard components plus the admin print action component required for print action setup.
+ */
 export type PrintActionExtensionComponents =
   | StandardComponents
   | 'AdminPrintAction';

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

@@ -8,35 +8,75 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, QueryContainerProps$1} from './shared.d.ts';
 
-/** 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 string that contains CSS styles to apply to the component.
+ */
 export type Styles = string;
+/**
+ * The implementation details for rendering a Preact custom element with a shadow root.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
   styles?: Styles;
 };
+/**
+ * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ */
 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. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
+   */
   button: number;
 }
+/**
+ * The options for customizing how a synthetic click is performed.
+ */
 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;
 }
@@ -83,16 +123,28 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The properties you can set on a query container component.
+ */
 export interface QueryContainerProps
   extends Required<Pick<QueryContainerProps$1, 'id' | 'containerName'>> {}
 
+/**
+ * A component that sets up a container query context, which lets child elements style themselves based on the container's size instead of the viewport size.
+ */
 declare class QueryContainer
   extends PreactCustomElement
   implements QueryContainerProps
 {
+  /**
+   * The name of the container, which you can reference in CSS container queries.
+   */
   accessor containerName: QueryContainerProps['containerName'];
   /** @private */
   static globalStylesApplied: boolean;
+  /**
+   * Creates a new QueryContainer instance.
+   */
   constructor();
 }
 declare global {
@@ -109,12 +161,18 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the query container component.
+ */
 declare const tagName = 's-query-container';
+/**
+ * The JSX properties you can set on a query container component.
+ */
 export interface QueryContainerJSXProps
   extends Partial<QueryContainerProps$1>,
     Pick<QueryContainerProps$1, 'id' | 'children'> {
   /**
-   * The content of the container.
+   * The content to display inside the container.
    */
   children?: ComponentChildren;
 }