@shopify/ui-extensions 2026.1.3 → 2026.1.4

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

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

@@ -20,6 +20,7 @@ import type {
 
 /**
  * A type that allows a value to be responsive using container query syntax.
+ * @publicDocs
  */
 export type MakeResponsive<T> = T | `@container${string}`;
 /**
@@ -37,6 +38,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]>;
@@ -44,10 +46,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'],
@@ -62,6 +66,7 @@ export type BoxBorderRadii = Extract<
 >;
 /**
  * The allowed border style values for a box component.
+ * @publicDocs
  */
 export type BoxBorderStyles = Extract<
   RequiredBoxProps['borderStyle'],
@@ -69,6 +74,7 @@ export type BoxBorderStyles = Extract<
 >;
 /**
  * The box properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveBoxProps = MakeResponsivePick<
   RequiredBoxProps,
@@ -81,6 +87,9 @@ export type ResponsiveBoxProps = MakeResponsivePick<
   | 'paddingInlineEnd'
   | 'display'
 >;
+/**
+ * @publicDocs
+ */
 export interface BoxProps
   extends Pick<
     RequiredBoxProps,
@@ -297,10 +306,12 @@ export interface BoxProps
 
 /**
  * A version of the stack properties with all fields required.
+ * @publicDocs
  */
 export type AlignedStackProps = Required<StackProps$1>;
 /**
  * The stack properties that support responsive values through container queries.
+ * @publicDocs
  */
 export type ResponsiveStackProps = MakeResponsivePick<
   AlignedStackProps,
@@ -308,6 +319,7 @@ export type ResponsiveStackProps = MakeResponsivePick<
 >;
 /**
  * The properties for the stack component. A stack arranges its children in a single direction with controlled spacing and alignment along both axes.
+ * @publicDocs
  */
 export interface StackProps
   extends BoxProps,
@@ -369,10 +381,12 @@ export interface StackProps
 
 /**
  * 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'> & {
   /**
@@ -386,6 +400,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 {
   /**
@@ -407,6 +422,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -573,6 +589,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> {
   /**
@@ -590,6 +607,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> {
@@ -646,6 +664,7 @@ declare module 'preact' {
 declare const tagName = 's-stack';
 /**
  * The properties for the stack component when it's used in JSX.
+ * @publicDocs
  */
 export interface StackJSXProps
   extends Partial<StackProps>,
@@ -657,4 +676,7 @@ export interface StackJSXProps
 }
 
 export {Stack};
+/**
+ * @publicDocs
+ */
 export type {StackJSXProps};

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

@@ -15,6 +15,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 & {
   /**
@@ -24,6 +25,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 & {
@@ -34,6 +36,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,10 +51,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'> & {
   /**
@@ -65,6 +70,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -86,6 +92,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -139,6 +146,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'>
@@ -186,6 +194,7 @@ declare class PreactInputElement
 
 /**
  * Properties that are common to checkbox-style components.
+ * @publicDocs
  */
 export interface PreactCheckboxProps
   extends Required<
@@ -256,6 +265,7 @@ declare class PreactCheckboxElement
 
 /**
  * Properties for rendering a switch that lets users toggle a setting on or off with a sliding control interface.
+ * @publicDocs
  */
 export interface SwitchProps
   extends PreactCheckboxProps,
@@ -287,6 +297,7 @@ declare module 'preact' {
 declare const tagName = 's-switch';
 /**
  * Properties for using the switch component in JSX with React-style event handlers.
+ * @publicDocs
  */
 export interface SwitchJSXProps
   extends Partial<SwitchProps>,
@@ -302,4 +313,7 @@ export interface SwitchJSXProps
 }
 
 export {Switch};
+/**
+ * @publicDocs
+ */
 export type {SwitchJSXProps};

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

@@ -14,6 +14,7 @@ import type {
 
 /**
  * The properties you can set on a table component.
+ * @publicDocs
  */
 export interface TableProps
   extends Required<
@@ -30,6 +31,7 @@ export interface TableProps
 
 /**
  * The format type for a table header, which determines how the cell content is displayed.
+ * @publicDocs
  */
 export type HeaderFormat = Extract<
   TableHeaderProps$1['format'],
@@ -37,6 +39,7 @@ export type HeaderFormat = Extract<
 >;
 /**
  * The properties you can set on a table header component.
+ * @publicDocs
  */
 export interface TableHeaderProps
   extends Pick<TableHeaderProps$1, 'listSlot' | 'format'> {
@@ -55,10 +58,12 @@ export interface TableHeaderProps
 
 /**
  * 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'> & {
   /**
@@ -72,6 +77,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 {
   /**
@@ -93,6 +99,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -145,6 +152,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * A context object that provides a default value of a specific type.
+ * @publicDocs
  */
 export interface Context<T> {
   /**
@@ -173,6 +181,7 @@ declare class AddedContext<T> extends EventTarget {
 /**
  * A callback that a context requester provides, which is called with the value that satisfies the request.
  * Context providers can call this callback multiple times as the requested value changes.
+ * @publicDocs
  */
 export type ContextCallback<T> = (value: T) => void;
 /**
@@ -210,11 +219,13 @@ declare const actualTableVariantSymbol: unique symbol;
 declare const tableHeadersSharedDataSymbol: unique symbol;
 /**
  * The actual display variant of the table, which is either a traditional table or a list.
+ * @publicDocs
  */
 export type ActualTableVariant = 'table' | 'list';
 
 /**
  * An event that includes a strongly typed `currentTarget` property based on the element tag name.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -224,6 +235,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * An event listener function that receives a strongly typed callback event, or `null` if no listener is attached.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -232,6 +244,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> {
   /**
@@ -249,6 +262,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> {
@@ -326,6 +340,7 @@ declare module 'preact' {
 declare const tagName = 's-table';
 /**
  * The JSX properties you can set on a table component.
+ * @publicDocs
  */
 export interface TableJSXProps
   extends Partial<TableProps>,
@@ -341,4 +356,7 @@ export interface TableJSXProps
 }
 
 export {Table};
+/**
+ * @publicDocs
+ */
 export type {TableJSXProps};