Skip to content

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

Merged
ToMESSKa merged 1 commit intomasterfrom
INSTUI-4944-add-required-explanation-property-to-form-field-group-component
May 7, 2026
Merged

docs(many): add required field examples and * required field note to …#2515
ToMESSKa merged 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
Preview removed because the pull request was closed.
2026-05-07 12:24 UTC

@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
Comment thread docs/guides/forms.md
@@ -1,11 +1,35 @@
---
title: Form Errors
title: Forms
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.

small thing but you've changed the title but didn't change the filename (and in turn the slug of the doc). would be more consistent that way, other than that everything is fine

@ToMESSKa ToMESSKa force-pushed the INSTUI-4944-add-required-explanation-property-to-form-field-group-component branch from beb3ff7 to a2b4eb3 Compare May 7, 2026 11:49
@ToMESSKa ToMESSKa force-pushed the INSTUI-4944-add-required-explanation-property-to-form-field-group-component branch from a2b4eb3 to 7b59b1c Compare May 7, 2026 12:09
github-actions Bot pushed a commit that referenced this pull request May 7, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

Visual regression report

No changes.

Status Count
Unchanged 32
Changed 0
New 0
Removed 0

📊 View full report

Baselines come from the visual-baselines branch. They refresh on every merge to master.

@ToMESSKa ToMESSKa merged commit 5e48e57 into master May 7, 2026
8 checks passed
@ToMESSKa ToMESSKa deleted the INSTUI-4944-add-required-explanation-property-to-form-field-group-component branch May 7, 2026 12:24
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