@shopify/ui-extensions 2026.1.3 → 2026.1.4

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

@@ -14,6 +14,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 & {
   /**
@@ -23,6 +24,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 & {
@@ -33,6 +35,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;
   /**
@@ -47,10 +50,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'> & {
   /**
@@ -64,6 +69,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -85,6 +91,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -138,6 +145,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'>
@@ -185,6 +193,7 @@ declare class PreactInputElement
 
 /**
  * Properties that are common to checkbox-style components.
+ * @publicDocs
  */
 export interface PreactCheckboxProps
   extends Required<
@@ -255,6 +264,7 @@ declare class PreactCheckboxElement
 
 /**
  * Properties for rendering a checkbox that supports checked, unchecked, and indeterminate states for complex selection scenarios.
+ * @publicDocs
  */
 export interface CheckboxProps extends PreactCheckboxProps {
   /**
@@ -298,6 +308,7 @@ declare module 'preact' {
 declare const tagName = 's-checkbox';
 /**
  * Props for using the checkbox component in JSX with React-style event handlers.
+ * @publicDocs
  */
 export interface CheckboxJSXProps
   extends Partial<CheckboxProps>,
@@ -313,4 +324,7 @@ export interface CheckboxJSXProps
 }
 
 export {Checkbox};
+/**
+ * @publicDocs
+ */
 export type {CheckboxJSXProps};

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

@@ -13,6 +13,9 @@ import type {
   RenderImpl,
 } from './shared.d.ts';
 
+/**
+ * @publicDocs
+ */
 export interface ChipProps
   extends Required<Pick<ChipProps$1, 'color' | 'accessibilityLabel'>> {}
 
@@ -55,6 +58,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-chip';
+/**
+ * @publicDocs
+ */
 export interface ChipJSXProps
   extends Partial<ChipProps>,
     Pick<ChipProps$1, 'id' | 'children'> {
@@ -69,4 +75,7 @@ export interface ChipJSXProps
 }
 
 export {Chip};
+/**
+ * @publicDocs
+ */
 export type {ChipJSXProps};

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, ChoiceProps$1} from './shared.d.ts';
 
 /**
  * Properties for rendering a single choice within a choice list that can be selected using a radio button or checkbox.
+ * @publicDocs
  */
 export interface ChoiceProps
   extends Required<
@@ -25,10 +26,12 @@ export interface ChoiceProps
 
 /**
  * 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'> & {
   /**
@@ -42,6 +45,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -63,6 +67,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -117,6 +122,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 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;
   /**
@@ -136,6 +142,7 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * A single choice within a choice list that can be selected with a radio button or checkbox.
+ * @publicDocs
  */
 declare class Choice extends PreactCustomElement implements ChoiceProps {
   /**
@@ -182,6 +189,7 @@ declare module 'preact' {
 declare const tagName = 's-choice';
 /**
  * Properties for using the choice component in JSX with React-style props.
+ * @publicDocs
  */
 export interface ChoiceJSXProps
   extends Partial<ChoiceProps>,
@@ -203,4 +211,7 @@ export interface ChoiceJSXProps
 }
 
 export {Choice};
+/**
+ * @publicDocs
+ */
 export type {ChoiceJSXProps};

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, ChoiceListProps$1} 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 & {
@@ -29,6 +31,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;
   /**
@@ -48,6 +51,8 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * Properties for rendering a list of choices that lets users select one or more options using radio buttons or checkboxes.
+ *
+ * @publicDocs
  */
 export interface ChoiceListProps
   extends Required<
@@ -66,10 +71,12 @@ export interface ChoiceListProps
 
 /**
  * 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'> & {
   /**
@@ -83,6 +90,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -104,6 +112,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -237,6 +246,7 @@ declare module 'preact' {
 declare const tagName = 's-choice-list';
 /**
  * Properties for using the choice list component in JSX with React-style event handlers.
+ * @publicDocs
  */
 export interface ChoiceListJSXProps
   extends Partial<ChoiceListProps>,
@@ -258,4 +268,7 @@ export interface ChoiceListJSXProps
 }
 
 export {ChoiceList};
+/**
+ * @publicDocs
+ */
 export type {ChoiceListJSXProps};

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

@@ -17,9 +17,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;
@@ -27,6 +33,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> {
   /**
@@ -44,12 +51,16 @@ 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 MakeResponsive<T> = T | `@container${string}`;
 /**
  * Makes a property's value potentially responsive.
@@ -66,12 +77,19 @@ 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]>;
 };
 
+/**
+ * @publicDocs
+ */
 export type RequiredBoxProps = Required<BoxProps$1>;
+/**
+ * @publicDocs
+ */
 export type BoxBorderRadii = Extract<
   RequiredBoxProps['borderRadius'],
   | 'none'
@@ -83,10 +101,16 @@ export type BoxBorderRadii = Extract<
   | 'large-100'
   | 'large-200'
 >;
+/**
+ * @publicDocs
+ */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
   'none' | 'solid' | 'dashed' | 'auto'
 >;
+/**
+ * @publicDocs
+ */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
   | 'padding'
@@ -98,6 +122,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * @publicDocs
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -318,6 +345,9 @@ export interface BoxProps
   maxInlineSize: SizeUnitsOrNone;
 }
 
+/**
+ * @publicDocs
+ */
 export type ClickableBaseProps = Required<
   Pick<
     ClickableProps$1,
@@ -336,22 +366,35 @@ export type ClickableBaseProps = Required<
 >;
 /**
  * The properties for the clickable component. These properties define a low-level interactive container element that responds to user clicks while inheriting all box styling capabilities. The component serves as a foundation for building custom interactive components.
+ * @publicDocs
  */
 export interface ClickableProps
   extends Required<BoxProps>,
     ClickableBaseProps {}
 
+/**
+ * @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.
@@ -401,6 +444,9 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * @publicDocs
+ */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
   /**
@@ -488,6 +534,7 @@ declare module 'preact' {
 declare const tagName = 's-clickable';
 /**
  * The JSX properties for the clickable component. These properties define how a clickable container is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface ClickableJSXProps
   extends Partial<ClickableProps>,
@@ -567,4 +614,7 @@ export interface ClickableJSXProps
 }
 
 export {Clickable};
+/**
+ * @publicDocs
+ */
 export type {ClickableJSXProps};

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

@@ -14,6 +14,7 @@ import type {
 
 /**
  * A callback event that's typed to 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 & {
 };
 /**
  * An event listener for callback events, typed to 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 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> {
 }
 /**
  * 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> {
@@ -59,6 +63,7 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * The properties for the clickable chip component. These properties define an interactive chip that can be clicked or removed.
+ * @publicDocs
  */
 export interface ClickableChipProps
   extends Required<
@@ -78,10 +83,12 @@ export interface ClickableChipProps
 
 /**
  * A string containing CSS styles for the component.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation details for rendering a custom element with Preact.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -95,6 +102,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * An event-like object that contains activation information for synthetic clicks.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -116,6 +124,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for customizing synthetic click behavior.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -168,6 +177,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * Props for controlling overlay components like popovers and dialogs.
+ * @publicDocs
  */
 export interface PreactOverlayControlProps
   extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
@@ -261,6 +271,7 @@ declare module 'preact' {
 declare const tagName = 's-clickable-chip';
 /**
  * The JSX properties for the clickable chip component. These properties define how a clickable chip is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface ClickableChipJSXProps
   extends Partial<ClickableChipProps>,
@@ -288,4 +299,7 @@ export interface ClickableChipJSXProps
 }
 
 export {ClickableChip};
+/**
+ * @publicDocs
+ */
 export type {ClickableChipJSXProps};

package/build/ts/surfaces/admin/components/ColorField.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 color field component. These properties configure an input field that allows merchants to select colors using an integrated visual color picker with text input, hex color format, and optional alpha (transparency) channel support.
+ * @publicDocs
  */
 export type ColorFieldProps = Omit<
   PreactFieldProps<Required<ColorFieldProps$1>['autocomplete']>,
@@ -377,6 +388,7 @@ declare module 'preact' {
 declare const tagName = 's-color-field';
 /**
  * The JSX props for the color field component. These properties extend `ColorFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact, including callbacks for color changes as the merchant interacts with the picker.
+ * @publicDocs
  */
 export interface ColorFieldJSXProps
   extends Partial<
@@ -396,4 +408,7 @@ export interface ColorFieldJSXProps
 }
 
 export {ColorField};
+/**
+ * @publicDocs
+ */
 export type {ColorFieldJSXProps};

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};