@shopify/ui-extensions 2025.10.12 → 2025.10.14

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

@@ -8,35 +8,87 @@
 /// <reference lib="DOM" />
 import type {DividerProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the divider component. A divider creates a visual separator to distinguish different sections of content.
+ */
 export interface DividerProps
   extends Pick<DividerProps$1, 'direction' | 'color'> {
+  /**
+   * The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
+   *
+   * - `inline`: Horizontal divider for separating vertically stacked content
+   * - `block`: Vertical divider for separating horizontally arranged content
+   *
+   * @default 'inline'
+   */
   direction: Extract<DividerProps$1['direction'], 'inline' | 'block'>;
+  /**
+   * The visual prominence of the divider line.
+   *
+   * - `base`: Standard divider for most separations (default)
+   * - `strong`: More prominent divider for major section breaks
+   *
+   * @default 'base'
+   */
   color: Extract<DividerProps$1['color'], 'base' | 'strong'>;
 }
 
+/**
+ * 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;
 };
+/**
+ * An interface representing the properties of an activation event, such as a click or keypress.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the meta key (Command on Mac, Windows key on PC) 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.
  */
 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[];
@@ -74,18 +126,45 @@ 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>;
 }
 
+/**
+ * A divider is a visual separator that creates a line between different sections of content.
+ */
 declare class Divider extends PreactCustomElement implements DividerProps {
+  /**
+   * The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
+   *
+   * - `inline`: Horizontal divider for separating vertically stacked content
+   * - `block`: Vertical divider for separating horizontally arranged content
+   *
+   * @default 'inline'
+   */
   accessor direction: DividerProps['direction'];
+  /**
+   * The visual prominence of the divider line.
+   *
+   * - `base`: Standard divider for most separations (default)
+   * - `strong`: More prominent divider for major section breaks
+   *
+   * @default 'base'
+   */
   accessor color: DividerProps['color'];
   constructor();
 }
@@ -103,6 +182,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-divider';
+/**
+ * The properties for the divider component when it's used in JSX.
+ */
 export interface DividerJSXProps
   extends Partial<DividerProps>,
     Pick<DividerProps$1, 'id'> {}

package/src/surfaces/admin/components/DropZone/examples/upload-with-validation.html

@@ -0,0 +1,42 @@
+<s-drop-zone 
+  id="upload" 
+  label="Product images" 
+  accept="image/*" 
+  multiple
+></s-drop-zone>
+
+<script>
+  const dropzone = document.getElementById('upload');
+
+  dropzone.addEventListener('change', async (e) => {
+    const files = e.currentTarget.files;
+
+    // Validate size (5MB max per file)
+    const maxSize = 5 * 1024 * 1024;
+    if (files.some(f => f.size > maxSize)) {
+      dropzone.error = 'Files must be under 5MB';
+      return;
+    }
+    dropzone.error = '';
+
+    // Disable during upload
+    dropzone.disabled = true;
+
+    const formData = new FormData();
+    files.forEach(f => formData.append('images[]', f));
+
+    try {
+      await fetch('/api/upload', { method: 'POST', body: formData });
+      dropzone.value = ''; // Clear for next upload
+      // Show success feedback
+    } catch (error) {
+      dropzone.error = 'Upload failed. Please try again.';
+    } finally {
+      dropzone.disabled = false;
+    }
+  });
+
+  dropzone.addEventListener('droprejected', () => {
+    dropzone.error = 'Only image files are accepted';
+  });
+</script>

package/src/surfaces/admin/components/EmailField/examples/disabled-state.html

@@ -0,0 +1,5 @@
+<s-email-field
+  label="Account email"
+  value="admin@example.com"
+  disabled
+></s-email-field>

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

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

@@ -1,4 +1,4 @@
 <s-form>
   <s-text-field label="Email address" />
-  <s-button variant="primary" accessibilityRole="submit">Submit</s-button>
+  <s-button variant="primary" type="submit">Submit</s-button>
 </s-form>

package/src/surfaces/admin/components/Form/examples/with-choice-fields.html

@@ -0,0 +1,12 @@
+<s-form>
+  <s-stack direction="block" gap="base">
+    <s-text-field label="Discount code" name="code" required></s-text-field>
+    <s-select label="Discount type" name="type">
+      <s-option value="percentage">Percentage</s-option>
+      <s-option value="fixed">Fixed amount</s-option>
+      <s-option value="shipping">Free shipping</s-option>
+    </s-select>
+    <s-checkbox label="Apply to all products" name="allProducts" checked></s-checkbox>
+    <s-button variant="primary" type="submit">Create discount</s-button>
+  </s-stack>
+</s-form>

package/src/surfaces/admin/components/Form/examples/with-multiple-fields.html

@@ -0,0 +1,12 @@
+<s-form>
+  <s-stack direction="block" gap="base">
+    <s-text-field label="Campaign name" name="campaign" required></s-text-field>
+    <s-date-field label="Start date" name="startDate" required></s-date-field>
+    <s-date-field label="End date" name="endDate"></s-date-field>
+    <s-money-field label="Budget" name="budget"></s-money-field>
+    <s-stack direction="inline" gap="base">
+      <s-button variant="primary" type="submit">Create campaign</s-button>
+      <s-button type="reset">Reset</s-button>
+    </s-stack>
+  </s-stack>
+</s-form>

package/src/surfaces/admin/components/Form/examples/with-sections.html

@@ -0,0 +1,21 @@
+<s-form>
+  <s-stack direction="block" gap="large">
+    <s-section heading="Contact information">
+      <s-stack direction="block" gap="base">
+        <s-text-field label="Full name" name="name" required></s-text-field>
+        <s-email-field label="Email address" name="email" required></s-email-field>
+      </s-stack>
+    </s-section>
+    <s-section heading="Shipping preferences">
+      <s-stack direction="block" gap="base">
+        <s-select label="Shipping speed" name="speed">
+          <s-option value="standard">Standard (5–7 days)</s-option>
+          <s-option value="express">Express (2–3 days)</s-option>
+          <s-option value="overnight">Overnight</s-option>
+        </s-select>
+        <s-checkbox label="Require signature on delivery" name="signature"></s-checkbox>
+      </s-stack>
+    </s-section>
+    <s-button variant="primary" type="submit">Save preferences</s-button>
+  </s-stack>
+</s-form>

package/src/surfaces/admin/components/Form/examples/with-validation.html

@@ -0,0 +1,7 @@
+<s-form>
+  <s-stack direction="block" gap="base">
+    <s-text-field label="Product title" name="title" required error="Product title is required"></s-text-field>
+    <s-number-field label="Price" name="price" min="0" step="0.01" prefix="$" error="Price must be greater than 0"></s-number-field>
+    <s-button variant="primary" type="submit">Create product</s-button>
+  </s-stack>
+</s-form>