@shopify/ui-extensions 2026.1.3 → 2026.1.5

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

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, OptionProps$1} from './shared.d.ts';
 
 /**
  * Properties for rendering a single option within a select dropdown that users can choose from.
+ * @publicDocs
  */
 export interface OptionProps
   extends Required<
@@ -18,10 +19,12 @@ export interface OptionProps
 
 /**
  * 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'> & {
   /**
@@ -35,6 +38,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -56,6 +60,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -110,6 +115,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;
   /**
@@ -129,6 +135,7 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * A single option within a select dropdown that users can choose.
+ * @publicDocs
  */
 declare class Option extends PreactCustomElement implements OptionProps {
   /**
@@ -165,6 +172,7 @@ declare module 'preact' {
 declare const tagName = 's-option';
 /**
  * Properties for using the option component in JSX with React-style props.
+ * @publicDocs
  */
 export interface OptionJSXProps
   extends Partial<OptionProps>,
@@ -176,4 +184,7 @@ export interface OptionJSXProps
 }
 
 export {Option};
+/**
+ * @publicDocs
+ */
 export type {OptionJSXProps};

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

@@ -10,16 +10,19 @@ import type {ComponentChildren, OptionGroupProps$1} from './shared.d.ts';
 
 /**
  * Properties for rendering a group of related options within a select dropdown, organized under a shared label.
+ * @publicDocs
  */
 export interface OptionGroupProps
   extends Required<Pick<OptionGroupProps$1, 'disabled' | 'label'>> {}
 
 /**
  * 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'> & {
   /**
@@ -33,6 +36,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * Information about modifier keys and mouse buttons that were active during an interaction.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -54,6 +58,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for influencing how a programmatic click behaves.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -108,6 +113,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;
   /**
@@ -127,6 +133,7 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * A group of related options within a select dropdown, displayed with a label.
+ * @publicDocs
  */
 declare class OptionGroup
   extends PreactCustomElement
@@ -159,6 +166,7 @@ declare module 'preact' {
 declare const tagName = 's-option-group';
 /**
  * Properties for using the option group component in JSX with React-style props.
+ * @publicDocs
  */
 export interface OptionGroupJSXProps
   extends Partial<OptionGroupProps>,
@@ -170,4 +178,7 @@ export interface OptionGroupJSXProps
 }
 
 export {OptionGroup};
+/**
+ * @publicDocs
+ */
 export type {OptionGroupJSXProps};

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

@@ -9,15 +9,18 @@ import type {ComponentChildren, OrderedListProps$1} from './shared.d.ts';
 
 /**
  * The properties for the ordered list component. These properties define a numbered list of items with automatic numbering and proper list semantics.
+ * @publicDocs
  */
 export interface OrderedListProps extends OrderedListProps$1 {}
 
 /**
  * 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'> & {
   /**
@@ -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 {
 }
 /**
  * Options for customizing click behavior on an element.
+ * @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> {
@@ -154,6 +161,7 @@ declare module 'preact' {
 declare const tagName = 's-ordered-list';
 /**
  * The JSX properties for the ordered list component. These properties define how an ordered list is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface OrderedListJSXProps
   extends Partial<OrderedListProps>,
@@ -165,4 +173,7 @@ export interface OrderedListJSXProps
 }
 
 export {OrderedList};
+/**
+ * @publicDocs
+ */
 export type {OrderedListJSXProps};

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

@@ -13,6 +13,9 @@ import type {
   RenderImpl,
 } from './shared.d.ts';
 
+/**
+ * @publicDocs
+ */
 export interface PageProps
   extends Required<Pick<PageProps$1, 'inlineSize' | 'heading'>> {
   inlineSize: Extract<PageProps$1['inlineSize'], 'base' | 'large' | 'small'>;
@@ -71,6 +74,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-page';
+/**
+ * @publicDocs
+ */
 export interface PageJSXProps
   extends Partial<PageProps>,
     Pick<PageProps$1, 'id' | 'children'> {
@@ -106,4 +112,7 @@ export interface PageJSXProps
 }
 
 export {Page};
+/**
+ * @publicDocs
+ */
 export type {PageJSXProps};

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

@@ -10,6 +10,7 @@ import type {ComponentChildren, ParagraphProps$1} from './shared.d.ts';
 
 /**
  * The properties for the paragraph component. These properties define blocks of text content with consistent spacing and styling for readable body copy.
+ * @publicDocs
  */
 export interface ParagraphProps
   extends Required<
@@ -46,10 +47,12 @@ export interface ParagraphProps
 
 /**
  * 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'> & {
   /**
@@ -64,6 +67,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 {
   /**
@@ -85,6 +89,7 @@ export interface ActivationEventEsque {
 }
 /**
  * Options for customizing click behavior on an element.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -137,6 +142,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> {
   /**
@@ -154,6 +160,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> {
@@ -214,6 +221,7 @@ declare module 'preact' {
 declare const tagName = 's-paragraph';
 /**
  * The JSX properties for the paragraph component. These properties define how a paragraph is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface ParagraphJSXProps
   extends Partial<ParagraphProps>,
@@ -225,4 +233,7 @@ export interface ParagraphJSXProps
 }
 
 export {Paragraph};
+/**
+ * @publicDocs
+ */
 export type {ParagraphJSXProps};