From a2cf3fdd8ea913ba851fbe6df3b325fbedd54e5a Mon Sep 17 00:00:00 2001 From: SriHV <123635670+SriHV@users.noreply.github.com> Date: Fri, 10 Jan 2025 09:25:27 +0000 Subject: [PATCH] Change documentation for legend and legendIsQuestionTitle params (#3466) --- .../mutually-exclusive/_macro-options.md | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/src/components/mutually-exclusive/_macro-options.md b/src/components/mutually-exclusive/_macro-options.md index 88fb45962f..4b93ad7f7a 100644 --- a/src/components/mutually-exclusive/_macro-options.md +++ b/src/components/mutually-exclusive/_macro-options.md @@ -1,17 +1,17 @@ -| Name | Type | Required | Description | -| -------------------------------- | ------------------------------------ | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| id | string | false | The HTML `id` of the fieldset | -| classes | string | false | Classes to apply to the fieldset | -| legend | string | true (unless `legendIsQuestionTitle` is set) | Text for the fieldset’s legend | -| legendClasses | string | false | Classes to apply to the legend element | -| legendIsQuestionTitle | boolean | true (unless `legend` is set) | Creates an `h1` inside the `legend`. Use when there is only a single fieldset on the page | -| description | string | false | Description for the fieldset | -| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | -| exclusiveOptions | `Array` or `Array` | true | Configuration for the mutually exclusive options | -| or | string | false | Text for the “Or” label that separates the mutually exclusive checkbox from the answer options, defaults to "Or". | -| deselectMessage | string | true | The text the aria-live alert will announce to warn that selecting the exclusive checkbox will clear or unselect all other answer options. For example, ”Selecting this will uncheck all other checkboxes”. | -| deselectGroupAdjective | string | true | The text the aria-live alert will announce when an answer option is cleared or unselected when the mutually exclusive checkbox is selected | -| deselectExclusiveOptionAdjective | string | true | The text the aria-live alert will announce when an option is cleared or unselected when the mutually exclusive checkbox is selected | -| error | `Error` [_(ref)_](/components/error) | false | Configuration for validation errors | -| dontWrap | boolean | false | Prevents fields,checkboxes,date input,duration,input and Textarea from being wrapped in a [fieldset component](/components/fieldset) | -| autosuggestresults | string | false | Shows suggested options to users as they enter something into an input field | +| Name | Type | Required | Description | +| -------------------------------- | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | string | false | The HTML `id` of the fieldset | +| classes | string | false | Classes to apply to the fieldset | +| legend | string | true | Text for the fieldset’s legend | +| legendClasses | string | false | Classes to apply to the legend element | +| legendIsQuestionTitle | boolean | false | When set to true, the text provided within the `legend` is rendered as an `

` tag. Use when there is only a single fieldset on the page | +| description | string | false | Description for the fieldset | +| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | +| exclusiveOptions | `Array` or `Array` | true | Configuration for the mutually exclusive options | +| or | string | false | Text for the “Or” label that separates the mutually exclusive checkbox from the answer options, defaults to "Or". | +| deselectMessage | string | true | The text the aria-live alert will announce to warn that selecting the exclusive checkbox will clear or unselect all other answer options. For example, ”Selecting this will uncheck all other checkboxes”. | +| deselectGroupAdjective | string | true | The text the aria-live alert will announce when an answer option is cleared or unselected when the mutually exclusive checkbox is selected | +| deselectExclusiveOptionAdjective | string | true | The text the aria-live alert will announce when an option is cleared or unselected when the mutually exclusive checkbox is selected | +| error | `Error` [_(ref)_](/components/error) | false | Configuration for validation errors | +| dontWrap | boolean | false | Prevents fields,checkboxes,date input,duration,input and Textarea from being wrapped in a [fieldset component](/components/fieldset) | +| autosuggestresults | string | false | Shows suggested options to users as they enter something into an input field |