@shopify/ui-extensions 2026.1.3 → 2026.1.4

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@shopify/ui-extensions",
-  "version": "2026.1.3",
+  "version": "2026.1.4",
   "scripts": {
     "docs:admin": "node ./docs/surfaces/admin/build-docs.mjs",
     "docs:checkout": "bash ./docs/surfaces/checkout/build-docs.sh",
-    "docs:checkout:fast": "bash ./docs/surfaces/checkout/build-docs-fast.sh",
-    "docs:checkout:dev": "bash ./docs/surfaces/checkout/build-docs-watch.sh",
     "docs:point-of-sale": "node ./docs/surfaces/point-of-sale/build-docs.mjs",
     "docs:customer-account": "node ./docs/surfaces/customer-account/build-docs.mjs"
   },
@@ -129,7 +127,7 @@
   ],
   "devDependencies": {
     "@remote-ui/async-subscription": "^2.1.16",
-    "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz",
+    "@shopify/generate-docs": "1.2.2",
     "@quilted/react-testing": "^0.6.11",
     "typescript": "^4.9.0",
     "@faker-js/faker": "^8.4.1",

package/src/shared.ts

@@ -14,22 +14,23 @@ export type ApiVersion =
   | 'unstable'
   | '2025-07'
   | '2025-10'
-  | '2026-01';
+  | '2026-01'
+  | '2026-04';
 
 /**
  * The capabilities an extension has access to.
  *
- * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.
+ * * `api_access`: The extension can access the Storefront API.
  *
- * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.
+ * * `network_access`: The extension can make external network calls.
  *
- * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.
+ * * `block_progress`: The extension can block a buyer's progress and the merchant has allowed this blocking behavior.
  *
- * * [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
+ * * `collect_buyer_consent.sms_marketing`: The extension can collect buyer consent for SMS marketing.
  *
- * * [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register buyer consent decisions that will be honored on Shopify-managed services.
+ * * `collect_buyer_consent.customer_privacy`: The extension can register buyer consent decisions that will be honored on Shopify-managed services.
  *
- * * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.
+ * * `iframe.sources`: The extension can embed an external URL in an iframe.
  */
 
 export type Capability =
@@ -849,9 +850,12 @@ export type CountryCode =
   | 'ZW'
   | 'ZZ';
 
+/**
+ * A buyer's country, identified by its ISO country code.
+ */
 export interface Country {
   /**
-   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. This is the internationally recognized standard for representing countries and territories.
+   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    *
    * @example 'CA' for Canada, 'US' for United States.
    */
@@ -902,7 +906,7 @@ export type LocalizedFieldKey =
   | 'TAX_EMAIL_IT';
 
 /**
- * Union of supported storefront API versions
+ * The supported Storefront API versions. Pass one of these values to `query()` to target a specific API version when querying the Storefront GraphQL API.
  */
 export type StorefrontApiVersion =
   | '2022-04'
@@ -921,9 +925,12 @@ export type StorefrontApiVersion =
   | '2025-07'
   | '2025-10';
 
+/**
+ * A buyer's country, identified by its ISO country code.
+ */
 export interface Country {
   /**
-   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. This is the internationally recognized standard for representing countries and territories.
+   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    *
    * @example 'CA' for Canada, 'US' for United States.
    */
@@ -931,12 +938,24 @@ export interface Country {
 }
 
 /**
- * GraphQL error returned by the Shopify Storefront APIs.
+ * An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.
  */
 export interface GraphQLError {
+  /**
+   * A human-readable description of the error.
+   */
   message: string;
+  /**
+   * Additional error metadata including the request ID and error code.
+   */
   extensions: {
+    /**
+     * The unique identifier for the API request, useful for debugging with Shopify support.
+     */
     requestId: string;
+    /**
+     * A machine-readable error code identifying the type of error.
+     */
     code: string;
   };
 }

package/src/surfaces/admin/api/action/action.ts

@@ -4,6 +4,8 @@ import type {Data} from '../shared';
 
 /**
  * The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.
+ *
+ * @publicDocs
  */
 export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardRenderingExtensionApi<ExtensionTarget> {

package/src/surfaces/admin/api/block/block.ts

@@ -4,6 +4,7 @@ import type {Data} from '../shared';
 
 /**
  * The `Navigation` object provides methods for navigating between extensions and admin pages.
+ * @publicDocs
  */
 export interface Navigation {
   /**
@@ -17,6 +18,8 @@ export interface Navigation {
 
 /**
  * The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.
+ *
+ * @publicDocs
  */
 export interface BlockExtensionApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardRenderingExtensionApi<ExtensionTarget> {

package/src/surfaces/admin/api/checkout-rules/launch-options.ts

@@ -36,6 +36,8 @@ interface ShopifyFunction {
 
 /**
  * The `data` object exposed to validation settings extensions in the `admin.settings.validation.render` target. Use this to access the current validation configuration and populate your settings interface with existing values.
+ *
+ * @publicDocs
  */
 export interface ValidationData {
   /** The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode. */

package/src/surfaces/admin/api/checkout-rules/metafields.ts

@@ -60,6 +60,8 @@ type MetafieldChangeResult =
 
 /**
  * A function that applies metafield changes to validation settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.
+ *
+ * @publicDocs
  */
 export type ApplyMetafieldChange = (
   change: MetafieldChange,

package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts

@@ -4,6 +4,8 @@ import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-target
 
 /**
  * The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.
+ *
+ * @publicDocs
  */
 export interface CustomerSegmentTemplateApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/discount-function-settings/launch-options.ts

@@ -33,6 +33,8 @@ type DiscountMethod = 'automatic' | 'code';
 
 /**
  * The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.
+ *
+ * @publicDocs
  */
 export interface DiscountFunctionSettingsData {
   /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */

package/src/surfaces/admin/api/discount-function-settings/metafields.ts

@@ -60,6 +60,8 @@ type MetafieldChangeResult =
 
 /**
  * A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.
+ *
+ * @publicDocs
  */
 export type ApplyMetafieldChange = (
   change: MetafieldChange,

package/src/surfaces/admin/api/intents/intents.ts

@@ -37,6 +37,8 @@ export interface ErrorIntentResponse {
 
 /**
  * The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.
+ *
+ * @publicDocs
  */
 export type IntentResponse =
   | SuccessIntentResponse
@@ -127,6 +129,8 @@ export interface IntentQuery extends IntentQueryOptions {
  * });
  * const response = await activity.complete;
  * ```
+ *
+ * @publicDocs
  */
 export interface IntentInvokeApi {
   (query: IntentQuery): Promise<IntentActivity>;

package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts

@@ -6,6 +6,8 @@ import {Data} from './data';
 
 /**
  * The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.
+ *
+ * @publicDocs
  */
 export interface OrderRoutingRuleApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardRenderingExtensionApi<ExtensionTarget> {

package/src/surfaces/admin/api/picker/picker.ts

@@ -108,5 +108,7 @@ interface Item {
 
 /**
  * The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.
+ *
+ * @publicDocs
  */
 export type PickerApi = (options: PickerOptions) => Promise<Picker>;

package/src/surfaces/admin/api/print-action/print-action.ts

@@ -4,6 +4,8 @@ import type {Data} from '../shared';
 
 /**
  * The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.
+ *
+ * @publicDocs
  */
 export interface PrintActionExtensionApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts

@@ -65,6 +65,8 @@ export interface ProductComponent {
 
 /**
  * The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.
+ *
+ * @publicDocs
  */
 export interface ProductDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts

@@ -66,6 +66,8 @@ export interface ProductVariantComponent {
 
 /**
  * The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.
+ *
+ * @publicDocs
  */
 export interface ProductVariantDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/purchase-options-card-action.ts

@@ -3,6 +3,8 @@ import type {ExtensionTarget as AnyExtensionTarget} from '../extension-targets';
 
 /**
  * The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.
+ *
+ * @publicDocs
  */
 export interface PurchaseOptionsCardConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/resource-picker/resource-picker.ts

@@ -323,8 +323,10 @@ type WithSelection<T> = T & {
 
 /**
  * The payload returned when resources are selected from the picker.
+ *
+ * @publicDocs
  */
-type SelectPayload<Type extends keyof ResourceTypes> = WithSelection<
+export type SelectPayload<Type extends keyof ResourceTypes> = WithSelection<
   ResourceSelection<Type>[]
 >;
 
@@ -360,6 +362,8 @@ interface Filters {
 
 /**
  * The `ResourcePickerOptions` object defines how the resource picker behaves, including which resource type to display, selection limits, filters, and preselected items. Access the following properties on the `ResourcePickerOptions` object to configure the resource picker's appearance and functionality.
+ *
+ * @publicDocs
  */
 export interface ResourcePickerOptions {
   /**
@@ -394,6 +398,8 @@ export interface ResourcePickerOptions {
 
 /**
  * Opens the resource picker modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.
+ *
+ * @publicDocs
  */
 export type ResourcePickerApi = (
   options: ResourcePickerOptions,

package/src/surfaces/admin/api/should-render/should-render.ts

@@ -12,6 +12,8 @@ export interface ShouldRenderOutput {
 
 /**
  * The `ShouldRenderApi` object provides methods for controlling action extension visibility. Access the following properties on the `ShouldRenderApi` object to determine whether an associated action should appear based on the current context.
+ *
+ * @publicDocs
  */
 export interface ShouldRenderApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardApi<ExtensionTarget> {

package/src/surfaces/admin/api/standard/standard.ts

@@ -37,6 +37,8 @@ interface Auth {
 
 /**
  * The `StandardApi` object provides core methods available to all extension targets. Access the following properties on the `StandardApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, and persist data.
+ *
+ * @publicDocs
  */
 export interface StandardApi<ExtensionTarget extends AnyExtensionTarget> {
   /**

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

@@ -9,6 +9,7 @@ import type {ComponentChildren, AdminActionProps$1} from './shared.d.ts';
 
 /**
  * The properties for the admin action component. These properties configure the heading and loading state of the admin action extension interface.
+ * @publicDocs
  */
 export interface AdminActionProps
   extends Pick<AdminActionProps$1, 'heading' | 'loading'> {}
@@ -17,6 +18,7 @@ declare const tagName = 's-admin-action';
 
 /**
  * The JSX props for the admin action component. These properties extend `AdminActionProps` with slots for primary and secondary action buttons that merchants can interact with.
+ * @publicDocs
  */
 export interface AdminActionJSXProps
   extends Partial<AdminActionProps>,
@@ -33,10 +35,12 @@ export interface AdminActionJSXProps
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -50,6 +54,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -71,6 +76,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -161,4 +167,7 @@ declare module 'preact' {
 }
 
 export {AdminAction};
+/**
+ * @publicDocs
+ */
 export type {AdminActionJSXProps};

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

@@ -9,6 +9,7 @@ import type {AdminBlockProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the admin block component. These properties configure the heading and collapsed summary of collapsible content blocks in the admin interface.
+ * @publicDocs
  */
 export interface AdminBlockProps
   extends Pick<AdminBlockProps$1, 'heading' | 'collapsedSummary'> {}
@@ -17,6 +18,7 @@ declare const tagName = 's-admin-block';
 
 /**
  * The JSX props for the admin block component. These properties extend `AdminBlockProps` with an optional `id` for element identification in JSX rendering.
+ * @publicDocs
  */
 export interface AdminBlockJSXProps
   extends Partial<AdminBlockProps>,
@@ -24,10 +26,12 @@ export interface AdminBlockJSXProps
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -41,6 +45,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -62,6 +67,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -147,4 +153,7 @@ declare module 'preact' {
 }
 
 export {AdminBlock};
+/**
+ * @publicDocs
+ */
 export type {AdminBlockJSXProps};

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

@@ -9,6 +9,7 @@ import type {AdminPrintActionProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the admin print action component. These properties configure the source URL for printing content within admin extensions.
+ * @publicDocs
  */
 export interface AdminPrintActionProps
   extends Pick<AdminPrintActionProps$1, 'src'> {}
@@ -17,6 +18,7 @@ declare const tagName = 's-admin-print-action';
 
 /**
  * The JSX props for the admin print action component. These properties extend `AdminPrintActionProps` with an optional `id` for element identification in JSX rendering.
+ * @publicDocs
  */
 export interface AdminPrintActionJSXProps
   extends Partial<AdminPrintActionProps>,
@@ -24,10 +26,12 @@ export interface AdminPrintActionJSXProps
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -41,6 +45,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -62,6 +67,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -142,4 +148,7 @@ declare module 'preact' {
 }
 
 export {AdminPrintAction};
+/**
+ * @publicDocs
+ */
 export type {AdminPrintActionJSXProps};

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

@@ -10,6 +10,7 @@ import type {AvatarProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the avatar component. An avatar displays a user or entity image with fallback initials when the image isn't available. Properties include `src` for the image URL, `initials` for the fallback text, `alt` for accessibility text, and `size` for controlling the avatar dimensions.
+ * @publicDocs
  */
 export interface AvatarProps
   extends Required<Pick<AvatarProps$1, 'initials' | 'src' | 'alt' | 'size'>> {
@@ -38,10 +39,12 @@ export interface AvatarProps
 
 /**
  * A string containing CSS styles for a custom element.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The configuration for rendering a custom element with Preact.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -55,6 +58,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -76,6 +80,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for triggering a synthetic click event.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -131,6 +136,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * A callback event that's typed to a specific HTML element.
+ * @publicDocs
  */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
   /**
@@ -140,6 +146,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
 };
 /**
  * An event listener for callback events, typed to a specific HTML element.
+ * @publicDocs
  */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
@@ -148,6 +155,7 @@ 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.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -210,6 +218,7 @@ declare module 'preact' {
 declare const tagName = 's-avatar';
 /**
  * The properties for the avatar component when it's used in JSX.
+ * @publicDocs
  */
 export interface AvatarJSXProps
   extends Partial<AvatarProps>,
@@ -225,4 +234,7 @@ export interface AvatarJSXProps
 }
 
 export {Avatar};
+/**
+ * @publicDocs
+ */
 export type {AvatarJSXProps};

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

@@ -15,6 +15,7 @@ import type {
 
 /**
  * The configuration for icons used within Badge components. Defines the visual appearance, size, and semantic meaning of icons displayed in badges.
+ * @publicDocs
  */
 export interface IconProps
   extends Pick<
@@ -61,6 +62,7 @@ export interface IconProps
 
 /**
  * The properties for the badge component. Badges display status information through compact visual indicators with customizable tones, sizes, and optional icons.
+ * @publicDocs
  */
 export interface BadgeProps
   extends Pick<BadgeProps$1, 'color' | 'icon' | 'size' | 'tone'> {
@@ -107,10 +109,12 @@ export interface BadgeProps
 
 /**
  * The CSS styles as a string, used for styling web components within their shadow DOM.
+ * @publicDocs
  */
 export type Styles = string;
 /**
  * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ * @publicDocs
  */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
   /**
@@ -124,6 +128,7 @@ export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
 };
 /**
  * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ * @publicDocs
  */
 export interface ActivationEventEsque {
   /**
@@ -145,6 +150,7 @@ export interface ActivationEventEsque {
 }
 /**
  * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ * @publicDocs
  */
 export interface ClickOptions {
   /**
@@ -197,6 +203,7 @@ declare abstract class PreactCustomElement extends BaseClass {
 
 /**
  * The base properties for Preact elements without children. Provides key, ref, and slot properties for element identification, DOM access, and slot-based positioning.
+ * @publicDocs
  */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
   /**
@@ -214,6 +221,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 }
 /**
  * The base properties for Preact elements with children. Extends `PreactBaseElementProps` with the ability to render child elements.
+ * @publicDocs
  */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
@@ -261,6 +269,7 @@ declare module 'preact' {
 declare const tagName = 's-badge';
 /**
  * The JSX props for the badge component. These properties extend `BadgeProps` with an optional `id` and `children` for rendering badge content in JSX.
+ * @publicDocs
  */
 export interface BadgeJSXProps
   extends Partial<BadgeProps>,
@@ -272,4 +281,7 @@ export interface BadgeJSXProps
 }
 
 export {Badge};
+/**
+ * @publicDocs
+ */
 export type {BadgeJSXProps};