From 0354e24f75a3db56d4ecb89159b90db64334c64b Mon Sep 17 00:00:00 2001 From: Stephanie Ordaz Date: Tue, 1 Sep 2026 08:22:50 -0500 Subject: [PATCH] fix(admin): use field-generic wording for details/error prop docs Backport of fe157df48 (#4662) to 2026-04. The shared `FieldDetailsProps.details` and `FieldErrorProps.error` JSDoc was written for `checkbox` and is inherited by every Admin and App Home form component, where it reads incorrectly. Replace it with field-generic wording and update the generated docs data to match. Fixes shop/issues-learn#2959 Co-Authored-By: Claude Opus 5 (1M context) --- .../2026-04/generated_docs_data_v2.json | 80 +++++++++---------- .../app_home/generated_docs_data_v2.json | 80 +++++++++---------- .../src/surfaces/admin/components.d.ts | 8 +- 3 files changed, 84 insertions(+), 84 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-04/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-04/generated_docs_data_v2.json index 42e03bfca1..ac8cb3d062 100644 --- a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-04/generated_docs_data_v2.json +++ b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-04/generated_docs_data_v2.json @@ -2567,14 +2567,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -2903,14 +2903,14 @@ "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -3547,14 +3547,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -3893,14 +3893,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -4283,7 +4283,7 @@ "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -4564,14 +4564,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -6209,14 +6209,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -6460,14 +6460,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7051,14 +7051,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7355,14 +7355,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7642,14 +7642,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -8260,14 +8260,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9118,14 +9118,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9361,14 +9361,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9828,14 +9828,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -14886,11 +14886,11 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true } ], - "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the checkbox to indicate validation problems.\n * When set, the checkbox is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" + "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the field to indicate validation problems.\n * When set, the field is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" } }, "BasicFieldProps": { @@ -14905,7 +14905,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -14950,11 +14950,11 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true } ], - "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the checkbox to provide additional context, instructions, or help.\n * Use this to explain what checking the box means or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" + "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the field to provide additional context, instructions, or help.\n * Use this to clarify the expected input or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" } }, "FieldProps": { @@ -14977,7 +14977,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -14994,7 +14994,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -15103,7 +15103,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -15120,7 +15120,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -19035,7 +19035,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -19052,7 +19052,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json index 42e03bfca1..ac8cb3d062 100644 --- a/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json +++ b/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json @@ -2567,14 +2567,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -2903,14 +2903,14 @@ "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -3547,14 +3547,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -3893,14 +3893,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -4283,7 +4283,7 @@ "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -4564,14 +4564,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -6209,14 +6209,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -6460,14 +6460,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7051,14 +7051,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7355,14 +7355,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -7642,14 +7642,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -8260,14 +8260,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9118,14 +9118,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9361,14 +9361,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -9828,14 +9828,14 @@ "syntaxKind": "PropertyDeclaration", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers." + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", "syntaxKind": "PropertyDeclaration", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers." + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers." }, { "filePath": "src/surfaces/admin/components.ts", @@ -14886,11 +14886,11 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true } ], - "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the checkbox to indicate validation problems.\n * When set, the checkbox is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" + "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the field to indicate validation problems.\n * When set, the field is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" } }, "BasicFieldProps": { @@ -14905,7 +14905,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -14950,11 +14950,11 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true } ], - "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the checkbox to provide additional context, instructions, or help.\n * Use this to explain what checking the box means or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" + "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the field to provide additional context, instructions, or help.\n * Use this to clarify the expected input or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" } }, "FieldProps": { @@ -14977,7 +14977,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -14994,7 +14994,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -15103,7 +15103,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -15120,7 +15120,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -19035,7 +19035,7 @@ "syntaxKind": "PropertySignature", "name": "details", "value": "string", - "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "description": "Supplementary text displayed below the field to provide additional context, instructions, or help. Use this to clarify the expected input or provide guidance to users. This text is announced to screen readers.", "isOptional": true }, { @@ -19052,7 +19052,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { diff --git a/packages/ui-extensions/src/surfaces/admin/components.d.ts b/packages/ui-extensions/src/surfaces/admin/components.d.ts index 2d30ce7788..69a70c091f 100644 --- a/packages/ui-extensions/src/surfaces/admin/components.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components.d.ts @@ -1864,8 +1864,8 @@ export interface FileInputProps extends BaseInputProps { /** @publicDocs */ export interface FieldErrorProps { /** - * An error message displayed below the checkbox to indicate validation problems. - * When set, the checkbox is styled with error indicators and the message is announced to screen readers. + * An error message displayed below the field to indicate validation problems. + * When set, the field is styled with error indicators and the message is announced to screen readers. */ error?: string; } @@ -1888,8 +1888,8 @@ export interface BasicFieldProps /** @publicDocs */ export interface FieldDetailsProps { /** - * Supplementary text displayed below the checkbox to provide additional context, instructions, or help. - * Use this to explain what checking the box means or provide guidance to users. + * Supplementary text displayed below the field to provide additional context, instructions, or help. + * Use this to clarify the expected input or provide guidance to users. * This text is announced to screen readers. */ details?: string;