Skip to content

Commit

Permalink
Added **Helper text** section to Fields and Lists articles (#303)
Browse files Browse the repository at this point in the history
  • Loading branch information
bbrennanbasis authored Nov 13, 2024
1 parent 47cde4e commit 474a26d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/components/fields/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Specifies the browser's behavior regarding automatic form filling and completion

A field label is a descriptive text or title that is associated with the field. It provides a brief explanation or prompt to help users understand the purpose or expected input for that particular field. Field labels are not only important for usability but also play a crucial role in accessibility, as they enable screen readers and assistive technologies to provide accurate information and facilitate keyboard navigation.

### Helper text

Each field can display helper text beneath the input using the `setHelperText()` method. This helper text offers additional context or explanations about the available inputs, ensuring users have the necessary information to make informed selections.

### Required

A field is required when the user must provide a value before submitting a form. This is mainly used in conjunction with `setLabel(String)` to provide a visual indication to users that the field is required.
Expand Down
3 changes: 3 additions & 0 deletions docs/components/lists/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ for (ListItem item : list) {

All List components can be assigned a label, which is a descriptive text or title associated with the component. Labels provide a brief explanation or prompt to help users understand the purpose or expected selection for that particular list. In addition to their importance for usability, list labels also play a crucial role in accessibility, enabling screen readers and assistive technologies to provide accurate information and facilitate keyboard navigation.

### Helper text

Each List component can display helper text beneath the list using the `setHelperText()` method. This helper text offers additional context or explanations about the available options, ensuring users have the necessary information to make informed selections.
<!-- ADD DEMO WITH ALL THREE AND A LABEL -->

## Topics
Expand Down

0 comments on commit 474a26d

Please sign in to comment.