@shopify/ui-extensions 2026.1.3 → 2026.1.4

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

@@ -18,6 +18,7 @@ import type {
 
 /**
  * A callback event that's typed to a specific HTML element. This type provides access to the element that triggered the event.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -27,6 +28,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * An event listener for callback events, typed to a specific HTML element.
+ * @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,6 +56,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * Makes a type value responsive by allowing container query strings.
+ * @publicDocs
  */
 export type MakeResponsive<T> = T | `@container${string}`;
 /**
@@ -70,6 +74,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]>;
@@ -77,10 +82,12 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
 
 /**
  * The box properties with all fields marked as required.
+ * @publicDocs
  */
 export type RequiredBoxProps = Required<BoxProps$1>;
 /**
  * The available border radius values for Box components.
+ * @publicDocs
  */
 export type BoxBorderRadii = Extract<
   RequiredBoxProps['borderRadius'],
@@ -95,6 +102,7 @@ export type BoxBorderRadii = Extract<
 >;
 /**
  * The available border style values for Box components.
+ * @publicDocs
  */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
@@ -102,6 +110,7 @@ export type BoxBorderStyles = Extract<
 >;
 /**
  * The box properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
@@ -114,6 +123,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * @publicDocs
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -328,6 +340,7 @@ export interface BoxProps
 
 /**
  * The properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders. Properties include `src` for the image URL, `alt` for accessibility text, `aspectRatio` for sizing, `loading` for lazy loading, and border styling options.
+ * @publicDocs
  */
 export interface ImageProps
   extends Required<
@@ -414,10 +427,12 @@ export interface ImageProps
 
 /**
  * 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'> & {
   /**
@@ -431,6 +446,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -452,6 +468,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -591,6 +608,7 @@ declare module 'preact' {
 declare const tagName = 's-image';
 /**
  * The properties for the image component when it's used in JSX.
+ * @publicDocs
  */
 export interface ImageJSXProps
   extends Partial<ImageProps>,
@@ -606,4 +624,7 @@ export interface ImageJSXProps
 }
 
 export {Image};
+/**
+ * @publicDocs
+ */
 export type {ImageJSXProps};

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

@@ -12,9 +12,15 @@ import type {
   InteractionProps,
 } 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;
@@ -22,6 +28,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> {
   /**
@@ -39,13 +46,20 @@ 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> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * @publicDocs
+ */
 export type RequiredLinkProps = Required<LinkProps$1>;
+/**
+ * @publicDocs
+ */
 export type LinkBaseProps = Required<
   Pick<
     LinkProps$1,
@@ -62,6 +76,7 @@ export type LinkBaseProps = Required<
 >;
 /**
  * The properties for the link component. These properties define a clickable link that navigates users to different pages or sections with customizable visual styles and semantic meaning.
+ * @publicDocs
  */
 export interface LinkProps extends LinkBaseProps {
   /**
@@ -75,17 +90,29 @@ export interface LinkProps extends LinkBaseProps {
   tone: Extract<RequiredLinkProps['tone'], 'auto' | 'neutral' | 'critical'>;
 }
 
+/**
+ * @publicDocs
+ */
 export type Styles = string;
+/**
+ * @publicDocs
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   ShadowRoot: (element: any) => ComponentChildren;
   styles?: Styles;
 };
+/**
+ * @publicDocs
+ */
 export interface ActivationEventEsque {
   shiftKey: boolean;
   metaKey: boolean;
   ctrlKey: boolean;
   button: number;
 }
+/**
+ * @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.
@@ -135,6 +162,9 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * @publicDocs
+ */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
   /**
@@ -191,6 +221,7 @@ declare module 'preact' {
 declare const tagName = 's-link';
 /**
  * The JSX properties for the link component. These properties define how a link is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface LinkJSXProps
   extends Partial<LinkProps>,
@@ -241,4 +272,7 @@ export interface LinkJSXProps
 }
 
 export {Link};
+/**
+ * @publicDocs
+ */
 export type {LinkJSXProps};

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

@@ -9,15 +9,18 @@ import type {ComponentChildren, ListItemProps$1} from './shared.d.ts';
 
 /**
  * The properties that you can set on a list item component.
+ * @publicDocs
  */
 export interface ListItemProps extends ListItemProps$1 {}
 
 /**
  * A string that contains 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'> & {
   /**
@@ -32,6 +35,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 {
   /**
@@ -53,6 +57,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -105,6 +110,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> {
   /**
@@ -122,6 +128,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> {
@@ -153,6 +160,7 @@ declare module 'preact' {
 declare const tagName = 's-list-item';
 /**
  * The JSX properties you can set on a list item component.
+ * @publicDocs
  */
 export interface ListItemJSXProps
   extends Partial<ListItemProps>,
@@ -164,4 +172,7 @@ export interface ListItemJSXProps
 }
 
 export {ListItem};
+/**
+ * @publicDocs
+ */
 export type {ListItemJSXProps};

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

@@ -14,12 +14,14 @@ import type {
 
 /**
  * The properties you can set on a menu component.
+ * @publicDocs
  */
 export interface MenuProps
   extends Required<Pick<MenuProps$1, 'id' | 'accessibilityLabel'>> {}
 
 /**
  * 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> {
   /**
@@ -37,6 +39,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> {
@@ -45,10 +48,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'> & {
   /**
@@ -62,6 +67,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 {
   /**
@@ -83,6 +89,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -135,6 +142,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The properties for controlling overlay elements like popovers, tooltips, and menus through command interactions.
+ * @publicDocs
  */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
@@ -177,6 +185,7 @@ declare const overlayActivator: unique symbol;
 declare const overlayHideFrameId: unique symbol;
 /**
  * The initialization object for creating a polyfill command event.
+ * @publicDocs
  */
 export type PolyfillCommandEventInit = EventInit & {
   /**
@@ -190,6 +199,7 @@ export type PolyfillCommandEventInit = EventInit & {
 };
 /**
  * A polyfill event for the command interaction pattern, which is used to control overlay elements.
+ * @publicDocs
  */
 export type PolyfillCommandEvent = Event & {
   /**
@@ -261,6 +271,7 @@ declare module 'preact' {
 declare const tagName = 's-menu';
 /**
  * The JSX properties you can set on a menu component.
+ * @publicDocs
  */
 export interface MenuJSXProps
   extends Partial<MenuProps>,
@@ -272,4 +283,7 @@ export interface MenuJSXProps
 }
 
 export {Menu};
+/**
+ * @publicDocs
+ */
 export type {MenuJSXProps};

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

@@ -14,9 +14,15 @@ import type {
   InteractionProps,
 } 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;
@@ -37,7 +43,13 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * @publicDocs
+ */
 export type RequiredAlignedModalProps = Required<ModalProps$1>;
+/**
+ * @publicDocs
+ */
 export interface ModalProps
   extends Pick<
     RequiredAlignedModalProps,
@@ -62,6 +74,9 @@ declare class PolarisCustomElement extends PreactCustomElement {
   constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
 }
 
+/**
+ * @publicDocs
+ */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
   /**
@@ -104,11 +119,17 @@ declare const overlayHidden: unique symbol;
  */
 declare const overlayActivator: unique symbol;
 declare const overlayHideFrameId: unique symbol;
+/**
+ * @publicDocs
+ */
 export type PolyfillCommandEventInit = EventInit & {
   source: HTMLElement | null | undefined;
   command: PreactOverlayControlProps['command'];
   rootActivator?: HTMLElement | null;
 };
+/**
+ * @publicDocs
+ */
 export type PolyfillCommandEvent = Event & {
   source: PolyfillCommandEventInit['source'];
   command: PolyfillCommandEventInit['command'];
@@ -220,6 +241,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-modal';
+/**
+ * @publicDocs
+ */
 export interface ModalJSXProps
   extends Partial<ModalProps>,
     Pick<ModalProps$1, 'id' | 'children'> {
@@ -246,4 +270,7 @@ export interface ModalJSXProps
 }
 
 export {Modal};
+/**
+ * @publicDocs
+ */
 export type {ModalJSXProps};

package/src/surfaces/admin/components/MoneyField.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,10 +335,12 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The required properties from the `MoneyFieldProps$1` definition. This type ensures all properties from the shared definition are marked as required.
+ * @publicDocs
  */
 export type RequiredMoneyFieldProps = Required<MoneyFieldProps$1>;
 /**
  * The properties for the money field component. These properties configure a specialized input field for entering monetary amounts with automatic currency formatting, decimal handling, and range validation.
+ * @publicDocs
  */
 export interface MoneyFieldProps
   extends Omit<PreactFieldProps, 'value'>,
@@ -377,6 +389,7 @@ declare module 'preact' {
 declare const tagName = 's-money-field';
 /**
  * The JSX props for the money field component. These properties extend `MoneyFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ * @publicDocs
  */
 export interface MoneyFieldJSXProps
   extends Partial<MoneyFieldProps>,
@@ -384,4 +397,7 @@ export interface MoneyFieldJSXProps
     Pick<MoneyFieldProps$1, 'id'> {}
 
 export {MoneyField};
+/**
+ * @publicDocs
+ */
 export type {MoneyFieldJSXProps};

package/src/surfaces/admin/components/NumberField.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 number field component. These properties configure a specialized input field for entering numeric values with support for validation, formatting, range constraints, and optimized mobile input modes.
+ * @publicDocs
  */
 export interface NumberFieldProps
   extends Omit<
@@ -400,6 +411,7 @@ declare module 'preact' {
 declare const tagName = 's-number-field';
 /**
  * The JSX props for the number field component. These properties extend `NumberFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ * @publicDocs
  */
 export interface NumberFieldJSXProps
   extends Partial<NumberFieldProps>,
@@ -407,4 +419,7 @@ export interface NumberFieldJSXProps
     FieldReactProps<typeof tagName> {}
 
 export {NumberField};
+/**
+ * @publicDocs
+ */
 export type {NumberFieldJSXProps};