@shopify/ui-extensions 2025.10.13 → 2025.10.15

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

@@ -13,9 +13,18 @@ import type {
   ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * An event that includes a strongly-typed reference to the element that triggered it.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event handler was attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * A function that handles events for a specific element type, or null if no handler is set.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
@@ -23,28 +32,64 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | null;
 /** Used when an element does not have children. */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * 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.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
 
+/**
+ * CSS styles that will be applied to the component's shadow DOM.
+ */
 export type Styles = string;
+/**
+ * Configuration for rendering a custom element with Preact and shadow DOM.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * A function that renders the component's content inside the shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * CSS styles that will be applied to the shadow DOM.
+   */
   styles?: Styles;
 };
+/**
+ * Information about modifier keys and mouse buttons that were active during an interaction.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down during the interaction.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was held down during the interaction.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the interaction.
+   */
   button: number;
 }
+/**
+ * Options for influencing how a programmatic click behaves.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * 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.
    */
   sourceEvent?: ActivationEventEsque;
 }
@@ -92,26 +137,56 @@ declare abstract class PreactCustomElement extends BaseClass {
 }
 
 declare const internals: unique symbol;
+/**
+ * The core properties that all input elements need to function within forms.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/**
+ * Base class for input elements that participate in form submission.
+ */
 declare class PreactInputElement
   extends PreactCustomElement
   implements PreactInputProps
 {
+  /**
+   * Indicates that this element can participate in form submission.
+   */
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * A callback that's triggered when the input's value changes and the field loses focus.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * A callback that's triggered when the input's value changes as the user types.
+   */
   accessor oninput: CallbackEventListener<'input'>;
+  /**
+   * Whether the input is disabled and can't be interacted with.
+   */
   accessor disabled: PreactInputProps['disabled'];
+  /**
+   * A unique identifier for the input element.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * The name that identifies this input when the form is submitted.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value of the input.
+   */
   get value(): PreactInputProps['value'];
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties that are common to checkbox-style components.
+ */
 export interface PreactCheckboxProps
   extends Required<
     Pick<
@@ -127,12 +202,21 @@ export interface PreactCheckboxProps
       | 'disabled'
     >
   > {
+  /**
+   * The value that's submitted with the form when the checkbox is checked.
+   */
   value: Required<CheckboxProps>['value'];
 }
+/**
+ * Base class for checkbox-style elements that can be toggled on and off.
+ */
 declare class PreactCheckboxElement
   extends PreactInputElement
   implements PreactCheckboxProps
 {
+  /**
+   * Whether the checkbox is currently checked.
+   */
   get checked(): boolean;
   set checked(checked: PreactCheckboxProps['checked']);
   /**
@@ -140,11 +224,29 @@ declare class PreactCheckboxElement
    */
   get value(): string;
   set value(value: string);
+  /**
+   * Whether the checkbox should be checked when it's first rendered.
+   */
   accessor defaultChecked: PreactCheckboxProps['defaultChecked'];
+  /**
+   * A label that's only visible to screen readers, used when the visual label isn't descriptive enough.
+   */
   accessor accessibilityLabel: PreactCheckboxProps['accessibilityLabel'];
+  /**
+   * Additional text to provide context or guidance for the checkbox.
+   */
   accessor details: PreactCheckboxProps['details'];
+  /**
+   * An error message that's displayed below the checkbox when validation fails.
+   */
   accessor error: PreactCheckboxProps['error'];
+  /**
+   * The text that describes what the checkbox is for.
+   */
   accessor label: PreactCheckboxProps['label'];
+  /**
+   * Whether the checkbox must be checked before the form can be submitted.
+   */
   accessor required: PreactCheckboxProps['required'];
   /** @private */
   formResetCallback(): void;
@@ -152,11 +254,20 @@ declare class PreactCheckboxElement
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties for rendering a switch that lets users toggle a setting on or off with a sliding control interface.
+ */
 export interface SwitchProps
   extends PreactCheckboxProps,
     Required<Pick<SwitchProps$1, 'labelAccessibilityVisibility'>> {}
 
+/**
+ * A switch that lets users toggle a setting on or off with a sliding control.
+ */
 declare class Switch extends PreactCheckboxElement implements SwitchProps {
+  /**
+   * Controls whether the label is visible to all users or only to screen readers.
+   */
   accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility'];
   constructor();
 }
@@ -174,10 +285,19 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-switch';
+/**
+ * Properties for using the switch component in JSX with React-style event handlers.
+ */
 export interface SwitchJSXProps
   extends Partial<SwitchProps>,
     Pick<SwitchProps$1, 'id'> {
+  /**
+   * A callback that's triggered when the switch's checked state changes and it loses focus.
+   */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * A callback that's triggered when the switch's checked state changes as the user interacts with it.
+   */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 

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

@@ -12,6 +12,9 @@ import type {
   TableHeaderProps$1,
 } from './shared.d.ts';
 
+/**
+ * The properties you can set on a table component.
+ */
 export interface TableProps
   extends Required<
     Pick<
@@ -19,36 +22,81 @@ export interface TableProps
       'loading' | 'paginate' | 'hasPreviousPage' | 'hasNextPage' | 'variant'
     >
   > {
+  /**
+   * The display variant of the table. Use `list` to force a list view, or `auto` to automatically switch between table and list based on the available space.
+   */
   variant: Extract<TableProps$1['variant'], 'list' | 'auto'>;
 }
 
+/**
+ * The format type for a table header, which determines how the cell content is displayed.
+ */
 export type HeaderFormat = Extract<
   TableHeaderProps$1['format'],
   'base' | 'currency' | 'numeric'
 >;
+/**
+ * The properties you can set on a table header component.
+ */
 export interface TableHeaderProps
   extends Pick<TableHeaderProps$1, 'listSlot' | 'format'> {
+  /**
+   * The slot where this header's data appears in list view. The options include `primary` for the main content, `secondary` for supporting text, `labeled` for labeled data, `kicker` for small text above the primary content, or `inline` for inline content.
+   */
   listSlot: Extract<
     TableHeaderProps$1['listSlot'],
     'primary' | 'secondary' | 'labeled' | 'kicker' | 'inline'
   >;
+  /**
+   * The format of the header, which affects how the cell content is aligned and displayed. Use `base` for standard text, `currency` for monetary values, or `numeric` for numbers.
+   */
   format: HeaderFormat;
 }
 
+/**
+ * A string that contains CSS styles to apply to the component.
+ */
 export type Styles = string;
+/**
+ * The implementation details for rendering a Preact custom element with a shadow root.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
   styles?: Styles;
 };
+/**
+ * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
+   */
   button: number;
 }
+/**
+ * The options for customizing how a synthetic click is performed.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * 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.
    */
   sourceEvent?: ActivationEventEsque;
 }
@@ -95,29 +143,55 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * A context object that provides a default value of a specific type.
+ */
 export interface Context<T> {
+  /**
+   * The default value for this context.
+   */
   readonly defaultValue: T;
 }
+/**
+ * An extended context class that provides event-based updates when the context value changes.
+ */
 declare class AddedContext<T> extends EventTarget {
+  /**
+   * Creates a new context with the given default value.
+   */
   constructor(defaultValue: T);
+  /**
+   * The current value of the context.
+   */
   get value(): T;
+  /**
+   * Sets a new value for the context.
+   */
   set value(value: T);
 }
 
 /**
- * A callback which is provided by a context requester and is called with the value satisfying the request.
- * This callback can be called multiple times by context providers as the requested value is changed.
+ * 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.
  */
 export type ContextCallback<T> = (value: T) => void;
 /**
- * An event fired by a context requester to signal it desires a named context.
+ * An event that a context requester fires to signal it wants a named context.
  *
- * A provider should inspect the `context` property of the event to determine if it has a value that can
- * satisfy the request, calling the `callback` with the requested value if so.
+ * A provider should inspect the `context` property of the event to see if it has a value that can satisfy the request, and if so, call the `callback` with the requested value.
  */
 declare class ContextRequestEvent<T> extends Event {
+  /**
+   * The context that's being requested.
+   */
   readonly context: Context<T>;
+  /**
+   * The callback to call with the requested context value.
+   */
   readonly callback: ContextCallback<T>;
+  /**
+   * Creates a new context request event with the given context and callback.
+   */
   constructor(context: Context<T>, callback: ContextCallback<T>);
 }
 declare global {
@@ -130,40 +204,88 @@ declare global {
   }
 }
 
+/** @private */
 declare const actualTableVariantSymbol: unique symbol;
+/** @private */
 declare const tableHeadersSharedDataSymbol: unique symbol;
+/**
+ * The actual display variant of the table, which is either a traditional table or a list.
+ */
 export type ActualTableVariant = 'table' | 'list';
 
+/**
+ * An event that includes a strongly typed `currentTarget` property based on the element tag name.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event listener is attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * An event listener function that receives a strongly typed callback event, or `null` if no listener is attached.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
-/** Used when an element does not have children. */
+/**
+ * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * 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.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A component that displays data in a structured table format that automatically adapts to the available space.
+ */
 declare class Table extends PreactCustomElement implements TableProps {
+  /**
+   * The display variant of the table.
+   */
   accessor variant: TableProps['variant'];
+  /**
+   * Whether the table is currently in a loading state.
+   */
   accessor loading: TableProps['loading'];
+  /**
+   * Whether the pagination controls are displayed.
+   */
   accessor paginate: TableProps['paginate'];
+  /**
+   * Whether there's a previous page of data that the user can navigate to.
+   */
   accessor hasPreviousPage: TableProps['hasPreviousPage'];
+  /**
+   * Whether there's a next page of data that the user can navigate to.
+   */
   accessor hasNextPage: TableProps['hasNextPage'];
+  /**
+   * The event listener that's called when the user navigates to the previous page.
+   */
   accessor onpreviouspage: CallbackEventListener<typeof tagName> | null;
+  /**
+   * The event listener that's called when the user navigates to the next page.
+   */
   accessor onnextpage: CallbackEventListener<typeof tagName> | null;
   /**
    * @private
@@ -179,6 +301,9 @@ declare class Table extends PreactCustomElement implements TableProps {
     }[]
   >;
 
+  /**
+   * Creates a new Table instance.
+   */
   constructor();
 }
 declare global {
@@ -195,16 +320,22 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the table component.
+ */
 declare const tagName = 's-table';
+/**
+ * The JSX properties you can set on a table component.
+ */
 export interface TableJSXProps
   extends Partial<TableProps>,
     Pick<TableProps$1, 'id' | 'children' | 'onNextPage' | 'onPreviousPage'> {
   /**
-   * The content of the Table.
+   * The content to display inside the table, which should include table header row, table body, and table row components.
    */
   children?: ComponentChildren;
   /**
-   * Additional filters to display in the table. For example, the `s-search-field` component can be used to filter the table data.
+   * Additional filters to display in the table. For example, you can use the search field component to filter the table data.
    */
   filters?: ComponentChildren;
 }

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

@@ -7,22 +7,55 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, TableBodyProps$1} from './shared.d.ts';
 
+/**
+ * The properties you can set on a table body component.
+ */
 export interface TableBodyProps extends TableBodyProps$1 {}
 
+/**
+ * A string that contains CSS styles to apply to the component.
+ */
 export type Styles = string;
+/**
+ * The implementation details for rendering a Preact custom element with a shadow root.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
   styles?: Styles;
 };
+/**
+ * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the event.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the event.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
+   */
   button: number;
 }
+/**
+ * The options for customizing how a synthetic click is performed.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * 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.
    */
   sourceEvent?: ActivationEventEsque;
 }
@@ -69,22 +102,38 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
-/** Used when an element does not have children. */
+/**
+ * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * 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.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A component that wraps the body content of a table, which contains the data rows.
+ */
 declare class TableBody extends PreactCustomElement implements TableBodyProps {
+  /**
+   * Creates a new TableBody instance.
+   */
   constructor();
 }
 declare global {
@@ -101,12 +150,18 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the table body component.
+ */
 declare const tagName = 's-table-body';
+/**
+ * The JSX properties you can set on a table body component.
+ */
 export interface TableBodyJSXProps
   extends Partial<TableBodyProps>,
     Pick<TableBodyProps$1, 'id' | 'children'> {
   /**
-   * The body of the table. May not have any semantic meaning in the Table's `list` variant.
+   * The body content of the table, which should include table row components. This content might not have any semantic meaning when the table uses the `list` variant.
    */
   children?: ComponentChildren;
 }