@shopify/ui-extensions 2026.1.3 → 2026.1.4

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

@@ -14,11 +14,13 @@ import type {
 
 /**
  * The properties you can set on a tooltip component.
+ * @publicDocs
  */
 export interface TooltipProps extends Required<Pick<TooltipProps$1, 'id'>> {}
 
 /**
  * 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> {
   /**
@@ -36,6 +38,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> {
@@ -44,10 +47,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'> & {
   /**
@@ -61,6 +66,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 {
   /**
@@ -82,6 +88,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for customizing how a synthetic click is performed.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -134,6 +141,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'> {
@@ -176,6 +184,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 & {
   /**
@@ -189,6 +198,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 & {
   /**
@@ -252,6 +262,7 @@ declare module 'preact' {
 declare const tagName = 's-tooltip';
 /**
  * The JSX properties you can set on a tooltip component.
+ * @publicDocs
  */
 export interface TooltipJSXProps
   extends Partial<TooltipProps>,
@@ -263,4 +274,7 @@ export interface TooltipJSXProps
 }
 
 export {Tooltip};
+/**
+ * @publicDocs
+ */
 export type {TooltipJSXProps};

package/build/ts/surfaces/admin/components/URLField.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 URL field component. These properties configure an input field that allows merchants to enter and validate web addresses (URLs) with built-in validation.
+ * @publicDocs
  */
 export type URLFieldProps = PreactFieldProps<
   Required<URLFieldProps$1>['autocomplete']
@@ -380,6 +391,7 @@ declare module 'preact' {
 declare const tagName = 's-url-field';
 /**
  * The JSX props for the URL field component. These properties extend `URLFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact.
+ * @publicDocs
  */
 export interface URLFieldJSXProps
   extends Partial<Omit<URLFieldProps, 'accessory'>>,
@@ -387,4 +399,7 @@ export interface URLFieldJSXProps
     FieldReactProps<typeof tagName> {}
 
 export {URLField};
+/**
+ * @publicDocs
+ */
 export type {URLFieldJSXProps};

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

@@ -9,15 +9,18 @@ import type {ComponentChildren, UnorderedListProps$1} from './shared.d.ts';
 
 /**
  * The properties for the unordered list component. These properties define a bulleted list of items where the order doesn't matter.
+ * @publicDocs
  */
 export interface UnorderedListProps extends UnorderedListProps$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-unordered-list';
 /**
  * The JSX properties for the unordered list component. These properties define how an unordered list is rendered in Preact or JSX.
+ * @publicDocs
  */
 export interface UnorderedListJSXProps
   extends Partial<UnorderedListProps>,
@@ -165,4 +173,7 @@ export interface UnorderedListJSXProps
 }
 
 export {UnorderedList};
+/**
+ * @publicDocs
+ */
 export type {UnorderedListJSXProps};