@shopify/ui-extensions 2025.10.13 → 2025.10.14

package/build/ts/surfaces/admin/components/SearchField.d.ts

@@ -8,44 +8,104 @@
 /// <reference lib="DOM" />
 import type {TextFieldProps, ComponentChildren} 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;
     })
   | null;
+/**
+ * Event handlers for field interactions in React-style syntax.
+ */
 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. */
 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>;
 }
 
+/**
+ * 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;
 }
@@ -93,26 +153,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 that are common to all text-based field components.
+ */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
     Required<
@@ -150,20 +240,56 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        */
       autocomplete: Autocomplete;
     };
+/**
+ * Base class for text-based field elements that support labels, errors, and other form field features.
+ */
 declare class PreactFieldElement<Autocomplete extends string = string>
   extends PreactInputElement
   implements PreactFieldProps<Autocomplete>
 {
+  /**
+   * A callback that's triggered when the field loses focus.
+   */
   accessor onblur: CallbackEventListener<'input'>;
+  /**
+   * A callback that's triggered when the field receives focus.
+   */
   accessor onfocus: CallbackEventListener<'input'>;
+  /**
+   * A hint about what kind of information should go in the field for autofill purposes.
+   */
   accessor autocomplete: PreactFieldProps<Autocomplete>['autocomplete'];
+  /**
+   * The initial value that the field should display when it's first rendered.
+   */
   accessor defaultValue: PreactFieldProps['defaultValue'];
+  /**
+   * Additional text to provide context or guidance for the input.
+   */
   accessor details: PreactFieldProps['details'];
+  /**
+   * An error message that's displayed below the field when validation fails.
+   */
   accessor error: PreactFieldProps['error'];
+  /**
+   * The text that describes what the field is for.
+   */
   accessor label: PreactFieldProps['label'];
+  /**
+   * Controls whether the label is visible to all users or only to screen readers.
+   */
   accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility'];
+  /**
+   * Text that appears in the field when it's empty to provide a hint about what to enter.
+   */
   accessor placeholder: PreactFieldProps['placeholder'];
+  /**
+   * Whether the field can be edited by the user.
+   */
   accessor readOnly: PreactFieldProps['readOnly'];
+  /**
+   * Whether the field must be filled in before the form can be submitted.
+   */
   accessor required: PreactFieldProps['required'];
   /**
    * Global keyboard event handlers for things like key bindings typically
@@ -192,6 +318,9 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties for rendering a search field that lets users enter search queries with validation constraints and autofill support.
+ */
 export type SearchFieldProps = PreactFieldProps<
   /**
    * @default 'on'
@@ -217,12 +346,26 @@ export type SearchFieldProps = PreactFieldProps<
     >
   >;
 
+/**
+ * A search field that lets users enter search queries with a search-specific input type.
+ */
 declare class SearchField
   extends PreactFieldElement<SearchFieldProps['autocomplete']>
   implements SearchFieldProps
 {
+  /**
+   * The maximum number of characters that can be entered in the field.
+   */
   accessor maxLength: SearchFieldProps['maxLength'];
+  /**
+   * The minimum number of characters that must be entered for the field to be valid.
+   */
   accessor minLength: SearchFieldProps['minLength'];
+  /**
+   * The current search query 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.
+   */
+  get value(): string;
+  set value(value: string);
   constructor();
 }
 declare global {
@@ -239,6 +382,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-search-field';
+/**
+ * Props for using the search field component in JSX with React-style event handlers.
+ */
 export interface SearchFieldJSXProps
   extends Partial<SearchFieldProps>,
     Pick<TextFieldProps, 'id'>,

package/build/ts/surfaces/admin/components/Section/Section.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Section.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Section/Section.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAsIX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Section.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Section/Section.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAuHX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Section.d.ts

@@ -7,40 +7,88 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, SectionProps$1} from './shared.d.ts';
 
+/**
+ * A version of the section properties with all fields required.
+ */
 export type RequiredSectionProps = Required<SectionProps$1>;
+/**
+ * The properties for the section component. A section groups related content together with an optional heading, providing semantic structure and visual separation.
+ */
 export interface SectionProps
   extends Pick<
     RequiredSectionProps,
     'accessibilityLabel' | 'heading' | 'padding'
   > {
+  /**
+   * An accessibility label for screen readers that provides additional context when the heading isn't descriptive enough on its own.
+   */
   accessibilityLabel: RequiredSectionProps['accessibilityLabel'];
+  /**
+   * The heading text that appears at the top of the section, helping users understand what content the section contains.
+   */
   heading: RequiredSectionProps['heading'];
+  /**
+   * Whether the section has padding around its content. Set to `true` to add padding, or `false` to remove it.
+   */
   padding: RequiredSectionProps['padding'];
 }
 
+/**
+ * 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[];
@@ -78,27 +126,49 @@ 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 section is a container that groups related content together with an optional heading.
+ */
 declare class Section extends PreactCustomElement implements SectionProps {
   constructor();
   /** @private */
   connectedCallback(): void;
+  /**
+   * The accessibility label for screen readers.
+   */
   accessor accessibilityLabel: SectionProps['accessibilityLabel'];
+  /**
+   * The heading text for the section.
+   */
   accessor heading: SectionProps['heading'];
+  /**
+   * Whether the section has padding.
+   */
   accessor padding: SectionProps['padding'];
 }
 declare global {
@@ -115,11 +185,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-section';
+/**
+ * The properties for the section component when it's used in JSX.
+ */
 export interface SectionJSXProps
   extends Partial<SectionProps>,
     Pick<SectionProps$1, 'id' | 'children'> {
   /**
-   * The content of the Section.
+   * The child elements to render inside the section.
    */
   children?: ComponentChildren;
 }

package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Select.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Select/Select.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAKpE,QAAA,MAAM,IAAI,EAAE,kCAiLX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Select.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Select/Select.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAKpE,QAAA,MAAM,IAAI,EAAE,kCAgLX,CAAC;AAEF,eAAe,IAAI,CAAC"}