From a973dbf7046e0e82697aa9543249d294d2fd6eab Mon Sep 17 00:00:00 2001 From: Stephanie Ordaz Date: Tue, 1 Sep 2026 08:23:12 -0500 Subject: [PATCH] fix(admin): use field-generic wording for details/error prop docs Backport of fe157df48 (#4662) to 2026-01. 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-01/generated_docs_data_v2.json | 62 +++++++++---------- .../app_home/generated_docs_data_v2.json | 62 +++++++++---------- .../src/surfaces/admin/components.d.ts | 8 +-- 3 files changed, 66 insertions(+), 66 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json index e418ff393b..d7d8e22b0c 100644 --- a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json +++ b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-01/generated_docs_data_v2.json @@ -2449,14 +2449,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", @@ -2785,14 +2785,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", @@ -3429,14 +3429,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", @@ -3775,14 +3775,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", @@ -4165,7 +4165,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", @@ -4446,14 +4446,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", @@ -6091,14 +6091,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", @@ -6342,14 +6342,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", @@ -6933,14 +6933,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", @@ -7237,14 +7237,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", @@ -7524,14 +7524,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", @@ -8142,14 +8142,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", @@ -9000,14 +9000,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", @@ -9243,14 +9243,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", @@ -9710,14 +9710,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", @@ -15287,7 +15287,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 }, { @@ -15304,7 +15304,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 16ac7a5e4c..15e9bc1a41 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 @@ -6433,14 +6433,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", @@ -6769,14 +6769,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", @@ -7413,14 +7413,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", @@ -7759,14 +7759,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", @@ -8149,7 +8149,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", @@ -8430,14 +8430,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", @@ -9887,14 +9887,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", @@ -10138,14 +10138,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", @@ -10729,14 +10729,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", @@ -11033,14 +11033,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", @@ -11320,14 +11320,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", @@ -11938,14 +11938,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", @@ -12796,14 +12796,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", @@ -13039,14 +13039,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", @@ -13506,14 +13506,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", @@ -18805,7 +18805,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 }, { @@ -18822,7 +18822,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 e2529c0997..165308ea08 100644 --- a/packages/ui-extensions/src/surfaces/admin/components.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components.d.ts @@ -1842,8 +1842,8 @@ export interface FileInputProps extends BaseInputProps { } 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; } @@ -1864,8 +1864,8 @@ export interface BasicFieldProps } 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;