@shopify/ui-extensions 2025.10.13 → 2025.10.14

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

@@ -12,37 +12,80 @@ import type {
   InteractionProps,
 } from './shared.d.ts';
 
+/**
+ * The properties you can set on a tooltip component.
+ */
 export interface TooltipProps extends Required<Pick<TooltipProps$1, 'id'>> {}
 
-/** 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;
 }
@@ -89,12 +132,15 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The properties for controlling overlay elements like popovers, tooltips, and menus through command interactions.
+ */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
   /**
-   * Sets the action the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this clickable is activated.
+   * The action that the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.
    *
-   * See the documentation of particular components for the actions they support.
+   * See the documentation of specific components for the actions they support.
    *
    * - `--auto`: a default action for the target component.
    * - `--show`: shows the target component.
@@ -108,11 +154,11 @@ export interface PreactOverlayControlProps
     '--show' | '--hide' | '--toggle' | '--auto'
   >;
   /**
-   * Sets the element the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this clickable is activated.
+   * The element that the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.
    */
   commandFor: Extract<InteractionProps['commandFor'], string>;
   /**
-   * Sets the element the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this clickable is activated.
+   * The element that the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this component is activated.
    */
   interestFor: Extract<InteractionProps['interestFor'], string>;
 }
@@ -120,25 +166,40 @@ export interface PreactOverlayControlProps
 /**
  * Shared symbols for overlay control functionality.
  * These symbols are used by components that implement overlay behavior
- * (like Popover, Tooltip, Modal, etc.) to communicate with the overlay control system.
- */
-/**
- * Symbol used to track the open or closed state of the overlay.
+ * (such as Popover, Tooltip, and Modal) to communicate with the overlay control system.
  */
+/** @private */
 declare const overlayHidden: unique symbol;
-/**
- * Symbol used to track the element that opened the overlay. In some cases, like tooltips and popovers, the overlay is positioned against this element. In all cases, focus should be restored to this element when the overlay is closed.
- */
+/** @private */
 declare const overlayActivator: unique symbol;
+/** @private */
 declare const overlayHideFrameId: unique symbol;
+/**
+ * The initialization object for creating a polyfill command event.
+ */
 export type PolyfillCommandEventInit = EventInit & {
+  /**
+   * The element that triggered the command.
+   */
   source: HTMLElement | null | undefined;
+  /**
+   * The command action that should be performed.
+   */
   command: PreactOverlayControlProps['command'];
 };
+/**
+ * A polyfill event for the command interaction pattern, which is used to control overlay elements.
+ */
 export type PolyfillCommandEvent = Event & {
+  /**
+   * The element that triggered the command.
+   */
   source: PolyfillCommandEventInit['source'];
+  /**
+   * The command action that should be performed.
+   */
   command: PolyfillCommandEventInit['command'];
-  /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */
+  /** You have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers. */
   _s_shadowSource: PolyfillCommandEventInit['source'];
 };
 declare global {
@@ -147,7 +208,13 @@ declare global {
   }
 }
 
+/**
+ * The base class for overlay elements that can be shown and hidden through command interactions.
+ */
 declare class PreactOverlayElement extends PreactCustomElement {
+  /**
+   * Creates a new overlay element with the given render implementation.
+   */
   constructor(renderImpl: RenderImpl);
   /** @private */
   [overlayHidden]: boolean;
@@ -157,7 +224,13 @@ declare class PreactOverlayElement extends PreactCustomElement {
   [overlayHideFrameId]?: number;
 }
 
+/**
+ * A component that displays a small popup with explanatory text when the user hovers over or focuses on an element.
+ */
 declare class Tooltip extends PreactOverlayElement implements TooltipProps {
+  /**
+   * Creates a new Tooltip instance.
+   */
   constructor();
 }
 declare global {
@@ -173,14 +246,18 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the tooltip component.
+ */
 declare const tagName = 's-tooltip';
+/**
+ * The JSX properties you can set on a tooltip component.
+ */
 export interface TooltipJSXProps
   extends Partial<TooltipProps>,
     Pick<TooltipProps$1, 'id' | 'children'> {
   /**
-   * The content of the Tooltip.
-   *
-   * Only accepts `Text`, `Paragraph` components, and raw `textContent`.
+   * The content to display inside the tooltip, which should include text or paragraph components, or raw text content.
    */
   children?: ComponentChildren;
 }

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

@@ -1,5 +1,5 @@
 <s-url-field
   label="Your website"
-  details="Join the partner ecosystem"
-  placeholder="https://shopify.com/partner"
+  details="Enter your business website"
+  placeholder="https://example.com"
 ></s-url-field>

package/src/surfaces/admin/components/URLField/examples/with-default-value.html

@@ -1,7 +1,5 @@
-<s-stack gap="base">
-  <s-url-field
-    label="Profile URL"
-    value="https://shop.myshopify.com"
-    readOnly
-  ></s-url-field>
-</s-stack>
+<s-url-field
+  label="Profile URL"
+  value="https://shop.myshopify.com"
+  readOnly
+></s-url-field>

package/src/surfaces/admin/components/URLField.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,18 +328,40 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The properties for the URL field component. These properties configure an input field that allows merchants to enter and validate web addresses (URLs) with built-in validation.
+ */
 export type URLFieldProps = PreactFieldProps<
   Required<URLFieldProps$1>['autocomplete']
 > &
   Required<Pick<URLFieldProps$1, 'maxLength' | 'minLength'>>;
 
+/**
+ * The URL field custom element class that renders a URL input field in the Shopify admin interface. This component allows merchants to enter web addresses with automatic URL validation and appropriate mobile keyboard layouts.
+ */
 declare class URLField
   extends PreactFieldElement<URLFieldProps['autocomplete']>
   implements URLFieldProps
 {
+  /**
+   * A hint about the intended content of the field for browser autofill.
+   *
+   * @default 'url'
+   */
   accessor autocomplete: URLFieldProps['autocomplete'];
+  /**
+   * The maximum number of characters allowed in the URL.
+   */
   accessor maxLength: URLFieldProps['maxLength'];
+  /**
+   * The minimum number of characters required in the URL.
+   */
   accessor minLength: URLFieldProps['minLength'];
+  /**
+   * The current URL 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 field validates this value as a URL format when the user finishes editing.
+   */
+  get value(): string;
+  set value(value: string);
   constructor();
 }
 declare global {
@@ -224,6 +378,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-url-field';
+/**
+ * The JSX props for the URL field component. These properties extend `URLFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ */
 export interface URLFieldJSXProps
   extends Partial<Omit<URLFieldProps, 'accessory'>>,
     Pick<URLFieldProps$1, 'id'>,

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

@@ -7,22 +7,56 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, UnorderedListProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the unordered list component. These properties define a bulleted list of items where the order doesn't matter.
+ */
 export interface UnorderedListProps extends UnorderedListProps$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 bulleted list of items where the order doesn't matter. Use unordered list when you have a collection of related items without a specific sequence, such as features, options, or bullet points.
+ */
 declare class UnorderedList
   extends PreactCustomElement
   implements UnorderedListProps
@@ -105,13 +152,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-unordered-list';
+/**
+ * The JSX properties for the unordered list component. These properties define how an unordered list is rendered in Preact or JSX.
+ */
 export interface UnorderedListJSXProps
   extends Partial<UnorderedListProps>,
     Pick<UnorderedListProps$1, 'id'> {
   /**
-   * The items of the UnorderedList.
-   *
-   * Only ListItems are accepted.
+   * The items in the unordered list. Only list item components are accepted.
    */
   children?: ComponentChildren;
 }