@shopify/ui-extensions 2025.10.13 → 2025.10.14

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

@@ -14,9 +14,18 @@ import type {
   IconType,
 } from './shared.d.ts';
 
+/**
+ * An event that includes a strongly-typed reference to the element that triggered it.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event handler was attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * A function that handles events for a specific element type, or null if no handler is set.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
@@ -24,11 +33,17 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /** 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. */
@@ -37,20 +52,50 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * 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;
 }
@@ -98,26 +143,56 @@ declare abstract class PreactCustomElement extends BaseClass {
 }
 
 declare const internals: unique symbol;
+/**
+ * The core properties that all input elements need to function within forms.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/**
+ * Base class for input elements that participate in form submission.
+ */
 declare class PreactInputElement
   extends PreactCustomElement
   implements PreactInputProps
 {
+  /**
+   * Indicates that this element can participate in form submission.
+   */
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * A callback that's triggered when the input's value changes and the field loses focus.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * A callback that's triggered when the input's 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'];
+  /**
+   * A unique identifier for the input element.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * The name that identifies this input when the form is submitted.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value of the input.
+   */
   get value(): PreactInputProps['value'];
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties for displaying an icon within a component.
+ */
 export interface IconProps
   extends Pick<
     IconProps$1,
@@ -127,14 +202,26 @@ export interface IconProps
    * Specifies the type of icon that will be displayed.
    */
   type: '' | IconType | 'empty';
+  /**
+   * The semantic meaning of the icon, which affects its color.
+   */
   tone: Extract<
     IconProps$1['tone'],
     'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
   >;
+  /**
+   * The visual prominence of the icon.
+   */
   color: Extract<IconProps$1['color'], 'base' | 'subdued'>;
+  /**
+   * The size of the icon.
+   */
   size: Extract<IconProps$1['size'], 'small' | 'base'>;
 }
 
+/**
+ * Properties for rendering a select dropdown that lets users choose one option from a list with optional icon and label customization.
+ */
 export interface SelectProps
   extends Omit<PreactInputProps, 'value'>,
     Required<
@@ -151,23 +238,57 @@ export interface SelectProps
         | 'labelAccessibilityVisibility'
       >
     > {
+  /**
+   * The value of the currently selected option, matching one of the `value` properties from the available options.
+   */
   value: Required<SelectProps$1>['value'];
+  /**
+   * An icon that's displayed at the start of the select field to provide visual context for the selection.
+   */
   icon: IconProps['type'];
 }
 
 declare const usedFirstOptionSymbol: unique symbol;
 declare const hasInitialValueSymbol: unique symbol;
 
+/**
+ * A select dropdown that lets users choose one option from a list.
+ */
 declare class Select extends PreactInputElement implements SelectProps {
+  /**
+   * An icon that's displayed at the start of the select field.
+   */
   accessor icon: SelectProps['icon'];
+  /**
+   * Additional text to provide context or guidance for the select.
+   */
   accessor details: SelectProps['details'];
+  /**
+   * An error message that's displayed below the select when validation fails.
+   */
   accessor error: SelectProps['error'];
+  /**
+   * The text that describes what the select is for.
+   */
   accessor label: SelectProps['label'];
+  /**
+   * Text that appears in the select when no option is selected to provide a hint about what to choose.
+   */
   accessor placeholder: SelectProps['placeholder'];
+  /**
+   * Whether an option must be selected before the form can be submitted.
+   */
   accessor required: SelectProps['required'];
+  /**
+   * Controls whether the label is visible to all users or only to screen readers.
+   */
   accessor labelAccessibilityVisibility: SelectProps['labelAccessibilityVisibility'];
   /** @private */
   connectedCallback(): void;
+  /**
+   * A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.
+   * @private
+   */
   disconnectedCallback(): void;
   constructor();
   /**
@@ -181,6 +302,9 @@ declare class Select extends PreactInputElement implements SelectProps {
    * @private
    */
   [hasInitialValueSymbol]: boolean;
+  /**
+   * The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected Option component.
+   */
   get value(): string;
   set value(value: string);
   /** @private */
@@ -200,18 +324,33 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-select';
+/**
+ * Properties for using the select component in JSX with React-style event handlers.
+ */
 export interface SelectJSXProps
   extends Partial<SelectProps>,
     Pick<SelectProps$1, 'id' | 'children'> {
   /**
-   * The options a user can select from.
+   * The selectable options displayed in the dropdown list.
    *
-   * Accepts `Option` and `OptionGroup` components.
+   * Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.
    */
   children?: ComponentChildren;
+  /**
+   * A callback that's triggered when the selected option changes and the select loses focus.
+   */
   onChange?: (event: CallbackEvent<typeof tagName>) => void;
+  /**
+   * A callback that's triggered when the selected option changes as the user interacts with the dropdown.
+   */
   onInput?: (event: CallbackEvent<typeof tagName>) => void;
+  /**
+   * A callback that's triggered when the select loses focus after the user interacts with it.
+   */
   onBlur?: (event: CallbackEvent<typeof tagName>) => void;
+  /**
+   * A callback that's triggered when the select receives focus from the user.
+   */
   onFocus?: (event: CallbackEvent<typeof tagName>) => void;
 }
 

package/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html

@@ -0,0 +1,5 @@
+<s-stack direction="inline" alignItems="center" gap="large">
+  <s-spinner accessibilityLabel="Loading" size="base"></s-spinner>
+  <s-spinner accessibilityLabel="Loading" size="large"></s-spinner>
+  <s-spinner accessibilityLabel="Loading" size="large-100"></s-spinner>
+</s-stack>

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

@@ -8,25 +8,61 @@
 /// <reference lib="DOM" />
 import type {SpinnerProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties you can set on a spinner component.
+ */
 export interface SpinnerProps
   extends Required<Pick<SpinnerProps$1, 'accessibilityLabel'>> {
+  /**
+   * The size of the spinner. Use `base` for the standard size, `large` for a larger spinner, or `large-100` for a full-width large spinner.
+   */
   size: Extract<SpinnerProps$1['size'], 'large' | 'large-100' | 'base'>;
 }
 
+/**
+ * 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;
 }
@@ -73,19 +109,39 @@ 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 component that displays an animated loading indicator to show that content is currently being processed.
+ */
 declare class Spinner extends PreactCustomElement implements SpinnerProps {
+  /**
+   * A label that describes the spinner for assistive technologies.
+   */
   accessor accessibilityLabel: string;
+  /**
+   * The size of the spinner.
+   */
   accessor size: SpinnerProps['size'];
+  /**
+   * Creates a new Spinner instance.
+   */
   constructor();
 }
 declare global {
@@ -101,7 +157,13 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the spinner component.
+ */
 declare const tagName = 's-spinner';
+/**
+ * The JSX properties you can set on a spinner component.
+ */
 export interface SpinnerJSXProps
   extends Partial<SpinnerProps>,
     Pick<SpinnerProps$1, 'id'> {}