Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change documentation for legend and legendIsQuestionTitle params #3466

Merged
merged 5 commits into from
Jan 10, 2025
Merged

Change documentation for legend and legendIsQuestionTitle params #3466

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
207c7cd
added documentation for fieldset component
SriHV Dec 30, 2024
76da23f
changed documentation for mutually exclusive
SriHV Jan 6, 2025
b452968
changed documentation as per comments
SriHV Jan 7, 2025
fac1dc4
changes as per comments
SriHV Jan 8, 2025
0999a9c
deleted documentation for fieldset as per comments
SriHV Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/components/mutually-exclusive/_macro-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
rmccar marked this conversation as resolved.
Show resolved Hide resolved
| 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<Checkbox>` or `Array<radio>` | 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 `<h1>` 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<Checkbox>` or `Array<radio>` | 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 |
Loading