@shopify/ui-extensions 2026.10.0-rc.8 → 2026.10.0

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.25.0 **/
+/** VERSION: 2.26.1 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -10,11 +10,46 @@ import type {
   ComponentChildren,
   TableProps$1,
   TableHeaderProps$1,
+  PreactCustomElement,
+  RenderImpl,
 } from './shared.d.ts';
+import * as preact$1 from 'preact';
+import {ReactNode, RefAttributes} from 'react';
+import * as _shopify_admin_web_component_foundations from '@shopify/admin-web-component-foundations';
+
+export type ReactIntrinsicElementChildren<PreactProps extends object> =
+  'children' extends keyof PreactProps
+    ? {
+        children?: ReactNode;
+      }
+    : Record<never, never>;
+export type ReactIntrinsicElementProps<
+  PreactProps extends object,
+  ElementType,
+> = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
+  ReactIntrinsicElementChildren<PreactProps> &
+  RefAttributes<ElementType> & {
+    slot?: Lowercase<string>;
+  };
+export type ReactIntrinsicElements = {
+  [Tag in Exclude<
+    Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
+    `s-test-${string}`
+  >]: ReactIntrinsicElementProps<
+    preact$1.createElement.JSX.IntrinsicElements[Tag],
+    Tag extends keyof HTMLElementTagNameMap
+      ? HTMLElementTagNameMap[Tag]
+      : HTMLElement
+  >;
+};
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements extends ReactIntrinsicElements {}
+  }
+}
 
 /**
- * The properties you can set on a table component.
- * @publicDocs
+ * Configure the following properties on the table component.
  */
 export interface TableProps
   extends Required<
@@ -24,13 +59,23 @@ export interface TableProps
     >
   > {
   /**
-   * 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.
+   * The layout variant of the table component.
+   *
+   * - `list`: Always displays as a list layout.
+   * - `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.
+   *
+   * @default 'auto'
    */
   variant: Extract<TableProps$1['variant'], 'list' | 'auto'>;
 }
 
 /**
- * The format type for a table header, which determines how the cell content is displayed.
+ * Represents the format options for table headers that control styling and alignment of column content.
+ *
+ * Available values:
+ * - `base`: Standard format for text columns
+ * - `currency`: Right-aligned format for monetary values
+ * - `numeric`: Right-aligned format for numeric values
  * @publicDocs
  */
 export type HeaderFormat = Extract<
@@ -38,203 +83,66 @@ export type HeaderFormat = Extract<
   'base' | 'currency' | 'numeric'
 >;
 /**
- * The properties you can set on a table header component.
- * @publicDocs
+ * The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.
+ *
+ * Table header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.
  */
 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.
+   * The content designation for this column when the table displays in list variant on mobile devices.
+   *
+   * @default 'labeled'
    */
   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.
+   * The format of the column that controls styling and alignment of cell content.
+   *
+   * @default 'base'
    */
   format: HeaderFormat;
 }
 
+declare const actualTableVariantSymbol: unique symbol;
+declare const tableHeadersSharedDataSymbol: unique symbol;
 /**
- * A string that contains CSS styles to apply to the component.
- * @publicDocs
- */
-export type Styles = string;
-/**
- * The implementation details for rendering a Preact custom element with a shadow root.
- * @publicDocs
- */
-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.
- * @publicDocs
- */
-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.
+ * Represents the actual rendered variant of a table component.
+ * - `table`: Displays as a traditional table layout.
+ * - `list`: Displays as a list layout.
  * @publicDocs
  */
-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);
+export type ActualTableVariant = 'table' | 'list';
+declare const elementInternals: unique symbol;
 
-  /** @private */
-  setAttribute(name: string, value: string): void;
-  /** @private */
-  attributeChangedCallback(name: string): void;
+declare class PolarisCustomElement extends PreactCustomElement {
+  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
   /** @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;
-}
-
-/**
- * A context object that provides a default value of a specific type.
- * @publicDocs
- */
-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 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.
- * @publicDocs
- */
-export type ContextCallback<T> = (value: T) => void;
-/**
- * An event that a context requester fires to signal it wants a named context.
+ * An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.
  *
- * 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 {
-  interface HTMLElementEventMap {
-    /**
-     * A 'context-request' event can be emitted by any element which desires
-     * a context value to be injected by an external provider.
-     */
-    'context-request': ContextRequestEvent<unknown>;
-  }
-}
-
-/** @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.
- * @publicDocs
- */
-export type ActualTableVariant = 'table' | 'list';
-
-/**
- * An event that includes a strongly typed `currentTarget` property based on the element tag name.
+ * This type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.
  * @publicDocs
  */
 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.
+ * A function that handles events from UI components.
+ *
+ * This type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.
+ *
+ * @example
+ * const handleClick: CallbackEventListener<'button'> = (event) => {
+ *   console.log('Button clicked:', event.currentTarget);
+ * };
  * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
@@ -243,71 +151,63 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
     })
   | null;
 /**
- * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ * Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.
  * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
-   * 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.
+   * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
+   * Essential for maintaining component state and optimizing re-renders when lists change.
    */
   key?: preact.Key;
   /**
-   * 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.
+   * A reference to access the underlying DOM element directly.
+   * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
    */
   ref?: preact.Ref<TClass>;
   /**
-   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   * The named slot to which this element is assigned in the parent component's shadow DOM.
+   *
+   * Used for advanced component composition with web components.
    */
   slot?: Lowercase<string>;
 }
 /**
- * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ * Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
  * @publicDocs
  */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
+  /**
+   * The child elements to be rendered within this component.
+   */
   children?: preact.ComponentChildren;
 }
 
 /**
- * A component that displays data in a structured table format that automatically adapts to the available space.
+ * Configure the following properties on the table component.
+ * @publicDocs
  */
-declare class Table extends PreactCustomElement implements TableProps {
-  /**
-   * The display variant of the table.
-   */
+declare class Table extends PolarisCustomElement implements TableProps {
+  /** @private */
+  [elementInternals]: ElementInternals;
   accessor variant: TableProps['variant'];
   /**
-   * Whether the table is currently in a loading state.
+   * Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.
    */
   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
    * The actual table variant, which is either 'table' or 'list'.
    */
-  [actualTableVariantSymbol]: AddedContext<ActualTableVariant>;
+  [actualTableVariantSymbol]: _shopify_admin_web_component_foundations.AddedContext<ActualTableVariant>;
   /** @private */
-  [tableHeadersSharedDataSymbol]: AddedContext<
+  [tableHeadersSharedDataSymbol]: _shopify_admin_web_component_foundations.AddedContext<
     {
       listSlot: TableHeaderProps['listSlot'];
       textContent: string;
@@ -315,9 +215,6 @@ declare class Table extends PreactCustomElement implements TableProps {
     }[]
   >;
 
-  /**
-   * Creates a new Table instance.
-   */
   constructor();
 }
 declare global {
@@ -334,23 +231,16 @@ 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.
- * @publicDocs
- */
 export interface TableJSXProps
   extends Partial<TableProps>,
     Pick<TableProps$1, 'id' | 'children' | 'onNextPage' | 'onPreviousPage'> {
   /**
-   * The content to display inside the table, which should include table header row, table body, and table row components.
+   * The table structure displayed within the table component, including table headers, rows, and cells that organize data in a grid format.
    */
   children?: ComponentChildren;
   /**
-   * Additional filters to display in the table. For example, you can use the search field component to filter the table data.
+   * Additional filters to display in the table, such as search fields or other input components that allow users to narrow down the displayed data.
    */
   filters?: ComponentChildren;
 }