Skip to content

Commit

Permalink
changed documentation as per comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@SriHV
SriHV committed Jan 7, 2025
1 parent 76da23f commit b452968
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions src/components/fieldset/_macro-options.md
View file
Original file line number Diff line number Diff line change
@@ -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 `<span>` 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 `<h1>` 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 |
4 changes: 2 additions & 2 deletions src/components/mutually-exclusive/_macro-options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<span>` 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 `<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 |
Expand Down

0 comments on commit b452968

Please sign in to comment.