chore: Make FormField analyticsMetadata public (#3255)

cloudscape-design · Feb 6, 2025 · 03d0574 · 03d0574
1 parent 0905da2
commit 03d0574
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/pages/funnel-analytics/static-single-page-flow.page.tsx b/pages/funnel-analytics/static-single-page-flow.page.tsx
@@ -147,6 +147,9 @@ export default function StaticSinglePageCreatePage() {
               >
                 <SpaceBetween size="s">
                   <FormField
+                    analyticsMetadata={{
+                      instanceIdentifier: 'field1',
+                    }}
                     info={
                       <Link data-testid="external-link" external={true} href="#">
                         Learn more

diff --git a/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap b/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap
@@ -8513,6 +8513,25 @@ exports[`Documenter definition for form-field matches the snapshot: form-field 1
   "functions": [],
   "name": "FormField",
   "properties": [
+    {
+      "analyticsTag": "",
+      "description": "Specifies additional analytics-related metadata.
+* \`instanceIdentifier\` - A unique string that identifies this component instance in your application.",
+      "inlineType": {
+        "name": "FormFieldProps.AnalyticsMetadata",
+        "properties": [
+          {
+            "name": "instanceIdentifier",
+            "optional": true,
+            "type": "string",
+          },
+        ],
+        "type": "object",
+      },
+      "name": "analyticsMetadata",
+      "optional": true,
+      "type": "FormFieldProps.AnalyticsMetadata",
+    },
     {
       "deprecatedTag": "Custom CSS is not supported. For testing and other use cases, use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes).",
       "description": "Adds the specified classes to the root element of the component.",

diff --git a/src/form-field/interfaces.ts b/src/form-field/interfaces.ts
@@ -79,9 +79,20 @@ export interface FormFieldProps extends BaseComponentProps {
    * non-empty string, it will render the form field in a warning state.
    */
   warningText?: React.ReactNode;
+
+  /**
+   * Specifies additional analytics-related metadata.
+   * * `instanceIdentifier` - A unique string that identifies this component instance in your application.
+   * @analytics
+   */
+  analyticsMetadata?: FormFieldProps.AnalyticsMetadata;
 }
 
 export namespace FormFieldProps {
+  export interface AnalyticsMetadata {
+    instanceIdentifier?: string;
+  }
+
   export interface I18nStrings {
     /**
      * Provides a text alternative for the error icon in the error message.

diff --git a/src/internal/analytics/__integ__/static-single-page-flow.test.ts b/src/internal/analytics/__integ__/static-single-page-flow.test.ts
@@ -325,7 +325,7 @@ describe.each(['refresh', 'refresh-toolbar'] as Theme[])('%s', theme => {
         stepNumber: 1,
         subStepName: 'Container 1 - header',
         fieldErrorContext: null,
-        fieldIdentifier: null,
+        fieldIdentifier: 'field1',
         subStepErrorContext: null,
       });