diff --git a/pages/funnel-analytics/static-single-page-flow.page.tsx b/pages/funnel-analytics/static-single-page-flow.page.tsx index c7bb546f9d..d1021394f1 100644 --- 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() { > Learn more diff --git a/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap b/src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap index 232dab3cf7..eb99e091bb 100644 --- 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 index 75b441eb28..8e5f604fad 100644 --- 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 index b670ba6376..6ea01071a5 100644 --- 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, });