Skip to content
This repository was archived by the owner on Jul 7, 2025. It is now read-only.

Commit 0163f33

Browse files
docs: add a11y guidelines for required fields (#861)
* docs(PageHeader): add a11y guidelines for required fieldsd * docs(TextArea): add guidelines for required fields
1 parent e86ed5d commit 0163f33

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

content/components/form-control.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ To learn more about anatomy, input methods, forms structure, validation, and mor
2424

2525
## Accessibility
2626

27+
### Required Fields
28+
29+
When using symbols -e.g., an asterisk (*)- to indicate particular fields are required within a form, consider adding a "Required fields are marked with an asterisk (\*)" message at the top of the form for extra clarity.
30+
2731
### Known accessibility issues (GitHub staff only)
2832

2933
<AccessibilityLink label="FormControl"/>

content/components/textarea.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ Use a textarea to allow users to input a long string of free-form text.
3939

4040
For more information about the "valid" and "invalid" states, see the [validation section](../ui-patterns/forms/overview#validation) of the form design pattern guidelines.
4141

42-
### Best practices
43-
4442
## Anatomy
4543

4644
<img
@@ -52,6 +50,7 @@ For more information about the "valid" and "invalid" states, see the [validation
5250
**Label (required):** The input's title. It should be as concise as possible and convey the purpose of the input. The label may be visually hidden in rare cases, but a label must be defined for assistive technologies such as a screen reader.
5351

5452
**Required indicator:** Indicates that a value is required. Must be shown for any required field, even if all fields in the form are required.
53+
When using symbols -e.g., an asterisk (*)- to indicate particular fields are required within a form, consider adding a "Required fields are marked with an asterisk (\*)" message at the top of the form for extra clarity.
5554

5655
**Input (required):** Accepts user free-form text input
5756

0 commit comments

Comments
 (0)