@shopify/ui-extensions 2026.1.2 → 2026.1.3

package/src/surfaces/admin/components/OptionGroup.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,27 +6,117 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  OptionGroupProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+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.
+ */
 export interface OptionGroupProps
   extends Required<Pick<OptionGroupProps$1, 'disabled' | 'label'>> {}
 
-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;
 }
 
 /** 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. */
@@ -35,11 +125,20 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A group of related options within a select dropdown, displayed with a label.
+ */
 declare class OptionGroup
-  extends PolarisCustomElement
+  extends PreactCustomElement
   implements OptionGroupProps
 {
+  /**
+   * Whether all options in the group are disabled and can't be selected.
+   */
   accessor disabled: OptionGroupProps['disabled'];
+  /**
+   * The text that describes what this group of options represents.
+   */
   accessor label: OptionGroupProps['label'];
   constructor();
 }
@@ -58,13 +157,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-option-group';
+/**
+ * Properties for using the option group component in JSX with React-style props.
+ */
 export interface OptionGroupJSXProps
   extends Partial<OptionGroupProps>,
     Pick<OptionGroupProps$1, 'id' | 'children'> {
   /**
-   * The options a user can select from.
-   *
-   * Accepts `Option` components.
+   * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/OrderedList/examples/default.html

@@ -1,5 +1,5 @@
 <s-ordered-list>
-  <s-list-item>Red shirt</s-list-item>
-  <s-list-item>Green shirt</s-list-item>
-  <s-list-item>Blue shirt</s-list-item>
+  <s-list-item>Add products to your catalog</s-list-item>
+  <s-list-item>Set up payment methods</s-list-item>
+  <s-list-item>Configure shipping zones</s-list-item>
 </s-ordered-list>

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

@@ -1,40 +1,138 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  OrderedListProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+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.
+ */
 export interface OrderedListProps extends OrderedListProps$1 {}
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * A string containing CSS styles.
+ */
+export type Styles = string;
+/**
+ * The configuration for rendering a custom element with a shadow DOM.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow DOM content.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * Optional CSS styles to apply to the shadow DOM.
+   */
+  styles?: Styles;
+};
+/**
+ * An object that represents the state of modifier keys and mouse button
+ * during an activation event like a click.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the meta (Command on Mac, Windows key on PC) key was pressed.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the control key was pressed during the event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
+   */
+  button: number;
+}
+/**
+ * Options for customizing click behavior on an element.
+ */
+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);
 
-/** Used when an element does not have children. */
+  /** @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;
+}
+
+/**
+ * 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 custom element for displaying a numbered list of items with automatic numbering and proper list semantics. Use ordered list when the sequence or order of items matters, such as instructions, rankings, or step-by-step processes.
+ */
 declare class OrderedList
-  extends PolarisCustomElement
+  extends PreactCustomElement
   implements OrderedListProps
 {
   constructor();
@@ -54,13 +152,14 @@ 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.
+ */
 export interface OrderedListJSXProps
   extends Partial<OrderedListProps>,
     Pick<OrderedListProps$1, 'id'> {
   /**
-   * The items of the OrderedList.
-   *
-   * Only ListItems are accepted.
+   * The items in the ordered list. Only list item components are accepted.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/Page/examples/edit-page-with-all-slots.html

@@ -0,0 +1,36 @@
+<s-page heading="Edit product" inlineSize="base">
+  <s-link slot="breadcrumb-actions" href="/products">Products</s-link>
+
+  <s-button slot="primary-action" variant="primary" id="save-btn" disabled>Save</s-button>
+  <s-button slot="secondary-actions">Preview</s-button>
+  <s-button slot="secondary-actions" tone="critical">Delete</s-button>
+
+  <s-section>
+    <s-stack direction="block" gap="base">
+      <s-text-field label="Title" name="title" value="Blue T-Shirt" required></s-text-field>
+      <s-text-area label="Description" name="description" rows="4"></s-text-area>
+      <s-number-field label="Price" name="price"></s-number-field>
+    </s-stack>
+  </s-section>
+
+  <s-box slot="aside">
+    <s-section>
+      <s-stack direction="block" gap="base">
+        <s-heading>Status</s-heading>
+        <s-select label="Status" name="status">
+          <option value="draft">Draft</option>
+          <option value="active">Active</option>
+        </s-select>
+      </s-stack>
+    </s-section>
+  </s-box>
+</s-page>
+
+<script>
+  const form = document.querySelector('s-section');
+  const saveBtn = document.getElementById('save-btn');
+
+  form.addEventListener('input', () => {
+    saveBtn.disabled = false;
+  });
+</script>

package/src/surfaces/admin/components/Paragraph/examples/subdued-color.html

@@ -0,0 +1,3 @@
+<s-paragraph color="subdued">
+  Changes will take effect the next time the customer visits your store.
+</s-paragraph>

package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html

@@ -3,7 +3,19 @@
     Your order will be processed within 2-3 business days.
   </s-paragraph>
 
-  <s-paragraph tone="success" color="subdued">
+  <s-paragraph tone="success" color="base">
     Payment successfully processed.
   </s-paragraph>
+
+  <s-paragraph tone="caution" color="base">
+    Review shipping address before processing.
+  </s-paragraph>
+
+  <s-paragraph tone="warning" color="base">
+    Inventory levels are running low for this product.
+  </s-paragraph>
+
+  <s-paragraph tone="critical" color="base">
+    This order requires immediate attention due to shipping delays.
+  </s-paragraph>
 </s-section>

package/src/surfaces/admin/components/Paragraph.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,13 +6,11 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  ParagraphProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+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.
+ */
 export interface ParagraphProps
   extends Required<
     Pick<
@@ -25,55 +23,178 @@ export interface ParagraphProps
       | 'lineClamp'
     >
   > {
+  /**
+   * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
+  tone: Extract<
+    ParagraphProps$1['tone'],
+    'info' | 'success' | 'caution' | 'warning' | 'critical'
+  >;
+  /**
+   * The color of the paragraph text. Available options:
+   * - `'base'` - The default text color.
+   * - `'subdued'` - A lighter text color for secondary information.
+   */
   color: Extract<ParagraphProps$1['color'], 'base' | 'subdued'>;
 }
 
-/** Used when an element does not have children. */
+/**
+ * A string containing CSS styles.
+ */
+export type Styles = string;
+/**
+ * The configuration for rendering a custom element with a shadow DOM.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow DOM content.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * Optional CSS styles to apply to the shadow DOM.
+   */
+  styles?: Styles;
+};
+/**
+ * An object that represents the state of modifier keys and mouse button
+ * during an activation event like a click.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the meta (Command on Mac, Windows key on PC) key was pressed.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the control key was pressed during the event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
+   */
+  button: number;
+}
+/**
+ * Options for customizing click behavior on an element.
+ */
+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;
+}
+
+/**
+ * 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;
 }
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
-}
-
-declare abstract class ParagraphBase
-  extends PolarisCustomElement
-  implements
-    Pick<
-      ParagraphProps,
-      | 'fontVariantNumeric'
-      | 'lineClamp'
-      | 'tone'
-      | 'color'
-      | 'dir'
-      | 'accessibilityVisibility'
-    >
-{
+/**
+ * A custom element for displaying blocks of text content with consistent spacing and styling for readable body copy. Use Paragraph to render longer text content with proper line height and spacing between paragraphs.
+ */
+declare class Paragraph extends PreactCustomElement implements ParagraphProps {
+  /**
+   * The numeric font variant for the paragraph text.
+   */
   accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];
+  /**
+   * The maximum number of lines to display before the text is truncated with an ellipsis.
+   */
   accessor lineClamp: ParagraphProps['lineClamp'];
-  accessor tone: Extract<
-    ParagraphProps['tone'],
-    'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
-  >;
+  /**
+   * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
+  accessor tone: ParagraphProps['tone'];
 
+  /**
+   * The color of the paragraph text.
+   */
   accessor color: ParagraphProps['color'];
+  /**
+   * The text direction (left-to-right or right-to-left).
+   */
   accessor dir: ParagraphProps['dir'];
+  /**
+   * The visibility of the element to assistive technologies.
+   */
   accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility'];
-  constructor(renderImpl: RenderImpl);
-}
-
-declare class Paragraph extends ParagraphBase implements ParagraphProps {
   constructor();
 }
 declare global {
@@ -91,11 +212,14 @@ 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.
+ */
 export interface ParagraphJSXProps
   extends Partial<ParagraphProps>,
     Pick<ParagraphProps$1, 'id' | 'children'> {
   /**
-   * The content of the Paragraph.
+   * The content of the paragraph.
    */
   children?: ComponentChildren;
 }