From 207c7cd0daeb8cfde45350b29688b44262dd068d Mon Sep 17 00:00:00 2001 From: SriHV Date: Mon, 30 Dec 2024 12:32:34 +0000 Subject: [PATCH 1/5] added documentation for fieldset component --- src/components/fieldset/_macro-options.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 src/components/fieldset/_macro-options.md diff --git a/src/components/fieldset/_macro-options.md b/src/components/fieldset/_macro-options.md new file mode 100644 index 0000000000..479facd02f --- /dev/null +++ b/src/components/fieldset/_macro-options.md @@ -0,0 +1,12 @@ +| 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 | Creates an `h1` inside the `legend`. Use when there is only a single fieldset on the page. | +| legendTitleClasses | string | false | Classes to apply to the `h1` created using `legendIsQuestionTitle` | +| description | string | false | Description for the fieldset | +| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | +| error | Error | false | Configuration for validation errors | +| dontWrap | boolean | false | Prevents the fields from being wrapped in a fieldset | From 76da23f01d6bca59ba5d6bbc3df10891c5ba0795 Mon Sep 17 00:00:00 2001 From: SriHV Date: Mon, 6 Jan 2025 15:18:57 +0000 Subject: [PATCH 2/5] changed documentation for mutually exclusive --- .../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..6ed300d121 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 | 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 | From b452968e762f02edcc718181df53ec0bf3434739 Mon Sep 17 00:00:00 2001 From: SriHV Date: Tue, 7 Jan 2025 12:08:35 +0000 Subject: [PATCH 3/5] changed documentation as per comments --- src/components/fieldset/_macro-options.md | 24 +++++++++---------- .../mutually-exclusive/_macro-options.md | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/components/fieldset/_macro-options.md b/src/components/fieldset/_macro-options.md index 479facd02f..a4fc473d6c 100644 --- a/src/components/fieldset/_macro-options.md +++ b/src/components/fieldset/_macro-options.md @@ -1,12 +1,12 @@ -| 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 | Creates an `h1` inside the `legend`. Use when there is only a single fieldset on the page. | -| legendTitleClasses | string | false | Classes to apply to the `h1` created using `legendIsQuestionTitle` | -| description | string | false | Description for the fieldset | -| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | -| error | Error | false | Configuration for validation errors | -| dontWrap | boolean | false | Prevents the fields from being wrapped in a fieldset | +| 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 | Legend will render text within a `` tag | +| 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 | +| legendTitleClasses | string | false | Classes to apply to the `h1` created using `legendIsQuestionTitle` | +| description | string | false | Description for the fieldset | +| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | +| error | Error | false | Configuration for validation errors | +| dontWrap | boolean | false | Prevents the fields from being wrapped in a fieldset | diff --git a/src/components/mutually-exclusive/_macro-options.md b/src/components/mutually-exclusive/_macro-options.md index 6ed300d121..760216889d 100644 --- a/src/components/mutually-exclusive/_macro-options.md +++ b/src/components/mutually-exclusive/_macro-options.md @@ -2,9 +2,9 @@ | -------------------------------- | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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 | +| legend | string | true | Fieldset’s legend will render text within a `` tag | | legendClasses | string | false | Classes to apply to the legend element | -| legendIsQuestionTitle | boolean | false | Creates an `h1` inside the `legend`. Use when there is only a single fieldset on the page | +| 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 | From fac1dc4af598050314250fb26f3c20c88ade64a5 Mon Sep 17 00:00:00 2001 From: SriHV Date: Wed, 8 Jan 2025 11:26:46 +0000 Subject: [PATCH 4/5] changes as per comments --- src/components/fieldset/_macro-options.md | 2 +- src/components/mutually-exclusive/_macro-options.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/components/fieldset/_macro-options.md b/src/components/fieldset/_macro-options.md index a4fc473d6c..07be1ad8c3 100644 --- a/src/components/fieldset/_macro-options.md +++ b/src/components/fieldset/_macro-options.md @@ -2,7 +2,7 @@ | --------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | false | The HTML `id` of the fieldset | | classes | string | false | Classes to apply to the fieldset | -| legend | string | true | Legend will render text within a `` tag | +| 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 | | legendTitleClasses | string | false | Classes to apply to the `h1` created using `legendIsQuestionTitle` | diff --git a/src/components/mutually-exclusive/_macro-options.md b/src/components/mutually-exclusive/_macro-options.md index 760216889d..4b93ad7f7a 100644 --- a/src/components/mutually-exclusive/_macro-options.md +++ b/src/components/mutually-exclusive/_macro-options.md @@ -2,7 +2,7 @@ | -------------------------------- | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | false | The HTML `id` of the fieldset | | classes | string | false | Classes to apply to the fieldset | -| legend | string | true | Fieldset’s legend will render text within a `` tag | +| 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 | From 0999a9ccadf66406fe5c61778a9dc6827e7d88a4 Mon Sep 17 00:00:00 2001 From: SriHV Date: Thu, 9 Jan 2025 16:06:59 +0000 Subject: [PATCH 5/5] deleted documentation for fieldset as per comments --- src/components/fieldset/_macro-options.md | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 src/components/fieldset/_macro-options.md diff --git a/src/components/fieldset/_macro-options.md b/src/components/fieldset/_macro-options.md deleted file mode 100644 index 07be1ad8c3..0000000000 --- a/src/components/fieldset/_macro-options.md +++ /dev/null @@ -1,12 +0,0 @@ -| 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 | -| legendTitleClasses | string | false | Classes to apply to the `h1` created using `legendIsQuestionTitle` | -| description | string | false | Description for the fieldset | -| attributes | object | false | HTML attributes (for example, data attributes) to add to the fieldset | -| error | Error | false | Configuration for validation errors | -| dontWrap | boolean | false | Prevents the fields from being wrapped in a fieldset |