@shopify/ui-extensions 2026.1.3 → 2026.1.5

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

@@ -14,6 +14,7 @@ import type {
 
 /**
  * An event object with a strongly-typed currentTarget property that references the specific HTML element type.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -23,6 +24,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * An event listener function or null that receives a typed callback event.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -34,6 +36,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /**
  * The React-style event handler props for form field components.
+ * @publicDocs
  */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
   /**
@@ -55,6 +58,7 @@ export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
 }
 /**
  * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -73,10 +77,12 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * A string containing CSS styles to be applied to the component.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation details for rendering a custom element with a shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -90,6 +96,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * An object containing information about keyboard and mouse button states during an activation event.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -111,6 +118,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for programmatically triggering a click event on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -164,6 +172,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 declare const internals: unique symbol;
 /**
  * The required props for input elements that all form controls must implement.
+ * @publicDocs
  */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
@@ -212,6 +221,7 @@ declare class PreactInputElement
 
 /**
  * The common props shared by all form field components in the admin UI.
+ * @publicDocs
  */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
@@ -330,6 +340,7 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the password field component. These properties configure a secure input field that collects sensitive password input from merchants with masked characters.
+ * @publicDocs
  */
 export type PasswordFieldProps = PreactFieldProps<
   Required<PasswordFieldProps$1>['autocomplete']
@@ -391,6 +402,7 @@ declare module 'preact' {
 declare const tagName = 's-password-field';
 /**
  * The JSX props for the password field component. These properties extend `PasswordFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ * @publicDocs
  */
 export interface PasswordFieldJSXProps
   extends Partial<PasswordFieldProps>,
@@ -398,4 +410,7 @@ export interface PasswordFieldJSXProps
     FieldReactProps<typeof tagName> {}
 
 export {PasswordField};
+/**
+ * @publicDocs
+ */
 export type {PasswordFieldJSXProps};

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, QueryContainerProps$1} from './shared.d.ts';
 
 /**
  * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -27,6 +28,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 }
 /**
  * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ * @publicDocs
  */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
@@ -35,10 +37,12 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * A string that contains CSS styles to apply to the component.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation details for rendering a Preact custom element with a shadow root.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -52,6 +56,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -73,6 +78,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -125,6 +131,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The properties you can set on a query container component.
+ * @publicDocs
  */
 export interface QueryContainerProps
   extends Required<Pick<QueryContainerProps$1, 'id' | 'containerName'>> {}
@@ -167,6 +174,7 @@ declare module 'preact' {
 declare const tagName = 's-query-container';
 /**
  * The JSX properties you can set on a query container component.
+ * @publicDocs
  */
 export interface QueryContainerJSXProps
   extends Partial<QueryContainerProps$1>,
@@ -178,4 +186,7 @@ export interface QueryContainerJSXProps
 }
 
 export {QueryContainer};
+/**
+ * @publicDocs
+ */
 export type {QueryContainerJSXProps};

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

@@ -10,6 +10,7 @@ import type {TextFieldProps, ComponentChildren} from './shared.d.ts';
 
 /**
  * An event that includes a strongly-typed reference to the element that triggered it.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -19,6 +20,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * A function that handles events for a specific element type, or null if no handler is set.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -27,6 +29,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /**
  * Event handlers for field interactions in React-style syntax.
+ * @publicDocs
  */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
   /**
@@ -50,6 +53,7 @@ export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
 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.
+   * @publicDocs
    */
   key?: preact.Key;
   /**
@@ -64,10 +68,12 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * CSS styles that will be applied to the component's shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * Configuration for rendering a custom element with Preact and shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -81,6 +87,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -102,6 +109,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -155,6 +163,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 declare const internals: unique symbol;
 /**
  * The core properties that all input elements need to function within forms.
+ * @publicDocs
  */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
@@ -202,6 +211,7 @@ declare class PreactInputElement
 
 /**
  * Properties that are common to all text-based field components.
+ * @publicDocs
  */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
@@ -320,6 +330,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.
+ * @publicDocs
  */
 export type SearchFieldProps = PreactFieldProps<
   /**
@@ -384,6 +395,7 @@ declare module 'preact' {
 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>,
@@ -391,4 +403,7 @@ export interface SearchFieldJSXProps
     FieldReactProps<typeof tagName> {}
 
 export {SearchField};
+/**
+ * @publicDocs
+ */
 export type {SearchFieldJSXProps};

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

@@ -9,10 +9,12 @@ import type {ComponentChildren, SectionProps$1} from './shared.d.ts';
 
 /**
  * A version of the section properties with all fields required.
+ * @publicDocs
  */
 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.
+ * @publicDocs
  */
 export interface SectionProps
   extends Pick<
@@ -35,10 +37,12 @@ export interface SectionProps
 
 /**
  * A string containing CSS styles for a custom element.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The configuration for rendering a custom element with Preact.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -52,6 +56,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * An interface representing the properties of an activation event, such as a click or keypress.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -73,6 +78,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -128,6 +134,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -145,6 +152,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 }
 /**
  * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ * @publicDocs
  */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
@@ -187,6 +195,7 @@ declare module 'preact' {
 declare const tagName = 's-section';
 /**
  * The properties for the section component when it's used in JSX.
+ * @publicDocs
  */
 export interface SectionJSXProps
   extends Partial<SectionProps>,
@@ -198,4 +207,7 @@ export interface SectionJSXProps
 }
 
 export {Section};
+/**
+ * @publicDocs
+ */
 export type {SectionJSXProps};

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

@@ -16,6 +16,7 @@ import type {
 
 /**
  * An event that includes a strongly-typed reference to the element that triggered it.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -25,6 +26,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * A function that handles events for a specific element type, or null if no handler is set.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -35,6 +37,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
 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.
+   * @publicDocs
    */
   key?: preact.Key;
   /**
@@ -54,10 +57,12 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * CSS styles that will be applied to the component's shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * Configuration for rendering a custom element with Preact and shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -71,6 +76,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -92,6 +98,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -145,6 +152,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 declare const internals: unique symbol;
 /**
  * The core properties that all input elements need to function within forms.
+ * @publicDocs
  */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
@@ -192,6 +200,7 @@ declare class PreactInputElement
 
 /**
  * Properties for displaying an icon within a component.
+ * @publicDocs
  */
 export interface IconProps
   extends Pick<
@@ -221,6 +230,7 @@ export interface IconProps
 
 /**
  * Properties for rendering a select dropdown that lets users choose one option from a list with optional icon and label customization.
+ * @publicDocs
  */
 export interface SelectProps
   extends Omit<PreactInputProps, 'value'>,
@@ -326,6 +336,7 @@ declare module 'preact' {
 declare const tagName = 's-select';
 /**
  * Properties for using the select component in JSX with React-style event handlers.
+ * @publicDocs
  */
 export interface SelectJSXProps
   extends Partial<SelectProps>,
@@ -355,4 +366,7 @@ export interface SelectJSXProps
 }
 
 export {Select};
+/**
+ * @publicDocs
+ */
 export type {SelectJSXProps};

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

@@ -10,6 +10,7 @@ import type {SpinnerProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties you can set on a spinner component.
+ * @publicDocs
  */
 export interface SpinnerProps
   extends Required<Pick<SpinnerProps$1, 'accessibilityLabel'>> {
@@ -21,10 +22,12 @@ export interface SpinnerProps
 
 /**
  * A string that contains CSS styles to apply to the component.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation details for rendering a Preact custom element with a shadow root.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -38,6 +41,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -59,6 +63,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -111,6 +116,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -163,10 +169,14 @@ declare module 'preact' {
 declare const tagName = 's-spinner';
 /**
  * The JSX properties you can set on a spinner component.
+ * @publicDocs
  */
 export interface SpinnerJSXProps
   extends Partial<SpinnerProps>,
     Pick<SpinnerProps$1, 'id'> {}
 
 export {Spinner};
+/**
+ * @publicDocs
+ */
 export type {SpinnerJSXProps};