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

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.25.0 **/
+/** VERSION: 2.26.1 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -6,157 +6,132 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {ComponentChildren, ButtonGroupProps$1} from './shared.d.ts';
+import type {
+  ComponentChildren,
+  ButtonGroupProps$1,
+  PreactCustomElement,
+  RenderImpl,
+} from './shared.d.ts';
+import * as preact$1 from 'preact';
+import {ReactNode, RefAttributes} from 'react';
 
-/**
- * Properties for rendering a button group that arranges multiple buttons together with consistent spacing and semantic grouping.
- * @publicDocs
- */
-export interface ButtonGroupProps
-  extends Required<Pick<ButtonGroupProps$1, 'gap' | 'accessibilityLabel'>> {}
-
-/**
- * CSS styles that will be applied to the component's shadow DOM.
- * @publicDocs
- */
-export type Styles = string;
-/**
- * Configuration for rendering a custom element with Preact and shadow DOM.
- * @publicDocs
- */
-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;
+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 {}
+  }
+}
+
 /**
- * Information about modifier keys and mouse buttons that were active during an interaction.
- * @publicDocs
+ * Configure the following properties on the button group component.
  */
-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;
+export interface ButtonGroupProps
+  extends Required<Pick<ButtonGroupProps$1, 'gap' | 'accessibilityLabel'>> {
   /**
-   * The mouse button that was pressed during the interaction.
+   * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
+   *
+   * @implementation Used as a hidden heading or an aria-label on the wrapping element.
    */
-  button: number;
-}
-/**
- * Options for influencing how a programmatic click behaves.
- * @publicDocs
- */
-export interface ClickOptions {
+  accessibilityLabel: Required<ButtonGroupProps$1>['accessibilityLabel'];
   /**
-   * 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.
+   * The spacing between buttons in the group.
+   *
+   * - `base`: Standard spacing that provides clear visual separation between buttons.
+   * - `none`: No spacing, creating a connected button group.
+   *
+   * @default 'base'
    */
-  sourceEvent?: ActivationEventEsque;
+  gap: Required<ButtonGroupProps$1>['gap'];
 }
-/**
- * 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;
+declare class PolarisCustomElement extends PreactCustomElement {
+  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
   /** @private */
   connectedCallback(): void;
   /** @private */
-  disconnectedCallback(): void;
-  /** @private */
   adoptedCallback(): void;
+}
+
+declare abstract class ButtonGroupBase
+  extends PolarisCustomElement
+  implements Pick<ButtonGroupProps, 'gap' | 'accessibilityLabel'>
+{
+  accessor gap: ButtonGroupProps['gap'];
+  accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];
+  constructor(renderImpl: RenderImpl);
   /**
-   * 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.
+   * Actions whose translucent fill can't paint over a seam, so the neighbour
+   * has to be told not to draw it. The foundation resolves the list.
    * @private
-   * @param options
    */
-  click({sourceEvent}?: ClickOptions): void;
+  setInertActions(actions: ReadonlyArray<Element>): void;
+  /** @private */
+  disconnectedCallback(): void;
 }
 
 /**
- * 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 or content that will be rendered inside this element.
+   * The child elements to be rendered within this component.
    */
   children?: preact.ComponentChildren;
 }
 
 /**
- * A button group that arranges multiple buttons together with consistent spacing and semantic grouping for related actions.
+ * Configure the following properties on the button group component.
+ * @publicDocs
  */
-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'];
-
+declare class ButtonGroup extends ButtonGroupBase implements ButtonGroupProps {
   constructor();
 }
 declare global {
@@ -177,28 +152,25 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-button-group';
-
-/**
- * Properties for using the button group component in JSX with React-style props.
- * @publicDocs
- */
 export interface ButtonGroupJSXProps
   extends Partial<ButtonGroupProps>,
     Pick<ButtonGroupProps$1, 'id' | 'children'> {
   /**
-   * The buttons that should be grouped together, provided as Button components.
+   * The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.
    */
   children?: ComponentChildren;
   /**
-   * A single primary action button that's visually emphasized as the most important action in the group.
+   * The main action for this group, displayed with high visual emphasis.
+   * Accepts a single button with `variant="primary"`.
    *
-   * Accepts a single Button element with a `variant` of `primary`. Can't be used when `gap` is set to `none`.
+   * Use this for the primary action you want users to take. This can't be used when `gap="none"`.
    */
   primaryAction?: ComponentChildren;
   /**
-   * One or more secondary action buttons that provide alternative or less prominent actions.
+   * Supporting actions displayed with less emphasis than the primary action.
+   * Accepts one or more button components with `variant="secondary"` or `variant="auto"`.
    *
-   * Accepts Button elements with a `variant` of `secondary` or `auto`.
+   * Use these for alternative or less critical actions.
    */
   secondaryActions?: ComponentChildren;
 }