@shopify/ui-extensions 2026.1.3 → 2026.1.4

package/src/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/src/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/src/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};

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

@@ -21,6 +21,7 @@ import type {
 
 /**
  * A type that allows a value to be responsive using container query syntax.
+ * @publicDocs
  */
 export type MakeResponsive<T> = T | `@container${string}`;
 /**
@@ -38,6 +39,7 @@ export type MakeResponsive<T> = T | `@container${string}`;
  *   margin: string | `@container${string}`;
  *   padding: number | `@container${string}`;
  * }
+ * @publicDocs
  */
 export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
   [P in TProperty]: MakeResponsive<TType[P]>;
@@ -45,10 +47,12 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
 
 /**
  * A version of the box properties with all fields required.
+ * @publicDocs
  */
 export type RequiredBoxProps = Required<BoxProps$1>;
 /**
  * The allowed border radius values for a box component.
+ * @publicDocs
  */
 export type BoxBorderRadii = Extract<
   RequiredBoxProps['borderRadius'],
@@ -63,6 +67,7 @@ export type BoxBorderRadii = Extract<
 >;
 /**
  * The allowed border style values for a box component.
+ * @publicDocs
  */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
@@ -70,6 +75,7 @@ export type BoxBorderStyles = Extract<
 >;
 /**
  * The box properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
@@ -82,6 +88,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * @publicDocs
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -298,10 +307,12 @@ export interface BoxProps
 
 /**
  * A version of the grid properties with all fields required.
+ * @publicDocs
  */
 export type RequiredAlignedProps = Required<GridProps$1>;
 /**
  * The grid properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveGridProps = MakeResponsivePick<
   RequiredAlignedProps,
@@ -309,6 +320,7 @@ export type ResponsiveGridProps = MakeResponsivePick<
 >;
 /**
  * The properties for the grid component. A grid provides precise control over rows and columns, with powerful alignment and sizing options for both individual items and the entire grid structure.
+ * @publicDocs
  */
 export interface GridProps
   extends BoxProps,
@@ -395,6 +407,7 @@ export interface GridProps
 
 /**
  * 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> {
   /**
@@ -412,6 +425,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> {
@@ -420,10 +434,12 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * 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'> & {
   /**
@@ -437,6 +453,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 {
   /**
@@ -458,6 +475,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -688,6 +706,7 @@ declare module 'preact' {
 declare const tagName = 's-grid';
 /**
  * The properties for the grid component when it's used in JSX.
+ * @publicDocs
  */
 export interface GridJSXProps
   extends Partial<GridProps>,
@@ -699,4 +718,7 @@ export interface GridJSXProps
 }
 
 export {Grid};
+/**
+ * @publicDocs
+ */
 export type {GridJSXProps};

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

@@ -18,6 +18,7 @@ import type {
 
 /**
  * A type that allows a value to be responsive using container query syntax.
+ * @publicDocs
  */
 export type MakeResponsive<T> = T | `@container${string}`;
 /**
@@ -35,6 +36,7 @@ export type MakeResponsive<T> = T | `@container${string}`;
  *   margin: string | `@container${string}`;
  *   padding: number | `@container${string}`;
  * }
+ * @publicDocs
  */
 export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
   [P in TProperty]: MakeResponsive<TType[P]>;
@@ -42,10 +44,12 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
 
 /**
  * A version of the box properties with all fields required.
+ * @publicDocs
  */
 export type RequiredBoxProps = Required<BoxProps$1>;
 /**
  * The allowed border radius values for a box component.
+ * @publicDocs
  */
 export type BoxBorderRadii = Extract<
   RequiredBoxProps['borderRadius'],
@@ -60,6 +64,7 @@ export type BoxBorderRadii = Extract<
 >;
 /**
  * The allowed border style values for a box component.
+ * @publicDocs
  */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
@@ -67,6 +72,7 @@ export type BoxBorderStyles = Extract<
 >;
 /**
  * The box properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
@@ -79,6 +85,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * @publicDocs
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -293,10 +302,12 @@ export interface BoxProps
 
 /**
  * A version of the grid item properties with all fields required.
+ * @publicDocs
  */
 export type RequiredGridItemProps = Required<GridItemProps$1>;
 /**
  * The properties for the grid item component. A grid item can be positioned within specific rows and columns of a grid, with control over how many rows or columns it spans.
+ * @publicDocs
  */
 export interface GridItemProps
   extends BoxProps,
@@ -313,10 +324,12 @@ export interface GridItemProps
 
 /**
  * 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'> & {
   /**
@@ -330,6 +343,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 {
   /**
@@ -351,6 +365,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -517,6 +532,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
 
 /**
  * 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> {
   /**
@@ -534,6 +550,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> {
@@ -571,6 +588,7 @@ declare module 'preact' {
 declare const tagName = 's-grid-item';
 /**
  * The properties for the grid item component when it's used in JSX.
+ * @publicDocs
  */
 export interface GridItemJSXProps
   extends Partial<GridItemProps>,
@@ -582,4 +600,7 @@ export interface GridItemJSXProps
 }
 
 export {GridItem};
+/**
+ * @publicDocs
+ */
 export type {GridItemJSXProps};

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, HeadingProps$1} from './shared.d.ts';
 
 /**
  * The properties for the heading component. These properties define hierarchical section titles and headings with appropriate semantic meaning and visual hierarchy.
+ * @publicDocs
  */
 export interface HeadingProps
   extends Required<
@@ -21,10 +22,12 @@ export interface HeadingProps
 
 /**
  * A string containing CSS styles.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The configuration for rendering a custom element with a shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -39,6 +42,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 /**
  * An object that represents the state of modifier keys and mouse button
  * during an activation event like a click.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -60,6 +64,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for customizing click behavior on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -112,6 +117,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> {
   /**
@@ -129,6 +135,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> {
@@ -169,6 +176,7 @@ declare module 'preact' {
 declare const tagName = 's-heading';
 /**
  * The JSX properties for the heading component. These properties define how a heading is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface HeadingJSXProps
   extends Partial<HeadingProps>,
@@ -180,4 +188,7 @@ export interface HeadingJSXProps
 }
 
 export {Heading};
+/**
+ * @publicDocs
+ */
 export type {HeadingJSXProps};

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

@@ -8,9 +8,6 @@
 /// <reference lib="DOM" />
 import type {IconProps$1, IconType, ComponentChildren} from './shared.d.ts';
 
-/**
- * The properties for the icon component. An icon displays a graphical symbol with configurable appearance, color, and semantic meaning.
- */
 export interface IconProps
   extends Pick<
     IconProps$1,