updated api-docs

Author: pan-kot

src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+// Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Components definition for alert matches the snapshot: alert 1`] = `
 {
@@ -11373,19 +11373,24 @@ exports[`Components definition for error-boundary matches the snapshot: error-bo
   "name": "ErrorBoundary",
   "properties": [
     {
-      "description": "Optional error boundary identifier that is passed as detail to the \`onError\` callback.
-The content passed to the error boundary is wrapped in a div with \`data-awsui-boundary-id={errorBoundaryId}\`.",
+      "description": "Optional identifier for the error boundary instance.
+
+When provided, the identifier is included in the \`onError\` callback payload.
+In the rendered output, the boundary wraps its content in a \`<div>\` with the
+attribute \`data-awsui-boundary-id={errorBoundaryId}\` to support debugging.",
       "name": "errorBoundaryId",
       "optional": true,
       "type": "string",
     },
     {
-      "description": "An object containing all the localized strings required by the component:
-* \`headerText\` (string): The text of the fallback message header.
-* \`descriptionText\` (string): The text of the fallback message description. You can inject inline feedback action
-here by providing \`components.Feedback\`, and using <Feedback>custom text</Feedback> pseudo-tag in the text.
-* \`refreshActionText\` (string): The text of the default refresh action button.
-* \`components.Feedback\` (React.ComponentType<I18nFeedbackProps>): The inline action to be injected into the description text.",
+      "description": "Localized strings and components used in the fallback UI.
+
+* \`headerText\` (string): Header text displayed in the fallback view.
+* \`descriptionText\` (string): Description text displayed in the fallback view. Supports embedding inline
+  feedback actions by including \`<Feedback>\` pseudo-tags when \`components.Feedback\` is provided.
+* \`refreshActionText\` (string): Text for the default refresh action button.
+* \`components.Feedback\` (React.ComponentType<I18nFeedbackProps>): A component used to render
+  inline feedback actions within the description text.",
       "i18nTag": true,
       "inlineType": {
         "name": "ErrorBoundaryProps.I18nStrings",
@@ -11437,11 +11442,13 @@ here by providing \`components.Feedback\`, and using <Feedback>custom text</Feed
       "type": "ErrorBoundaryProps.I18nStrings",
     },
     {
-      "description": "This function is invoked when an error is captured. Use it to report errors for telemetry.
-The detail include:
-* \`error\` (Error) - the error object.
-* \`errorInfo\` (React.ErrorInfo) - additional error meta-information from React.
-* \`errorBoundaryId\` (optional, string) - the \`errorBoundaryId\` if defined.",
+      "description": "Callback invoked when an error is intercepted by the boundary.
+Use this function to record, log, or report errors (for example, to telemetry or monitoring systems).
+
+The callback receives a \`detail\` object containing:
+* \`error\` (Error): The thrown error instance.
+* \`errorInfo\` (React.ErrorInfo): Additional metadata captured by React.
+* \`errorBoundaryId\` (optional, string): The boundary identifier, if defined.",
       "inlineType": {
         "name": "(detail: ErrorBoundaryProps.OnErrorDetail) => void",
         "parameters": [
@@ -11458,10 +11465,14 @@ The detail include:
       "type": "(detail: ErrorBoundaryProps.OnErrorDetail) => void",
     },
     {
-      "description": "Custom render function for the fallback message. It takes the default i18n slots as input, including:
-* \`header\` (ReactNode) - the fallback header taken from the definition or i18n.
-* \`description\` (ReactNode) - the fallback description taken from the definition or i18n.
-* \`action\` (ReactNode) - the fallback action taken from the definition or default refresh action.",
+      "description": "Optional custom renderer for the fallback UI displayed when an error occurs.
+
+The function receives the default slots derived from i18n configuration:
+* \`header\` (ReactNode): The fallback header text.
+* \`description\` (ReactNode): The fallback description text.
+* \`action\` (ReactNode): The fallback action element (a refresh button by default).
+
+Return a React node to fully override the default fallback presentation.",
       "inlineType": {
         "name": "(props: ErrorBoundaryProps.FallbackProps) => React.ReactNode",
         "parameters": [
@@ -11479,20 +11490,23 @@ The detail include:
     },
     {
       "defaultValue": "false",
-      "description": "Some components including app layout, container, modal, and more have built-in error boundaries.
-They activate when there is an error boundary component up in the hierarchy. When active, they will
-use the configuration of the closest error boundary up in the hierarchy.
+      "description": "Controls how nested error boundaries behave.
+
+Several components—such as app layout, container, and modal include built-in
+error boundaries. These boundaries activate automatically when they detect
+an ancestor boundary, inheriting configuration from the closest one.
 
-The nested error boundaries, built-in and standalone can be deactivated by using \`suppressNested=true\`. In that
-case, any error originating from the error boundary content will be captured by this error boundary.",
+When \`suppressNested\` is set to \`true\`, nested built-in or standalone
+boundaries are disabled. In this mode, all errors originating from within
+the boundary’s content are captured exclusively by this boundary.",
       "name": "suppressNested",
       "optional": true,
       "type": "boolean",
     },
   ],
   "regions": [
     {
-      "description": "Content rendered when no error is captured.",
+      "description": "Child content rendered when no error has been captured.",
       "isDefault": true,
       "name": "children",
     },

src/error-boundary/interfaces.ts

@@ -5,51 +5,66 @@ import { ErrorInfo } from 'react';
 
 export interface ErrorBoundaryProps {
   /**
-   * Optional error boundary identifier that is passed as detail to the `onError` callback.
-   * The content passed to the error boundary is wrapped in a div with `data-awsui-boundary-id={errorBoundaryId}`.
+   * Optional identifier for the error boundary instance.
+   *
+   * When provided, the identifier is included in the `onError` callback payload.
+   * In the rendered output, the boundary wraps its content in a `<div>` with the
+   * attribute `data-awsui-boundary-id={errorBoundaryId}` to support debugging.
    */
   errorBoundaryId?: string;
 
   /**
-   * This function is invoked when an error is captured. Use it to report errors for telemetry.
-   * The detail include:
-   * * `error` (Error) - the error object.
-   * * `errorInfo` (React.ErrorInfo) - additional error meta-information from React.
-   * * `errorBoundaryId` (optional, string) - the `errorBoundaryId` if defined.
+   * Callback invoked when an error is intercepted by the boundary.
+   * Use this function to record, log, or report errors (for example, to telemetry or monitoring systems).
+   *
+   * The callback receives a `detail` object containing:
+   * * `error` (Error): The thrown error instance.
+   * * `errorInfo` (React.ErrorInfo): Additional metadata captured by React.
+   * * `errorBoundaryId` (optional, string): The boundary identifier, if defined.
    */
   onError: (detail: ErrorBoundaryProps.OnErrorDetail) => void;
 
   /**
-   * Some components including app layout, container, modal, and more have built-in error boundaries.
-   * They activate when there is an error boundary component up in the hierarchy. When active, they will
-   * use the configuration of the closest error boundary up in the hierarchy.
+   * Controls how nested error boundaries behave.
    *
-   * The nested error boundaries, built-in and standalone can be deactivated by using `suppressNested=true`. In that
-   * case, any error originating from the error boundary content will be captured by this error boundary.
+   * Several components—such as app layout, container, and modal include built-in
+   * error boundaries. These boundaries activate automatically when they detect
+   * an ancestor boundary, inheriting configuration from the closest one.
+   *
+   * When `suppressNested` is set to `true`, nested built-in or standalone
+   * boundaries are disabled. In this mode, all errors originating from within
+   * the boundary’s content are captured exclusively by this boundary.
    */
   suppressNested?: boolean;
 
   /**
-   * Custom render function for the fallback message. It takes the default i18n slots as input, including:
-   * * `header` (ReactNode) - the fallback header taken from the definition or i18n.
-   * * `description` (ReactNode) - the fallback description taken from the definition or i18n.
-   * * `action` (ReactNode) - the fallback action taken from the definition or default refresh action.
+   * Optional custom renderer for the fallback UI displayed when an error occurs.
+   *
+   * The function receives the default slots derived from i18n configuration:
+   * * `header` (ReactNode): The fallback header text.
+   * * `description` (ReactNode): The fallback description text.
+   * * `action` (ReactNode): The fallback action element (a refresh button by default).
+   *
+   * Return a React node to fully override the default fallback presentation.
    */
   renderFallback?: (props: ErrorBoundaryProps.FallbackProps) => React.ReactNode;
 
   /**
-   * An object containing all the localized strings required by the component:
-   * * `headerText` (string): The text of the fallback message header.
-   * * `descriptionText` (string): The text of the fallback message description. You can inject inline feedback action
-   * here by providing `components.Feedback`, and using <Feedback>custom text</Feedback> pseudo-tag in the text.
-   * * `refreshActionText` (string): The text of the default refresh action button.
-   * * `components.Feedback` (React.ComponentType<I18nFeedbackProps>): The inline action to be injected into the description text.
+   * Localized strings and components used in the fallback UI.
+   *
+   * * `headerText` (string): Header text displayed in the fallback view.
+   * * `descriptionText` (string): Description text displayed in the fallback view. Supports embedding inline
+   *   feedback actions by including `<Feedback>` pseudo-tags when `components.Feedback` is provided.
+   * * `refreshActionText` (string): Text for the default refresh action button.
+   * * `components.Feedback` (React.ComponentType<I18nFeedbackProps>): A component used to render
+   *   inline feedback actions within the description text.
+   *
    * @i18n
    */
   i18nStrings?: ErrorBoundaryProps.I18nStrings;
 
   /**
-   * Content rendered when no error is captured.
+   * Child content rendered when no error has been captured.
    */
   children: React.ReactNode;
 }