@shopify/ui-extensions 2026.7.4 → 2026.10.0-rc.10

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.25.0 **/
+/** VERSION: 2.23.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -6,20 +6,32 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {TextFieldProps, ComponentChildren} from './shared.d.ts';
+import type {
+  TextFieldProps,
+  PreactCustomElement,
+  RenderImpl,
+} from './shared.d.ts';
+import * as preact$1 from 'preact';
+import {ReactNode, RefAttributes} from 'react';
 
 /**
- * An event that includes a strongly-typed reference to the element that triggered it.
+ * An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.
+ *
+ * This type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.
  * @publicDocs
  */
 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.
+ * A function that handles events from UI components.
+ *
+ * This type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.
+ *
+ * @example
+ * const handleClick: CallbackEventListener<'button'> = (event) => {
+ *   console.log('Button clicked:', event.currentTarget);
+ * };
  * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
@@ -27,190 +39,133 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
       (event: CallbackEvent<T>): void;
     })
   | null;
-/**
- * Event handlers for field interactions in React-style syntax.
- * @publicDocs
- */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
   /**
-   * A callback that's triggered when the field's value changes as the user types.
+   * A callback fired when the user makes changes to the field value. This fires before `onChange`.
    */
   onInput?: ((event: CallbackEvent<T>) => void) | null;
   /**
-   * A callback that's triggered when the field's value changes and the field loses focus.
+   * A callback fired when the user has finished editing the field, such as when they blur the field.
    */
   onChange?: ((event: CallbackEvent<T>) => void) | null;
   /**
-   * A callback that's triggered when the field receives focus.
+   * A callback fired when the field receives focus.
    */
   onFocus?: ((event: CallbackEvent<T>) => void) | null;
   /**
-   * A callback that's triggered when the field loses focus.
+   * A callback fired when the field loses focus.
    */
   onBlur?: ((event: CallbackEvent<T>) => void) | null;
 }
-/** Used when an element does not have children. * @publicDocs
- */
-export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /**
-   * 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;
-  /**
-   * 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 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.
- * @publicDocs
+ * Props for field slot content (label, error, details) that accept
+ * either a string or JSX content in the React wrapper.
+ *
+ * Internal use only — not exported publicly. External consumers receive
+ * string-only types via FieldSlotPreactProps.
  */
-export type Styles = string;
+export interface FieldSlotInternalReactProps {
+  error?: preact.ComponentChildren;
+  details?: preact.ComponentChildren;
+}
 /**
- * Configuration for rendering a custom element with Preact and shadow DOM.
- * @publicDocs
+ * Preact JSX string-only versions of field slot props.
+ * Used in Preact module declarations after Omit-ing the ComponentChildren
+ * versions (required by force-omit-react-slots lint rule).
  */
-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;
-};
+export interface FieldSlotPreactProps {
+  error?: string;
+  details?: string;
+}
 /**
- * Information about modifier keys and mouse buttons that were active during an interaction.
+ * Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.
  * @publicDocs
  */
-export interface ActivationEventEsque {
-  /**
-   * Whether the Shift key was held down during the interaction.
-   */
-  shiftKey: boolean;
+export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
-   * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction.
+   * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
+   * Essential for maintaining component state and optimizing re-renders when lists change.
    */
-  metaKey: boolean;
+  key?: preact.Key;
   /**
-   * Whether the Control key was held down during the interaction.
+   * A reference to access the underlying DOM element directly.
+   * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
    */
-  ctrlKey: boolean;
+  ref?: preact.Ref<TClass>;
   /**
-   * The mouse button that was pressed during the interaction.
+   * The named slot to which this element is assigned in the parent component's shadow DOM.
+   *
+   * Used for advanced component composition with web components.
    */
-  button: number;
+  slot?: Lowercase<string>;
 }
-/**
- * Options for influencing how a programmatic click behaves.
- * @publicDocs
- */
-export interface ClickOptions {
-  /**
-   * 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;
+
+export type ReactIntrinsicElementChildren<PreactProps extends object> =
+  'children' extends keyof PreactProps
+    ? {
+        children?: ReactNode;
+      }
+    : Record<never, never>;
+export type ReactIntrinsicElementProps<
+  PreactProps extends object,
+  ElementType,
+> = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
+  ReactIntrinsicElementChildren<PreactProps> &
+  RefAttributes<ElementType> & {
+    slot?: Lowercase<string>;
+  };
+export type ReactIntrinsicElements = {
+  [Tag in Exclude<
+    Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
+    `s-test-${string}`
+  >]: ReactIntrinsicElementProps<
+    preact$1.createElement.JSX.IntrinsicElements[Tag],
+    Tag extends keyof HTMLElementTagNameMap
+      ? HTMLElementTagNameMap[Tag]
+      : HTMLElement
+  >;
+};
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements extends ReactIntrinsicElements {}
+  }
 }
-/**
- * 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;
-declare abstract class PreactCustomElement extends BaseClass {
-  /** @private */
-  static get observedAttributes(): string[];
-  constructor({
-    styles,
-    ShadowRoot: renderFunction,
-    delegatesFocus,
-    ...options
-  }: RenderImpl);
 
-  /** @private */
-  setAttribute(name: string, value: string): void;
-  /** @private */
-  attributeChangedCallback(name: string): void;
+declare class PolarisCustomElement extends PreactCustomElement {
+  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
   /** @private */
   connectedCallback(): void;
   /** @private */
-  disconnectedCallback(): void;
-  /** @private */
   adoptedCallback(): void;
-  /**
-   * Queue a run of the render function.
-   * You shouldn't need to call this manually - it should be handled by changes to @property values.
-   * @private
-   */
-  queueRender(): void;
-  /**
-   * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
-   *
-   * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
-   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
-   * @private
-   * @param options
-   */
-  click({sourceEvent}?: ClickOptions): void;
 }
 
 declare const internals: unique symbol;
 /**
- * The core properties that all input elements need to function within forms.
+ * Represents the essential input props required for Preact-based input elements. Includes properties like `disabled`, `id`, `name`, and `value`.
  * @publicDocs
  */
 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
+  extends PolarisCustomElement
   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.
+ * Represents the props for Preact-based form field components with autocomplete support. The generic type parameter allows specifying the valid autocomplete values for the field.
  * @publicDocs
  */
 export type PreactFieldProps<Autocomplete extends string = string> =
@@ -250,56 +205,20 @@ 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
@@ -329,7 +248,7 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 }
 
 /**
- * Properties for rendering a search field that lets users enter search queries with validation constraints and autofill support.
+ * Represents the props for search input field components. Extends `PreactFieldProps` for search-specific functionality.
  * @publicDocs
  */
 export type SearchFieldProps = PreactFieldProps<
@@ -357,26 +276,20 @@ export type SearchFieldProps = PreactFieldProps<
     >
   >;
 
-/**
- * A search field that lets users enter search queries with a search-specific input type.
- */
-declare class SearchField
+declare abstract class SearchFieldBase
   extends PreactFieldElement<SearchFieldProps['autocomplete']>
-  implements SearchFieldProps
+  implements Pick<SearchFieldProps, 'maxLength' | 'minLength'>
 {
-  /**
-   * 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(renderImpl: RenderImpl);
+}
+
+/**
+ * Configure the following properties on the search field component.
+ * @publicDocs
+ */
+declare class SearchField extends SearchFieldBase implements SearchFieldProps {
   constructor();
 }
 declare global {
@@ -387,20 +300,19 @@ declare global {
 declare module 'preact' {
   namespace createElement.JSX {
     interface IntrinsicElements {
-      [tagName]: SearchFieldJSXProps & PreactBaseElementProps<SearchField>;
+      [tagName]: Omit<SearchFieldJSXProps, 'error' | 'details'> &
+        FieldSlotPreactProps &
+        PreactBaseElementProps<SearchField>;
     }
   }
 }
 
 declare const tagName = 's-search-field';
-/**
- * Props for using the search field component in JSX with React-style event handlers.
- * @publicDocs
- */
 export interface SearchFieldJSXProps
-  extends Partial<SearchFieldProps>,
+  extends Partial<Omit<SearchFieldProps, 'error' | 'details'>>,
     Pick<TextFieldProps, 'id'>,
-    FieldReactProps<typeof tagName> {}
+    FieldReactProps<typeof tagName>,
+    FieldSlotInternalReactProps {}
 
 export {SearchField};
 export type {SearchFieldJSXProps};