Skip to content

docs(many): add required field examples and * required field note to …#2515

Open
ToMESSKa wants to merge 1 commit intomasterfrom
INSTUI-4944-add-required-explanation-property-to-form-field-group-component
Open

docs(many): add required field examples and * required field note to …#2515
ToMESSKa wants to merge 1 commit intomasterfrom
INSTUI-4944-add-required-explanation-property-to-form-field-group-component

Conversation

@ToMESSKa
Copy link
Copy Markdown
Contributor

@ToMESSKa ToMESSKa commented Apr 14, 2026

…form component docs

INSTUI-4944

ISSUE:

  • documentation is missing explanation about the necessity of including a required field note in form fields

TEST PLAN:

  • check the explanation about the necessity of including a required field note in form fields
  • check if all the relevant form examples in the documentation have the required field note in TextInput, TextArea, RadioInputGroup, Checkbox, ColorPicker, FormFieldGroup, DateTimeInput, NumberInput and the Forms guide

@ToMESSKa ToMESSKa self-assigned this Apr 14, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 14, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://instructure.design/pr-preview/pr-2515/

Built to branch gh-pages at 2026-04-24 12:42 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@ToMESSKa ToMESSKa requested review from git-nandor and matyasf April 15, 2026 06:54
@matyasf matyasf requested review from balzss and removed request for matyasf April 20, 2026 08:52
Comment thread docs/guides/form-errors.md Outdated
# Adding Error Messages to Form Components
## Required Fields

InstUI form components display an asterisk (`*`) next to labels when the `isRequired` (or `required`) prop is set. Whenever a form contains required fields, you **must include a note** explaining what the asterisk means — typically `* required field`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is an example for users to follow, i'd word it a bit differently and more verbosely(?). maybe Fields marked with an asterisk <span aria-hidden="true">(*)</span> are required.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I fixed this.

@ToMESSKa ToMESSKa force-pushed the INSTUI-4944-add-required-explanation-property-to-form-field-group-component branch from 8ede623 to beb3ff7 Compare April 24, 2026 12:39
@ToMESSKa ToMESSKa requested a review from balzss April 24, 2026 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants