@shopify/ui-extensions 2025.10.13 → 2025.10.15

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

@@ -12,9 +12,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;
@@ -22,28 +31,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;
 }
@@ -91,26 +136,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<
@@ -126,12 +201,21 @@ export interface PreactCheckboxProps
       | 'disabled'
     >
   > {
+  /**
+   * The value that's submitted with the form when the checkbox is checked.
+   */
   value: Required<CheckboxProps$1>['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']);
   /**
@@ -139,11 +223,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;
@@ -151,14 +253,34 @@ declare class PreactCheckboxElement
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties for rendering a checkbox that supports checked, unchecked, and indeterminate states for complex selection scenarios.
+ *
+ * @publicDocs
+ */
 export interface CheckboxProps extends PreactCheckboxProps {
+  /**
+   * Whether the checkbox is in an indeterminate state, showing a dash instead of a checkmark to represent a partial selection.
+   */
   indeterminate: Required<CheckboxProps$1>['indeterminate'];
+  /**
+   * Whether the checkbox should be in an indeterminate state when it's first rendered, useful for partial selection scenarios.
+   */
   defaultIndeterminate: Required<CheckboxProps$1>['defaultIndeterminate'];
 }
 
+/**
+ * A checkbox that lets users select or deselect an option, with support for an indeterminate state.
+ */
 declare class Checkbox extends PreactCheckboxElement implements CheckboxProps {
+  /**
+   * Whether the checkbox is in an indeterminate state, showing a dash instead of a checkmark.
+   */
   get indeterminate(): CheckboxProps['indeterminate'];
   set indeterminate(indeterminate: CheckboxProps['indeterminate']);
+  /**
+   * Whether the checkbox should be in an indeterminate state when it's first rendered.
+   */
   accessor defaultIndeterminate: CheckboxProps['defaultIndeterminate'];
   constructor();
 }
@@ -176,10 +298,19 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-checkbox';
+/**
+ * Props for using the checkbox component in JSX with React-style event handlers.
+ */
 export interface CheckboxJSXProps
   extends Partial<CheckboxProps>,
     Pick<CheckboxProps$1, 'id'> {
+  /**
+   * A callback that's triggered when the checkbox's checked state changes and it loses focus.
+   */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * A callback that's triggered when the checkbox's checked state changes.
+   */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 

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

@@ -110,13 +110,11 @@ export interface ChipJSXProps
   extends Partial<ChipProps>,
     Pick<ChipProps$1, 'id' | 'children'> {
   /**
-   * The content of the Chip.
+   * The content of the chip.
    */
   children?: ComponentChildren;
   /**
-   * The graphic to display in the chip.
-   *
-   * Only accepts `Icon` components.
+   * An optional icon to display at the start of the chip. Accepts only Icon components.
    */
   graphic?: ComponentChildren;
 }

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

@@ -8,6 +8,9 @@
 /// <reference lib="DOM" />
 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.
+ */
 export interface ChoiceProps
   extends Required<
     Pick<
@@ -20,20 +23,50 @@ export interface ChoiceProps
     >
   > {}
 
+/**
+ * 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;
 }
@@ -82,11 +115,17 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /** 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>;
 }
 /** Used when an element has children. */
@@ -95,12 +134,30 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A single choice within a choice list that can be selected with a radio button or checkbox.
+ */
 declare class Choice extends PreactCustomElement implements ChoiceProps {
+  /**
+   * Whether the choice is disabled and can't be selected.
+   */
   accessor disabled: ChoiceProps['disabled'];
+  /**
+   * Whether the choice is currently selected.
+   */
   get selected(): boolean;
   set selected(selected: ChoiceProps['selected']);
+  /**
+   * The value that's submitted with the form when this choice is selected.
+   */
   accessor value: ChoiceProps['value'];
+  /**
+   * A label that's only visible to screen readers, used when the visual label isn't descriptive enough.
+   */
   accessor accessibilityLabel: ChoiceProps['accessibilityLabel'];
+  /**
+   * Whether the choice should be selected when it's first rendered.
+   */
   accessor defaultSelected: ChoiceProps['defaultSelected'];
   constructor();
   /** @private */
@@ -123,22 +180,22 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-choice';
+/**
+ * Properties for using the choice component in JSX with React-style props.
+ */
 export interface ChoiceJSXProps
   extends Partial<ChoiceProps>,
     Pick<ChoiceProps$1, 'id' | 'children' | 'details'> {
   /**
-   * Content to use as the choice label.
+   * The content that's used as the choice label, extracted as plain text from any provided markup.
    *
-   * The label is produced by extracting and
-   * concatenating the text nodes from the provided content;
-   * any markup or element structure is ignored.
+   * The label is produced by extracting and concatenating the text nodes from the provided content; any markup or element structure is ignored.
    */
   children?: ComponentChildren;
   /**
-   * Additional text to provide context or guidance for the input.
+   * Additional text that provides context or guidance for the input, displayed alongside the choice label.
    *
-   * This text is displayed along with the input and its label
-   * to offer more information or instructions to the user.
+   * This text is displayed along with the input and its label to offer more information or instructions to the user.
    *
    * @implementation this content should be linked to the input with an `aria-describedby` attribute.
    */

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

@@ -8,9 +8,18 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, ChoiceListProps$1} 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;
@@ -18,11 +27,17 @@ 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>;
 }
 /** Used when an element has children. */
@@ -31,6 +46,11 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * 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<
     Pick<
@@ -46,20 +66,50 @@ export interface ChoiceListProps
     >
   > {}
 
+/**
+ * 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;
 }
@@ -107,22 +157,61 @@ declare abstract class PreactCustomElement extends BaseClass$1 {
 }
 
 declare const internals: unique symbol;
+/**
+ * Base class for form-associated custom elements.
+ */
 declare class BaseClass extends PreactCustomElement {
+  /**
+   * Indicates that this element can participate in form submission.
+   */
   static formAssociated: boolean;
   constructor(renderImpl: RenderImpl);
   /** @private */
   [internals]: ElementInternals;
 }
+/**
+ * A list of choices that lets users select one or more options using radio buttons or checkboxes.
+ */
 declare class ChoiceList extends BaseClass implements ChoiceListProps {
+  /**
+   * Whether all choices in the list are disabled and can't be selected.
+   */
   accessor disabled: ChoiceListProps['disabled'];
+  /**
+   * The name that identifies this choice list when the form is submitted.
+   */
   accessor name: ChoiceListProps['name'];
+  /**
+   * An error message that's displayed below the choice list when validation fails.
+   */
   accessor error: ChoiceListProps['error'];
+  /**
+   * Additional text to provide context or guidance for the choice list.
+   */
   accessor details: ChoiceListProps['details'];
+  /**
+   * Whether users can select more than one choice at a time.
+   */
   accessor multiple: ChoiceListProps['multiple'];
+  /**
+   * The text that describes what the choice list is for.
+   */
   accessor label: ChoiceListProps['label'];
+  /**
+   * A callback that's triggered when the selected choices change and the choice list loses focus.
+   */
   accessor onchange: CallbackEventListener<typeof tagName> | null;
+  /**
+   * A callback that's triggered when the selected choices change.
+   */
   accessor oninput: CallbackEventListener<typeof tagName> | null;
+  /**
+   * Controls whether the label is visible to all users or only to screen readers.
+   */
   accessor labelAccessibilityVisibility: ChoiceListProps['labelAccessibilityVisibility'];
+  /**
+   * The values of the currently selected choices.
+   */
   get values(): ChoiceListProps['values'];
   set values(values: ChoiceListProps['values']);
   /** @private */
@@ -148,16 +237,25 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-choice-list';
+/**
+ * Properties for using the choice list component in JSX with React-style event handlers.
+ */
 export interface ChoiceListJSXProps
   extends Partial<ChoiceListProps>,
     Pick<ChoiceListProps$1, 'id' | 'children'> {
   /**
-   * The choices a user can select from.
+   * The choices that a user can select from, provided as Choice components.
    *
-   * Accepts `Choice` components.
+   * Accepts Choice components.
    */
   children?: ComponentChildren;
+  /**
+   * A callback that's triggered when the selected choices change and the choice list loses focus.
+   */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * A callback that's triggered when the selected choices change as the user interacts with them.
+   */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }