@shopify/ui-extensions 2026.1.3 → 2026.1.5

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

@@ -10,6 +10,7 @@ import type {ColorPickerProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * 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 & {
   /**
@@ -19,6 +20,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 & {
@@ -30,6 +32,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /**
  * 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> {
   /**
@@ -48,6 +51,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * Properties for rendering a color picker that provides a visual interface for selecting colors with optional transparency control.
+ * @publicDocs
  */
 export interface ColorPickerProps
   extends Required<
@@ -56,10 +60,12 @@ export interface ColorPickerProps
 
 /**
  * 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'> & {
   /**
@@ -73,6 +79,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 {
   /**
@@ -94,6 +101,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for programmatically triggering a click event on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -211,6 +219,7 @@ declare module 'preact' {
 declare const tagName = 's-color-picker';
 /**
  * The JSX props interface for the color picker component when used in React/Preact.
+ * @publicDocs
  */
 export interface ColorPickerJSXProps
   extends Partial<ColorPickerProps>,
@@ -229,4 +238,7 @@ export interface ColorPickerJSXProps
 }
 
 export {ColorPicker};
+/**
+ * @publicDocs
+ */
 export type {ColorPickerJSXProps};

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

@@ -15,6 +15,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 & {
   /**
@@ -24,6 +25,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 & {
@@ -35,6 +37,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /**
  * 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> {
   /**
@@ -53,10 +56,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'> & {
   /**
@@ -70,6 +75,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 {
   /**
@@ -91,6 +97,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for programmatically triggering a click event on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -144,6 +151,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'>
@@ -192,6 +200,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 &
@@ -309,6 +318,7 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the date field component. These properties configure an input field that allows merchants to select dates using an integrated calendar picker with optional text input, date constraints, and day-of-week restrictions.
+ * @publicDocs
  */
 export interface DateFieldProps
   extends Omit<
@@ -390,6 +400,7 @@ declare module 'preact' {
 declare const tagName = 's-date-field';
 /**
  * The JSX props for the date field component. These properties extend `DateFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact, including specialized callbacks for view changes and invalid date attempts.
+ * @publicDocs
  */
 export interface DateFieldJSXProps
   extends Partial<Omit<DateFieldProps, 'value' | 'defaultValue'>>,
@@ -421,4 +432,7 @@ export interface DateFieldJSXProps
 }
 
 export {DateField};
+/**
+ * @publicDocs
+ */
 export type {DateFieldJSXProps};

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

@@ -10,6 +10,7 @@ import type {DatePickerProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the date picker component. These properties configure a standalone calendar interface for selecting single dates or date ranges, with support for date constraints, day-of-week restrictions, and month/year navigation.
+ * @publicDocs
  */
 export interface DatePickerProps
   extends Required<
@@ -39,6 +40,7 @@ export interface DatePickerProps
 
 /**
  * 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 & {
   /**
@@ -48,6 +50,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 & {
@@ -61,6 +64,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;
   /**
@@ -75,10 +79,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'> & {
   /**
@@ -92,6 +98,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 {
   /**
@@ -113,6 +120,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for programmatically triggering a click event on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -271,6 +279,7 @@ declare module 'preact' {
 declare const tagName = 's-date-picker';
 /**
  * The JSX props for the date picker component. These properties extend `DatePickerProps` with JSX-specific event callbacks for React-style event handling when used in Preact, including callbacks for date selection, focus events, and view changes.
+ * @publicDocs
  */
 export interface DatePickerJSXProps
   extends Partial<DatePickerProps>,
@@ -298,4 +307,7 @@ export interface DatePickerJSXProps
 }
 
 export {DatePicker};
+/**
+ * @publicDocs
+ */
 export type {DatePickerJSXProps};

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

@@ -10,6 +10,7 @@ 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.
+ * @publicDocs
  */
 export interface DividerProps
   extends Pick<DividerProps$1, 'direction' | 'color'> {
@@ -35,10 +36,12 @@ export interface DividerProps
 
 /**
  * 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 +55,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 +77,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -128,6 +133,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> {
   /**
@@ -184,10 +190,14 @@ declare module 'preact' {
 declare const tagName = 's-divider';
 /**
  * The properties for the divider component when it's used in JSX.
+ * @publicDocs
  */
 export interface DividerJSXProps
   extends Partial<DividerProps>,
     Pick<DividerProps$1, 'id'> {}
 
 export {Divider};
+/**
+ * @publicDocs
+ */
 export type {DividerJSXProps};

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

@@ -13,9 +13,15 @@ import type {
   RenderImpl,
 } from './shared.d.ts';
 
+/**
+ * @publicDocs
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * @publicDocs
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
@@ -36,6 +42,9 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * @publicDocs
+ */
 export interface DropZoneProps
   extends Required<
     Pick<
@@ -58,6 +67,9 @@ declare class PolarisCustomElement extends PreactCustomElement {
   constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
 }
 
+/**
+ * @publicDocs
+ */
 export type ReplaceType<TType, TFrom, TTo> = Exclude<TType, TFrom> | TTo;
 
 declare const setFiles: unique symbol;
@@ -117,6 +129,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-drop-zone';
+/**
+ * @publicDocs
+ */
 export interface DropZoneJSXProps
   extends Partial<DropZoneProps>,
     Pick<DropZoneProps$1, 'id'> {
@@ -130,4 +145,7 @@ export interface DropZoneJSXProps
 }
 
 export {DropZone};
+/**
+ * @publicDocs
+ */
 export type {DropZoneJSXProps};

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

@@ -14,6 +14,7 @@ import type {
 
 /**
  * An event with a strongly-typed currentTarget property for a specific HTML element.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -23,6 +24,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * A callback function that receives a strongly-typed event for a specific HTML element.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -31,6 +33,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /**
  * The React-style event callback props for form field components.
+ * @publicDocs
  */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
   /**
@@ -52,6 +55,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> {
   /**
@@ -70,10 +74,12 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * A string containing CSS styles for the component's shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The configuration for rendering a Preact component in a shadow root.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -87,6 +93,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties from an event that indicate how the user activated an element.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -108,6 +115,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for influencing a programmatic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -161,6 +169,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 declare const internals: unique symbol;
 /**
  * The base properties for an input element that participates in form submission.
+ * @publicDocs
  */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
@@ -205,6 +214,7 @@ declare class PreactInputElement
 
 /**
  * The base properties for form field elements that support labels, validation, and autocomplete.
+ * @publicDocs
  */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
@@ -325,6 +335,7 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * 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.
+ * @publicDocs
  */
 export type EmailFieldProps = PreactFieldProps<
   Required<EmailFieldProps$1>['autocomplete']
@@ -375,6 +386,7 @@ 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.
+ * @publicDocs
  */
 export interface EmailFieldJSXProps
   extends Partial<Omit<EmailFieldProps, 'accessory'>>,
@@ -382,4 +394,7 @@ export interface EmailFieldJSXProps
     FieldReactProps<typeof tagName> {}
 
 export {EmailField};
+/**
+ * @publicDocs
+ */
 export type {EmailFieldJSXProps};

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

@@ -13,6 +13,7 @@ import type {
 
 /**
  * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements.
+ * @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 type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -32,6 +34,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
 
 /**
  * A callback event that includes the `waitUntil` method for extending asynchronous operations. This allows you to delay form submission until promises resolve, enabling async validation or data processing before the form completes its action.
+ * @publicDocs
  */
 export interface CallbackExtendableEvent<
   TTagName extends keyof HTMLElementTagNameMap,
@@ -40,6 +43,7 @@ export interface CallbackExtendableEvent<
 
 /**
  * An event listener function type for extendable callback events. This combines strong typing with the ability to extend the event lifecycle using `waitUntil`.
+ * @publicDocs
  */
 export type CallbackExtendableEventListener<
   TTagName extends keyof HTMLElementTagNameMap,
@@ -51,6 +55,7 @@ export type CallbackExtendableEventListener<
 
 /**
  * The properties for the form component. These properties configure the form's identifier for targeting and referencing within the admin extension.
+ * @publicDocs
  */
 export interface FormProps extends Pick<FormProps$1, 'id'> {}
 
@@ -58,6 +63,7 @@ declare const tagName = 's-form';
 
 /**
  * The JSX props for the form component. These properties extend `FormProps` with event callbacks for form submission and reset actions in JSX rendering.
+ * @publicDocs
  */
 export interface FormJSXProps extends Partial<FormProps> {
   /**
@@ -72,10 +78,12 @@ export interface FormJSXProps extends Partial<FormProps> {
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -89,6 +97,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -110,6 +119,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -192,4 +202,7 @@ declare module 'preact' {
 }
 
 export {Form};
+/**
+ * @publicDocs
+ */
 export type {FormJSXProps};

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

@@ -13,6 +13,7 @@ import type {
 
 /**
  * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements.
+ * @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 type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -32,6 +34,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
 
 /**
  * An event listener function type for error events that includes an `error` property. This is used for handling validation errors and submission failures in forms.
+ * @publicDocs
  */
 export type CallbackErrorEventListener<
   TTagName extends keyof HTMLElementTagNameMap,
@@ -51,6 +54,7 @@ export type CallbackErrorEventListener<
 
 /**
  * A callback event that includes the `waitUntil` method for extending asynchronous operations. This allows you to delay event completion until promises resolve, enabling async operations during event handling.
+ * @publicDocs
  */
 export interface CallbackExtendableEvent<
   TTagName extends keyof HTMLElementTagNameMap,
@@ -59,6 +63,7 @@ export interface CallbackExtendableEvent<
 
 /**
  * An event listener function type for extendable callback events. This combines strong typing with the ability to extend the event lifecycle using `waitUntil`.
+ * @publicDocs
  */
 export type CallbackExtendableEventListener<
   TTagName extends keyof HTMLElementTagNameMap,
@@ -70,6 +75,7 @@ export type CallbackExtendableEventListener<
 
 /**
  * The properties for the function settings component. These properties configure the form's identifier for configuring Shopify Function settings in the admin interface.
+ * @publicDocs
  */
 export interface FunctionSettingsProps
   extends Pick<FunctionSettingsProps$1, 'id'> {}
@@ -78,6 +84,7 @@ declare const tagName = 's-function-settings';
 
 /**
  * The JSX props for the function settings component. These properties extend `FunctionSettingsProps` with event callbacks for form submission, reset, and error handling in JSX rendering.
+ * @publicDocs
  */
 export interface FunctionSettingsJSXProps
   extends Partial<
@@ -100,10 +107,12 @@ export interface FunctionSettingsJSXProps
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -117,6 +126,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -138,6 +148,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -190,6 +201,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The error event type that's passed to the `onError` callback of function settings. This event contains validation errors that occurred when committing function settings to Shopify's servers.
+ * @publicDocs
  */
 export type FunctionSettingsErrorEvent = Parameters<
   NonNullable<FunctionSettingsProps$1['onError']>
@@ -250,4 +262,7 @@ declare module 'preact' {
 }
 
 export {FunctionSettings};
+/**
+ * @publicDocs
+ */
 export type {FunctionSettingsJSXProps};