@shopify/ui-extensions 2025.10.13 → 2025.10.14

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

@@ -8,55 +8,118 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, BannerProps$1} from './shared.d.ts';
 
+/**
+ * A callback event that's typed to a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that currently has the event listener attached.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * An event listener for callback events, typed to a specific HTML element.
+ */
 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> {
+  /**
+   * The child elements to render inside this element.
+   */
   children?: preact.ComponentChildren;
 }
 
+/**
+ * All properties for the banner component marked as required.
+ */
 export type RequiredBannerProps = Required<BannerProps$1>;
+/**
+ * The properties for the banner component. These properties define an important message or notification with visual styling that conveys its semantic meaning.
+ */
 export interface BannerProps
   extends Pick<
     RequiredBannerProps,
     'heading' | 'dismissible' | 'hidden' | 'tone'
   > {
+  /**
+   * The color tone of the banner based on its semantic meaning.
+   *
+   * @default 'auto'
+   */
   tone: Extract<
     RequiredBannerProps['tone'],
     'auto' | 'critical' | 'warning' | 'success' | 'info'
   >;
 }
 
+/**
+ * A string containing CSS styles for the component.
+ */
 export type Styles = string;
+/**
+ * The implementation details for rendering a custom element with Preact.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * Optional CSS styles to apply to the shadow root.
+   */
   styles?: Styles;
 };
+/**
+ * An event-like object that contains activation information for synthetic clicks.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during activation.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the meta key (Command on Mac, Windows key on Windows) was pressed during activation.
+   */
   metaKey: boolean;
+  /**
+   * Whether the control key was pressed during activation.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during activation.
+   */
   button: number;
 }
+/**
+ * Options for customizing synthetic click behavior.
+ */
 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;
 }
@@ -103,12 +166,33 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * A custom element for displaying important messages and notifications.
+ */
 declare class Banner extends PreactCustomElement implements BannerProps {
+  /**
+   * The heading text displayed at the top of the banner.
+   */
   accessor heading: BannerProps['heading'];
+  /**
+   * The color tone of the banner based on its semantic meaning.
+   */
   accessor tone: BannerProps['tone'];
+  /**
+   * Whether the banner is hidden from view.
+   */
   accessor hidden: BannerProps['hidden'];
+  /**
+   * Whether the banner can be dismissed by the user.
+   */
   accessor dismissible: BannerProps['dismissible'];
+  /**
+   * A callback that's fired when the banner is dismissed.
+   */
   accessor ondismiss: CallbackEventListener<typeof tagName> | null;
+  /**
+   * A callback that's fired after the banner finishes hiding.
+   */
   accessor onafterhide: CallbackEventListener<typeof tagName> | null;
   constructor();
 }
@@ -127,20 +211,27 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-banner';
+/**
+ * The JSX properties for the banner component. These properties define how a banner is rendered in Preact or JSX.
+ */
 export interface BannerJSXProps
   extends Partial<BannerProps>,
     Pick<BannerProps$1, 'id' | 'children'> {
   /**
-   * The content of the Banner.
+   * The content of the banner.
    */
   children?: ComponentChildren;
   /**
-   * The secondary actions to display at the bottom of the Banner.
-   *
-   * Only Buttons with the `variant` of "secondary" or "auto" are permitted. A maximum of two `s-button` components are allowed.
+   * The secondary actions to display at the bottom of the banner. Only buttons with the `variant` of `'secondary'` or `'auto'` are allowed. A maximum of two `s-button` components can be provided.
    */
   secondaryActions?: ComponentChildren;
+  /**
+   * A callback that's fired when the banner is dismissed.
+   */
   onDismiss?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * A callback that's fired after the banner finishes hiding.
+   */
   onAfterHide?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 

package/src/surfaces/admin/components/BlockExtensionComponents.ts

@@ -1,5 +1,8 @@
 import {StandardComponents} from './StandardComponents';
 
+/**
+ * The components available for building block extensions. Includes all standard components plus the admin block component required for block extension setup and the form component for creating forms.
+ */
 export type BlockExtensionComponents =
   | StandardComponents
   | 'AdminBlock'

package/src/surfaces/admin/components/Box/examples/accessible-status-messages.html

@@ -1,14 +1,8 @@
-<s-stack gap="base">
-  <s-box
-    accessibilityRole="status"
-    padding="base"
-    background="strong"
-    borderRadius="base"
-  >
-    <s-paragraph>Payment failed</s-paragraph>
-  </s-box>
-
-  <s-box accessibilityVisibility="exclusive">
-    <s-paragraph>Price includes tax and shipping</s-paragraph>
-  </s-box>
-</s-stack>
+<s-box
+  accessibilityRole="status"
+  padding="base"
+  background="strong"
+  borderRadius="base"
+>
+  <s-paragraph>Syncing inventory: 3 of 10 products updated</s-paragraph>
+</s-box>

package/src/surfaces/admin/components/Box/examples/screen-reader-only-content.html

@@ -0,0 +1,3 @@
+<s-box accessibilityVisibility="exclusive">
+  <s-paragraph>Price includes tax and shipping</s-paragraph>
+</s-box>