@shopify/ui-extensions 2026.1.2 → 2026.1.3

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -6,45 +6,150 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  ButtonGroupProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+import type {ComponentChildren, ButtonGroupProps$1} from './shared.d.ts';
 
+/**
+ * Properties for rendering a button group that arranges multiple buttons together with consistent spacing and semantic grouping.
+ */
 export interface ButtonGroupProps
   extends Required<Pick<ButtonGroupProps$1, 'gap' | 'accessibilityLabel'>> {}
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * 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 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;
+}
+/**
+ * Base class for creating custom elements with Preact.
+ * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
+ * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
+ */
+declare const BaseClass: typeof globalThis.HTMLElement;
+declare abstract class PreactCustomElement extends BaseClass {
+  /** @private */
+  static get observedAttributes(): string[];
+  constructor({
+    styles,
+    ShadowRoot: renderFunction,
+    delegatesFocus,
+    ...options
+  }: RenderImpl);
 
-declare abstract class ButtonGroupBase
-  extends PolarisCustomElement
-  implements Pick<ButtonGroupProps, 'gap' | 'accessibilityLabel'>
-{
-  accessor gap: ButtonGroupProps['gap'];
-  accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];
-  constructor(renderImpl: RenderImpl);
+  /** @private */
+  setAttribute(name: string, value: string): void;
+  /** @private */
+  attributeChangedCallback(name: string): void;
+  /** @private */
+  connectedCallback(): void;
+  /** @private */
+  disconnectedCallback(): void;
+  /** @private */
+  adoptedCallback(): void;
+  /**
+   * Queue a run of the render function.
+   * You shouldn't need to call this manually - it should be handled by changes to @property values.
+   * @private
+   */
+  queueRender(): void;
+  /**
+   * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
+   *
+   * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
+   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
+   * @private
+   * @param options
+   */
+  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> {
+  /**
+   * The child elements or content that will be rendered inside this element.
+   */
   children?: preact.ComponentChildren;
 }
 
-declare class ButtonGroup extends ButtonGroupBase implements ButtonGroupProps {
+/**
+ * A button group that arranges multiple buttons together with consistent spacing and semantic grouping for related actions.
+ */
+declare class ButtonGroup
+  extends PreactCustomElement
+  implements ButtonGroupProps
+{
+  /**
+   * The amount of spacing between buttons in the group, affecting the visual separation of actions.
+   */
+  accessor gap: ButtonGroupProps['gap'];
+
+  /**
+   * A label that's only visible to screen readers, describing the purpose of this group of buttons.
+   */
+  accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];
+
   constructor();
 }
 declare global {
@@ -65,22 +170,27 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-button-group';
+
+/**
+ * Properties for using the button group component in JSX with React-style props.
+ */
 export interface ButtonGroupJSXProps
   extends Partial<ButtonGroupProps>,
     Pick<ButtonGroupProps$1, 'id' | 'children'> {
   /**
-   * The content of the ButtonGroup.
+   * The buttons that should be grouped together, provided as Button components.
    */
   children?: ComponentChildren;
   /**
-   * The primary action button for the group.
-   * Accepts a single Button element with a `variant` of `primary`.
-   * Cannot be used when gap="none".
+   * A single primary action button that's visually emphasized as the most important action in the group.
+   *
+   * Accepts a single Button element with a `variant` of `primary`. Can't be used when `gap` is set to `none`.
    */
   primaryAction?: ComponentChildren;
   /**
-   * Secondary action buttons for the group.
-   * Accepts Button or PressButton elements with a `variant` of `secondary` or `auto`.
+   * One or more secondary action buttons that provide alternative or less prominent actions.
+   *
+   * Accepts Button elements with a `variant` of `secondary` or `auto`.
    */
   secondaryActions?: ComponentChildren;
 }

package/src/surfaces/admin/components/Checkbox/examples/indeterminate-state.html

@@ -0,0 +1,10 @@
+<s-stack gap="small">
+  <s-checkbox
+    label="Select all items"
+    indeterminate
+  ></s-checkbox>
+  <s-divider></s-divider>
+  <s-checkbox label="Item 1" checked></s-checkbox>
+  <s-checkbox label="Item 2"></s-checkbox>
+  <s-checkbox label="Item 3"></s-checkbox>
+</s-stack>

package/src/surfaces/admin/components/Checkbox/examples/validation-example.html

@@ -0,0 +1,9 @@
+<s-section>
+  <s-stack gap="base" justifyContent="start">
+    <s-text-field label="Name"></s-text-field>
+    <s-checkbox
+      label="I agree to the terms"
+      error="You must accept the terms to continue"
+    ></s-checkbox>
+  </s-stack>
+</s-section>

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -9,13 +9,21 @@
 import type {
   TextFieldProps,
   CheckboxProps$1,
-  PreactCustomElement,
-  RenderImpl,
+  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,39 +31,161 @@ 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>;
 }
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * 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 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;
+}
+/**
+ * Base class for creating custom elements with Preact.
+ * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
+ * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
+ */
+declare const BaseClass: typeof globalThis.HTMLElement;
+declare abstract class PreactCustomElement extends BaseClass {
+  /** @private */
+  static get observedAttributes(): string[];
+  constructor({
+    styles,
+    ShadowRoot: renderFunction,
+    delegatesFocus,
+    ...options
+  }: RenderImpl);
+
+  /** @private */
+  setAttribute(name: string, value: string): void;
+  /** @private */
+  attributeChangedCallback(name: string): void;
+  /** @private */
+  connectedCallback(): void;
+  /** @private */
+  disconnectedCallback(): void;
+  /** @private */
+  adoptedCallback(): void;
+  /**
+   * Queue a run of the render function.
+   * You shouldn't need to call this manually - it should be handled by changes to @property values.
+   * @private
+   */
+  queueRender(): void;
+  /**
+   * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
+   *
+   * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
+   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
+   * @private
+   * @param options
+   */
+  click({sourceEvent}?: ClickOptions): void;
 }
 
 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 PolarisCustomElement
+  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<
@@ -71,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']);
   /**
@@ -84,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;
@@ -96,14 +253,32 @@ declare class PreactCheckboxElement
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * Properties for rendering a checkbox that supports checked, unchecked, and indeterminate states for complex selection scenarios.
+ */
 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();
 }
@@ -121,10 +296,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/src/surfaces/admin/components/Chip/examples/default.html

@@ -1 +1 @@
-<s-chip>Chip</s-chip>
+<s-chip color="base" accessibilityLabel="Product status">Active</s-chip>

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

@@ -59,13 +59,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;
 }