Fieldset
Fieldset is used for grouping sets of input components. It is necessary to use a fieldset with radio and checkbox components. It can also be useful for logically grouping other types of inputs.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
label | label | Label for the fieldset. Rendered as a `<legend>` element. | string | '' |
hint | hint | Optional hint text to be displayed with the input. Alternatively use the hint slot. | string | undefined | — |
error | error | Optional error to be shown with the fieldset. Alternatively use the error slot. | string | undefined | — |
required | required | Determines whether the fieldset is required or not. A fieldset marked as required will be announced as such to users of assistive technology. When using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors. | boolean | false |
hideRequired | hide-required | Visually hide the required indicator, but still show required attribute to assistive technologies like screen readers. | boolean | false |
hideLabel | hide-label | Visually hide the label, but still show it to assistive technologies like screen readers. | boolean | false |
size | size | The size of the label. | 's' | 'm' | 'm' |
Slots
| Slot name | Description |
|---|---|
label | Use when a label requires more than plain text. |
hint | Optional slot that holds hint text for the fieldset. |
error | Optional slot that holds error text for the fieldset. |
CSS Properties
CSS Custom Properties provide more fine grain control over component presentation. We advise utilizing existing properties on the component before using these.
| Property | Description | Default |
|---|---|---|
--n-label-color | Controls the text color of the label, using our color tokens. | var(--n-color-text) |
Usage
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do
- Use the fieldset component when you need to create a relationship between multiple form inputs.
- It is especially important to use with a group of radio components.
Don’t
- Don’t place interactive content (buttons, links etc) inside the label.
- Don’t use with a checkbox component when there is only one checkbox. For example, when accepting terms and conditions.
Content guidelines
Fieldset label should be clear, accurate and predictable. It should help the user to understand how the items in the fieldset are grouped together, or what kind of choice the user is making:
When writing fieldset labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):
Avoid ending in punctuation if it’s a single sentence, word, or a fragment:
Do not use colons in fieldset label:
Additional considerations
- A label (which becomes to
<legend>inside the fieldset) is always required. - Hint text can be used to offer further information or explanation for an option.
Integration
For integration guidelines, please see Web Components documentation .