@shopify/ui-extensions 2025.10.13 → 2025.10.14

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

@@ -12,44 +12,106 @@ import type {
   ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * An event with a strongly-typed currentTarget property for a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event listener is attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * A callback function that receives a strongly-typed event for a specific HTML element.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
+/**
+ * The React-style event callback props for form field components.
+ */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
+  /**
+   * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
+   */
   onInput?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
+   */
   onChange?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
+   */
   onFocus?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
+   */
   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 for the component's shadow DOM.
+ */
 export type Styles = string;
+/**
+ * The configuration for rendering a Preact component in a shadow root.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's Preact elements into the shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the shadow root.
+   */
   styles?: Styles;
 };
+/**
+ * The properties from an event that indicate how the user activated an element.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down when the event occurred.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on macOS) was held down when the event occurred.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was held down when the event occurred.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right).
+   */
   button: number;
 }
+/**
+ * The options for influencing a programmatic 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;
 }
@@ -97,9 +159,13 @@ declare abstract class PreactCustomElement extends BaseClass {
 }
 
 declare const internals: unique symbol;
+/**
+ * The base properties for an input element that participates in form submission.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/** @private */
 declare class PreactInputElement
   extends PreactCustomElement
   implements PreactInputProps
@@ -107,16 +173,39 @@ declare class PreactInputElement
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the user makes any changes in the field.
+   */
   accessor oninput: CallbackEventListener<'input'>;
+  /**
+   * Whether the field is disabled, disallowing any interaction.
+   *
+   * @default false
+   */
   accessor disabled: PreactInputProps['disabled'];
+  /**
+   * An identifier for the field.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * An identifier for the field that's unique within the nearest containing form.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value for the field.
+   */
   get value(): PreactInputProps['value'];
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The base properties for form field elements that support labels, validation, and autocomplete.
+ */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
     Required<
@@ -136,10 +225,10 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        * A hint as to the intended content of the field.
        *
        * 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
@@ -154,20 +243,58 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        */
       autocomplete: Autocomplete;
     };
+/** @private */
 declare class PreactFieldElement<Autocomplete extends string = string>
   extends PreactInputElement
   implements PreactFieldProps<Autocomplete>
 {
+  /**
+   * A callback that's invoked when the field loses focus.
+   */
   accessor onblur: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the field receives focus.
+   */
   accessor onfocus: CallbackEventListener<'input'>;
+  /**
+   * A hint as to the intended content of the field for autocomplete purposes.
+   */
   accessor autocomplete: PreactFieldProps<Autocomplete>['autocomplete'];
+  /**
+   * The initial value for the field when it's first rendered.
+   */
   accessor defaultValue: PreactFieldProps['defaultValue'];
+  /**
+   * Additional descriptive text to display below the field that provides supplementary information.
+   */
   accessor details: PreactFieldProps['details'];
+  /**
+   * An error message to display below the field, indicating validation failure or other issues.
+   */
   accessor error: PreactFieldProps['error'];
+  /**
+   * The text label to display for the field, describing what the user should enter.
+   */
   accessor label: PreactFieldProps['label'];
+  /**
+   * Controls the visibility of the label for accessibility purposes.
+   */
   accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility'];
+  /**
+   * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input.
+   */
   accessor placeholder: PreactFieldProps['placeholder'];
+  /**
+   * Whether the field is read-only, preventing edits while still allowing focus and selection.
+   *
+   * @default false
+   */
   accessor readOnly: PreactFieldProps['readOnly'];
+  /**
+   * Whether the field must be filled out before form submission.
+   *
+   * @default false
+   */
   accessor required: PreactFieldProps['required'];
   /**
    * Global keyboard event handlers for things like key bindings typically
@@ -196,6 +323,9 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The properties for the number field component. These properties configure a specialized input field for entering numeric values with support for validation, formatting, range constraints, and optimized mobile input modes.
+ */
 export interface NumberFieldProps
   extends Omit<
       PreactFieldProps<Required<NumberFieldProps$1>['autocomplete']>,
@@ -207,20 +337,50 @@ export interface NumberFieldProps
         'inputMode' | 'max' | 'min' | 'prefix' | 'step' | 'suffix'
       >
     > {
+  /**
+   * The current value for the field, represented as a string.
+   */
   value: Required<NumberFieldProps$1>['value'];
 }
 
+/**
+ * The number field custom element class that renders a numeric input field in the Shopify admin interface. This component allows merchants to enter numbers with automatic validation and prefix/suffix display.
+ */
 declare class NumberField
   extends PreactFieldElement<NumberFieldProps['autocomplete']>
   implements NumberFieldProps
 {
+  /**
+   * The current numeric 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 should be a numeric string (decimal or integer).
+   */
   get value(): string;
   set value(value: string);
+  /**
+   * The input mode hint for mobile keyboards. Available values include:
+   * - `numeric`: Shows a numeric keypad optimized for entering numbers
+   * - `decimal`: Shows a numeric keypad with decimal point support
+   * - `tel`: Shows a telephone keypad
+   */
   accessor inputMode: NumberFieldProps['inputMode'];
+  /**
+   * The granularity that the value must adhere to, or the keyword `any`. This controls the increment/decrement step size.
+   */
   accessor step: NumberFieldProps['step'];
+  /**
+   * The maximum numeric value allowed in the field.
+   */
   accessor max: NumberFieldProps['max'];
+  /**
+   * The minimum numeric value allowed in the field.
+   */
   accessor min: NumberFieldProps['min'];
+  /**
+   * Text or content to display before the user's input, such as a currency symbol.
+   */
   accessor prefix: NumberFieldProps['prefix'];
+  /**
+   * Text or content to display after the user's input, such as a unit of measurement.
+   */
   accessor suffix: NumberFieldProps['suffix'];
   constructor();
 }
@@ -238,6 +398,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-number-field';
+/**
+ * The JSX props for the number field component. These properties extend `NumberFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ */
 export interface NumberFieldJSXProps
   extends Partial<NumberFieldProps>,
     Pick<NumberFieldProps$1, 'id'>,

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

@@ -8,25 +8,58 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, OptionProps$1} from './shared.d.ts';
 
+/**
+ * Properties for rendering a single option within a select dropdown that users can choose from.
+ */
 export interface OptionProps
   extends Required<
     Pick<OptionProps$1, 'disabled' | 'value' | 'selected' | 'defaultSelected'>
   > {}
 
+/**
+ * CSS styles that will be applied to the component's shadow DOM.
+ */
 export type Styles = string;
+/**
+ * Configuration for rendering a custom element with Preact and shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * A function that renders the component's content inside the shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * CSS styles that will be applied to the shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * Information about modifier keys and mouse buttons that were active during an interaction.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down during the interaction.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was held down during the interaction.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the interaction.
+   */
   button: number;
 }
+/**
+ * Options for influencing how a programmatic click behaves.
+ */
 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;
 }
@@ -75,11 +108,17 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /** Used when an element does not have children. */
 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. */
@@ -88,10 +127,25 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A single option within a select dropdown that users can choose.
+ */
 declare class Option extends PreactCustomElement implements OptionProps {
+  /**
+   * Whether the option is currently selected.
+   */
   accessor selected: OptionProps['selected'];
+  /**
+   * Whether the option should be selected when it's first rendered.
+   */
   accessor defaultSelected: OptionProps['defaultSelected'];
+  /**
+   * The value that's submitted with the form when this option is selected.
+   */
   accessor value: OptionProps['value'];
+  /**
+   * Whether the option is disabled and can't be selected.
+   */
   accessor disabled: OptionProps['disabled'];
   constructor();
 }
@@ -109,11 +163,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-option';
+/**
+ * Properties for using the option component in JSX with React-style props.
+ */
 export interface OptionJSXProps
   extends Partial<OptionProps>,
     Pick<OptionProps$1, 'id' | 'children'> {
   /**
-   * The content to use as the label.
+   * The content that's used as the option label, displayed in the dropdown list.
    */
   children?: ComponentChildren;
 }

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

@@ -8,23 +8,56 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, OptionGroupProps$1} from './shared.d.ts';
 
+/**
+ * Properties for rendering a group of related options within a select dropdown, organized under a shared label.
+ */
 export interface OptionGroupProps
   extends Required<Pick<OptionGroupProps$1, 'disabled' | 'label'>> {}
 
+/**
+ * CSS styles that will be applied to the component's shadow DOM.
+ */
 export type Styles = string;
+/**
+ * Configuration for rendering a custom element with Preact and shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * A function that renders the component's content inside the shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * CSS styles that will be applied to the shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * Information about modifier keys and mouse buttons that were active during an interaction.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down during the interaction.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was held down during the interaction.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the interaction.
+   */
   button: number;
 }
+/**
+ * Options for influencing how a programmatic click behaves.
+ */
 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;
 }
@@ -73,11 +106,17 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /** Used when an element does not have children. */
 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. */
@@ -86,11 +125,20 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A group of related options within a select dropdown, displayed with a label.
+ */
 declare class OptionGroup
   extends PreactCustomElement
   implements OptionGroupProps
 {
+  /**
+   * Whether all options in the group are disabled and can't be selected.
+   */
   accessor disabled: OptionGroupProps['disabled'];
+  /**
+   * The text that describes what this group of options represents.
+   */
   accessor label: OptionGroupProps['label'];
   constructor();
 }
@@ -109,13 +157,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-option-group';
+/**
+ * Properties for using the option group component in JSX with React-style props.
+ */
 export interface OptionGroupJSXProps
   extends Partial<OptionGroupProps>,
     Pick<OptionGroupProps$1, 'id' | 'children'> {
   /**
-   * The options a user can select from.
-   *
-   * Accepts `Option` components.
+   * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/OrderedList/examples/default.html

@@ -1,5 +1,5 @@
 <s-ordered-list>
-  <s-list-item>Red shirt</s-list-item>
-  <s-list-item>Green shirt</s-list-item>
-  <s-list-item>Blue shirt</s-list-item>
+  <s-list-item>Add products to your catalog</s-list-item>
+  <s-list-item>Set up payment methods</s-list-item>
+  <s-list-item>Configure shipping zones</s-list-item>
 </s-ordered-list>

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

@@ -7,22 +7,56 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, OrderedListProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the ordered list component. These properties define a numbered list of items with automatic numbering and proper list semantics.
+ */
 export interface OrderedListProps extends OrderedListProps$1 {}
 
+/**
+ * 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;
 }
@@ -69,21 +103,34 @@ 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 a numbered list of items with automatic numbering and proper list semantics. Use ordered list when the sequence or order of items matters, such as instructions, rankings, or step-by-step processes.
+ */
 declare class OrderedList
   extends PreactCustomElement
   implements OrderedListProps
@@ -105,13 +152,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-ordered-list';
+/**
+ * The JSX properties for the ordered list component. These properties define how an ordered list is rendered in Preact or JSX.
+ */
 export interface OrderedListJSXProps
   extends Partial<OrderedListProps>,
     Pick<OrderedListProps$1, 'id'> {
   /**
-   * The items of the OrderedList.
-   *
-   * Only ListItems are accepted.
+   * The items in the ordered list. Only list item components are accepted.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/Paragraph/examples/subdued-color.html

@@ -0,0 +1,3 @@
+<s-paragraph color="subdued">
+  Changes will take effect the next time the customer visits your store.
+</s-paragraph>