@shopify/ui-extensions 2025.10.13 → 2025.10.14

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

@@ -8,6 +8,9 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, TextProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the text component. These properties define inline or small blocks of text content with various visual styles and semantic meanings.
+ */
 export interface TextProps
   extends Required<
     Pick<
@@ -21,35 +24,102 @@ export interface TextProps
       | 'interestFor'
     >
   > {
+  /**
+   * The color of the text. Available options:
+   * - `'base'` - The default text color.
+   * - `'subdued'` - A lighter text color for secondary information.
+   */
   color: Extract<TextProps$1['color'], 'base' | 'subdued'>;
+  /**
+   * The semantic type and styling treatment for the text content.
+   *
+   * Other presentation properties on Text override the default styling.
+   *
+   * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
+   * - `generic`: Standard text with no special semantic meaning or styling.
+   * - `address`: Marks the text as contact information, such as a physical or email address.
+   * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.
+   *
+   * @default 'generic'
+   */
   type: Extract<
     TextProps$1['type'],
-    'address' | 'redundant' | 'strong' | 'generic'
+    'strong' | 'generic' | 'address' | 'redundant'
   >;
+  /**
+   * The semantic tone that's applied to the 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).
+   * - `auto`: Automatically determined based on context.
+   * - `neutral`: General information without specific intent (gray).
+   * - `caution`: Advisory notices that need attention (yellow).
+   *
+   * @default 'auto'
+   */
   tone: Extract<
     TextProps$1['tone'],
-    'auto' | 'info' | 'success' | 'warning' | 'critical' | 'neutral' | 'caution'
+    'info' | 'success' | 'warning' | 'critical' | 'auto' | 'neutral' | 'caution'
   >;
+  /**
+   * The numeric font variant for the text. Available options:
+   * - `'auto'` - The font variant is automatically determined.
+   * - `'normal'` - Standard numeric rendering.
+   * - `'tabular-nums'` - Monospaced numbers for better alignment in tables.
+   */
   fontVariantNumeric: Extract<
     TextProps$1['fontVariantNumeric'],
     'auto' | 'normal' | 'tabular-nums'
   >;
 }
 
+/**
+ * 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 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;
 }
@@ -96,28 +166,75 @@ declare abstract class PreactCustomElement extends BaseClass {
   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> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A custom element for displaying inline or small blocks of text with various visual styles and semantic meanings. Use Text to render short pieces of content with appropriate styling, emphasis, and color treatment.
+ */
 declare class Text extends PreactCustomElement implements TextProps {
+  /**
+   * The numeric font variant for the text.
+   */
   accessor fontVariantNumeric: TextProps['fontVariantNumeric'];
+  /**
+   * The color of the text.
+   */
   accessor color: TextProps['color'];
+  /**
+   * The semantic tone that's applied to the 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).
+   * - `auto`: Automatically determined based on context.
+   * - `neutral`: General information without specific intent (gray).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
   accessor tone: TextProps['tone'];
+  /**
+   * The semantic type and styling treatment for the text content.
+   *
+   * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
+   * - `generic`: Standard text with no special semantic meaning or styling.
+   * - `address`: Marks the text as contact information, such as a physical or email address.
+   * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.
+   */
   accessor type: TextProps['type'];
+  /**
+   * The text direction (left-to-right or right-to-left).
+   */
   accessor dir: TextProps['dir'];
+  /**
+   * The visibility of the element to assistive technologies.
+   */
   accessor accessibilityVisibility: TextProps['accessibilityVisibility'];
+  /**
+   * The ID of an element this text provides contextual information for.
+   */
   accessor interestFor: string;
   constructor();
 }
@@ -135,11 +252,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-text';
+/**
+ * The JSX properties for the text component. These properties define how text is rendered in Preact or JSX.
+ */
 export interface TextJSXProps
   extends Partial<TextProps>,
     Pick<TextProps$1, 'id' | 'children'> {
   /**
-   * The content of the Text.
+   * The content of the text.
    */
   children?: ComponentChildren;
 }

package/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html

@@ -0,0 +1,15 @@
+<s-stack gap="base">
+  <s-text-area
+    label="Order notes"
+    value="Customer requested gift wrapping."
+    readOnly
+    rows="2"
+  ></s-text-area>
+
+  <s-text-area
+    label="Internal comments"
+    value="Pending review by fulfillment team."
+    disabled
+    rows="2"
+  ></s-text-area>
+</s-stack>

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

@@ -12,44 +12,106 @@ import type {
   ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * An event with a strongly-typed currentTarget property for a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event listener is attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * A callback function that receives a strongly-typed event for a specific HTML element.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
+/**
+ * The React-style event callback props for form field components.
+ */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
+  /**
+   * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
+   */
   onInput?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
+   */
   onChange?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
+   */
   onFocus?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
+   */
   onBlur?: ((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>;
 }
 
+/**
+ * A string containing CSS styles for the component's shadow DOM.
+ */
 export type Styles = string;
+/**
+ * The configuration for rendering a Preact component in a shadow root.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's Preact elements into the shadow root.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the shadow root.
+   */
   styles?: Styles;
 };
+/**
+ * The properties from an event that indicate how the user activated an element.
+ */
 export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down when the event occurred.
+   */
   shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on macOS) was held down when the event occurred.
+   */
   metaKey: boolean;
+  /**
+   * Whether the Control key was held down when the event occurred.
+   */
   ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right).
+   */
   button: number;
 }
+/**
+ * The options for influencing a programmatic click event.
+ */
 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;
 }
@@ -97,9 +159,13 @@ declare abstract class PreactCustomElement extends BaseClass {
 }
 
 declare const internals: unique symbol;
+/**
+ * The base properties for an input element that participates in form submission.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/** @private */
 declare class PreactInputElement
   extends PreactCustomElement
   implements PreactInputProps
@@ -107,16 +173,39 @@ declare class PreactInputElement
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the user makes any changes in the field.
+   */
   accessor oninput: CallbackEventListener<'input'>;
+  /**
+   * Whether the field is disabled, disallowing any interaction.
+   *
+   * @default false
+   */
   accessor disabled: PreactInputProps['disabled'];
+  /**
+   * An identifier for the field.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * An identifier for the field that's unique within the nearest containing form.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value for the field.
+   */
   get value(): PreactInputProps['value'];
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The base properties for form field elements that support labels, validation, and autocomplete.
+ */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
     Required<
@@ -136,10 +225,10 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        * A hint as to the intended content of the field.
        *
        * When set to `on` (the default), this property indicates that the field should support
-       * autofill, but you do not have any more semantic information on the intended
+       * autofill, but you don't have any more semantic information on the intended
        * contents.
        *
-       * When set to `off`, you are indicating that this field contains sensitive
+       * When set to `off`, you're indicating that this field contains sensitive
        * information, or contents that are never saved, like one-time codes.
        *
        * Alternatively, you can provide value which describes the
@@ -154,20 +243,58 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        */
       autocomplete: Autocomplete;
     };
+/** @private */
 declare class PreactFieldElement<Autocomplete extends string = string>
   extends PreactInputElement
   implements PreactFieldProps<Autocomplete>
 {
+  /**
+   * A callback that's invoked when the field loses focus.
+   */
   accessor onblur: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the field receives focus.
+   */
   accessor onfocus: CallbackEventListener<'input'>;
+  /**
+   * A hint as to the intended content of the field for autocomplete purposes.
+   */
   accessor autocomplete: PreactFieldProps<Autocomplete>['autocomplete'];
+  /**
+   * The initial value for the field when it's first rendered.
+   */
   accessor defaultValue: PreactFieldProps['defaultValue'];
+  /**
+   * Additional descriptive text to display below the field that provides supplementary information.
+   */
   accessor details: PreactFieldProps['details'];
+  /**
+   * An error message to display below the field, indicating validation failure or other issues.
+   */
   accessor error: PreactFieldProps['error'];
+  /**
+   * The text label to display for the field, describing what the user should enter.
+   */
   accessor label: PreactFieldProps['label'];
+  /**
+   * Controls the visibility of the label for accessibility purposes.
+   */
   accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility'];
+  /**
+   * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input.
+   */
   accessor placeholder: PreactFieldProps['placeholder'];
+  /**
+   * Whether the field is read-only, preventing edits while still allowing focus and selection.
+   *
+   * @default false
+   */
   accessor readOnly: PreactFieldProps['readOnly'];
+  /**
+   * Whether the field must be filled out before form submission.
+   *
+   * @default false
+   */
   accessor required: PreactFieldProps['required'];
   /**
    * Global keyboard event handlers for things like key bindings typically
@@ -196,18 +323,38 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The properties for the text area component. These properties configure a multi-line text input field that allows merchants to enter and edit longer text content.
+ */
 export type TextAreaProps = PreactFieldProps<
   Required<TextAreaProps$1>['autocomplete']
 > &
   Required<Pick<TextAreaProps$1, 'maxLength' | 'minLength' | 'rows'>>;
 
+/**
+ * The text area custom element class that renders a multi-line text input field in the Shopify admin interface. This component allows merchants to enter and edit longer text content with support for labels, validation, and length constraints.
+ */
 declare class TextArea
   extends PreactFieldElement<TextAreaProps['autocomplete']>
   implements TextAreaProps
 {
+  /**
+   * The maximum number of characters the user can enter in the field.
+   */
   accessor maxLength: TextAreaProps['maxLength'];
+  /**
+   * The minimum number of characters required in the field for validation.
+   */
   accessor minLength: TextAreaProps['minLength'];
+  /**
+   * The number of visible text lines for the field, controlling its initial height.
+   */
   accessor rows: TextAreaProps['rows'];
+  /**
+   * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.
+   */
+  get value(): string;
+  set value(value: string);
   constructor();
 }
 declare global {
@@ -224,6 +371,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-text-area';
+/**
+ * The JSX props for the text area component. These properties extend `TextAreaProps` with JSX-specific event callbacks for React-style event handling.
+ */
 export interface TextAreaJSXProps
   extends Partial<TextAreaProps>,
     Pick<TextAreaProps$1, 'id'>,

package/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html

@@ -0,0 +1,13 @@
+<s-stack gap="base">
+  <s-text-field
+    label="Store URL"
+    value="my-store.myshopify.com"
+    readOnly
+  ></s-text-field>
+
+  <s-text-field
+    label="Account ID"
+    value="acct_12345"
+    disabled
+  ></s-text-field>
+</s-stack>